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
eventType
enum<string>
required

The email event type to export. Each call exports a single event type, matched 1:1 against the underlying email event type. Case-insensitive; an unsupported value returns an invalid_field error.

Available options:
EMAIL_SEND,
EMAIL_DELIVERY,
EMAIL_OPEN,
EMAIL_CLICK,
EMAIL_BOUNCE,
EMAIL_SOFT_BOUNCE,
EMAIL_COMPLAINT,
EMAIL_UNSUBSCRIBE_ALL,
EMAIL_TOPIC_UNSUBSCRIBE
Example:

"EMAIL_OPEN"

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. An invalid or malformed cursor returns an invalid_cursor error.

Example:

"eyJjcmVhdGVkQXQiOiIyMDI2LTA2LTAxVDEwOjAwOjAwWiJ9"

limit
integer
default:1000

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

Required range: 1 <= x <= 5000

Response

A page of email events retrieved successfully.

data
object
pagination
object