Sign in
latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

export

Start export

Start a data export. The export processes as a background job. Use the "Get export files" endpoint to check export status by <code>jobId</code> and obtain file download links.<br/><br/><b>Rate limit</b>: 1 request/second, per organization. <br/><b>Concurrent request limit</b>: Up to 4 exports process at a time, per organization. Additional requests are queued.

post/api/export/start

Request body

campaignIdinteger

Only export data from this campaign

dataTypeName'emailSend' | 'emailOpen' | 'emailClick' | 'hostedUnsubscribeClick' | 'emailComplaint' | 'emailBounce' | 'emailSendSkip' | 'pushSend' | 'pushOpen' | 'pushUninstall' | 'pushBounce' | 'pushSendSkip' | 'inAppSend' | 'inAppOpen' | 'inAppClick' | 'inAppClose' | 'inAppDelete' | 'inAppDelivery' | 'inAppSendSkip' | 'inAppRecall' | 'inboxSession' | 'inboxMessageImpression' | 'smsSend' | 'smsBounce' | 'smsClick' | 'smsReceived' | 'smsSendSkip' | 'webPushSend' | 'webPushClick' | 'webPushSendSkip' | 'emailSubscribe' | 'emailUnSubscribe' | 'purchase' | 'customEvent' | 'user' | 'smsUsageInfo' | 'embeddedSend' | 'embeddedSendSkip' | 'embeddedClick' | 'embeddedReceived' | 'embeddedImpression' | 'embeddedSession' | 'unknownSession' | 'journeyExit' | 'whatsAppBounce' | 'whatsAppClick' | 'whatsAppReceived' | 'whatsAppSeen' | 'whatsAppSend' | 'whatsAppSendSkip' | 'whatsAppUsageInfo' required

Data type name.

delimiterstring

CSV file delimiter

endDateTimestring

Export events occurring or users updated before date and time exclusive (yyyy-MM-dd HH:mm:ss [ZZ])

omitFieldsstring

Fields to omit from the export (comma separated)

onlyFieldsstring

Only include these fields in the export (comma separated)

outputFormat'text/csv' | 'application/x-json-stream' required

Output format

startDateTimestring

Export events occurring or users updated after date and time inclusive (yyyy-MM-dd HH:mm:ss [ZZ])

Example request

{
  "delimiter": ","
}

Response

successful operation

jobIdinteger required

The ID of the export job

Example response

{
  "jobId": 3562
}