Skip to main content
POST
Export Customer Value Conversions
Exports one customer’s conversions and events as a file. Accepts the same body as Get Customer Value Conversion Report plus format (csv or json). Unlike the standard conversion export, this endpoint does not accept a columns field — every column is included. The response is a file download, with Content-Type and Content-Disposition set from the requested format.

Authorizations

X-Eflow-Api-Key
string
header
required

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

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.

format
enum<string>
required

The file format for the export.

Available options:
csv,
json
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

A file download, with Content-Type and Content-Disposition set from the requested format.

The response is of type string.