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
contactIds
string<uuid>[]

Only these contacts' events. At most 100.

types
enum<string>[]

Only these event types.

Available options:
EMAIL_SEND,
EMAIL_DELIVERY,
EMAIL_OPEN,
EMAIL_CLICK,
EMAIL_BOUNCE,
EMAIL_SOFT_BOUNCE,
EMAIL_COMPLAINT,
EMAIL_UNSUBSCRIBE_ALL,
EMAIL_TOPIC_UNSUBSCRIBE,
PAGE_VISIT,
FORM_SUBMISSION,
CAMPAIGN_MEMBER_ADDED,
CAMPAIGN_MEMBER_REMOVED,
CAMPAIGN_MEMBER_STATUS_CHANGED,
CAMPAIGN_MEMBER_FIELD_CHANGED,
WORKFLOW_ENTERED,
WORKFLOW_EXITED,
WORKFLOW_ERROR,
AUDIENCE_ADDED,
AUDIENCE_REMOVED,
FIELD_CHANGE,
SFDC_LEAD_CONVERTED
parentTypes
enum<string>[]

Only these event families. With types, an event must match both.

Available options:
EMAIL,
PAGE_VISIT,
FORM_SUBMISSION,
CAMPAIGN_MEMBER,
WORKFLOW,
AUDIENCE,
FIELD_CHANGE,
SFDC_LEAD_CONVERTED
occurredAt
object

Only events that occurred in this half-open range.

cursor
string

The opaque cursor returned as pagination.nextCursor by a previous call. Omit it on the first page. Send it without filters, because the cursor carries them; sending both returns invalid_filter.

Example:

"eyJ2IjoxLCJmIjp7fSwiayI6ImFiYyJ9"

emailEventsCursor
string

Moves a walk over from the deprecated Export Email Events endpoint without re-reading it. Send that endpoint's last pagination.nextCursor on the first page, with exactly one EMAIL_* type in types (the type that walk exported) and no other filters. The export resumes where the email events walk stopped. Other filters, or a cursor, return invalid_filter.

limit
integer
default:1000

The maximum number of rows per page. Defaults to 1000. Values are clamped to [1, 5000].

Required range: 1 <= x <= 5000

Response

A page of contact events retrieved successfully.

data
object
pagination
object