Skip to main content
POST
Get Customer Value Conversion Report
Returns the conversions and events attributed to one customer. This is the Customer Value view of the conversion report — Customer Value was previously called User Management, which is where the usm in the path comes from. The body is the same as Get Conversion Report, with one addition: user_id identifies the customer and is required. An empty value returns 400 Invalid user id. As with the standard conversion report, at least one of show_conversions and show_events must be true, or the request is rejected. A customer with no conversions in the window returns 200 with an empty conversions array — an unknown user_id is not an error. This endpoint needs an API key with Reporting → Conversion access.

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Query Parameters

page
integer
default:1

The page of results to retrieve.

Required range: x >= 1
page_size
integer
default:50

The number of results to return per page.

Required range: x >= 1

Body

application/json
user_id
string
required

The customer identifier to report on. Required — an empty value is rejected with Invalid user id.

Example:

"cust_12345"

from
string
required

Start date (format: YYYY-MM-DD or YYYY-MM-DD HH:mm:SS).

to
string
required

End date (format: YYYY-MM-DD or YYYY-MM-DD HH:mm:SS).

timezone_id
integer
required

Timezone identifier for the date range. See /meta/timezones.

currency_id
string
required

Currency code for monetary values. Currently only USD is supported.

show_conversions
boolean

Include base conversion records. At least one of show_conversions and show_events must be true.

show_events
boolean

Include post-conversion event records.

show_only_scrub
boolean

Only include scrubbed (rejected) conversions and events.

show_only_vt
boolean

Only include view-through conversions.

show_only_ct
boolean

Only include click-through conversions.

show_only_fail_traffic
boolean

Only include fail traffic conversions.

query
object

Filters and search terms, identical to the query object on Get Conversion Report.

Response

Conversion records for the customer. Each entry has the same shape as an entry in the Get Conversion Report response.

conversions
object[]