Export Email Events

Deprecated. Use Export Contact Events with types set to the EMAIL_* types you need. It returns the same events, with the email detail and emailName in each event's email object. To move an existing walk over without re-reading it, send its last cursor as emailEventsCursor. This endpoint is still served.

Bulk, incremental export of raw email engagement events of a single type, keyed by occurredAt. The email asset name is resolved per row on a best-effort basis (emailName may be null if it cannot be resolved).

Results are paginated with an opaque cursor returned as pagination.nextCursor. Pass it back as cursor to fetch the next page; a null cursor means there are no more results. 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/email-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

eventType'EMAIL_SEND' | 'EMAIL_DELIVERY' | 'EMAIL_OPEN' | 'EMAIL_CLICK' | 'EMAIL_BOUNCE' | 'EMAIL_SOFT_BOUNCE' | 'EMAIL_COMPLAINT' | 'EMAIL_UNSUBSCRIBE_ALL' | 'EMAIL_TOPIC_UNSUBSCRIBE' 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.

cursorstring

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.

limitinteger

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.

Example request

{
  "eventType": "EMAIL_OPEN",
  "cursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA2LTAxVDEwOjAwOjAwWiJ9"
}

Response

A page of email events retrieved successfully.

Example response

{
  "data": {
    "events": [
      {
        "eventType": "EMAIL_OPEN"
      }
    ]
  }
}

Changes

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