Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Your Conversion API key. Found in Settings > Integrations in the dashboard. Format: sk_live_<key_id>_<secret>.

Body

application/json
occurredAt
object

The half-open occurredAt range to export, from start up to but not including end. Required on the first call, and omitted on later calls because the cursor carries the range. Supplying both occurredAt and cursor returns an invalid_window error.

cursor
string

The opaque pagination cursor returned as pagination.nextCursor by a previous call. Omit (or pass an empty string) to fetch the first page. Send it on its own, with no occurredAt. An invalid or malformed cursor returns an invalid_cursor error.

Example:

"eyJ2IjoxLCJjIjoiMjAyNi0wOC0wMVQwMDowMDowMFoifQ=="

limit
integer
default:1000

The maximum number of events to return per page. Defaults to 1000. Values are clamped to the range [1, 1000] rather than rejected; values above 1000 return 1000 results.

Required range: 1 <= x <= 1000

Response

A page of custom events retrieved successfully.

data
object
pagination
object