COconversion

Export Contact Events

Bulk, incremental export of contact events: email, page visit, form submission, campaign member, workflow, audience, field change, and Salesforce lead conversion events. Custom events export from POST /v2/exports/custom-events.

Send filters on the first call, then pass pagination.nextCursor back as cursor until it is null. Persist the last non-null cursor between syncs to resume.

Request access. This endpoint is not enabled by default, contact the Conversion team to request access. Calls from accounts without it return 403 export_not_enabled.

post/v2/exports/contact-events

Request

  • Base URL
    https://pub-api.conversion.ai/api
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key

Request body

contactIdsstring[]

Only these contacts' events. At most 100.

typesstring[]

Only these event types.

parentTypesstring[]

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

cursorstring

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.

emailEventsCursorstring

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.

limitinteger

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

Example request

{
  "cursor": "eyJ2IjoxLCJmIjp7fSwiayI6ImFiYyJ9"
}

Response

A page of contact events retrieved successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.