Sign in
latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

export

Export data to JSON

Export campaign analytics data in JSON format, one entry per line. Use of either 'range' or 'startDateTime' and 'endDateTime' is required.<br/><b>Rate limit</b>: 4 requests/minute, per project.

get/api/export/data.json

Query parameters

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.

range'Today' | 'Yesterday' | 'BeforeToday' | 'All'

date range, uses UTC time

startDateTimestring

Export starting from (>=) (yyyy-MM-dd HH:mm:ss [ZZ])

endDateTimestring

Export ending at (<) (yyyy-MM-dd HH:mm:ss [ZZ])

omitFieldsstring

Fields to omit (comma separated)

onlyFieldsstring[]

Only export these fields (comma separated)

campaignIdinteger

Only export data from this campaign

Response

successful operation