---
title: "Start export"
method: POST
path: "/api/export/start"
tags: ["export"]
---

# Start export

`POST /api/export/start`

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.

## Request body

- StartExportRequest
  - `campaignId` integer — 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.
  - `delimiter` string — CSV file delimiter
  - `endDateTime` string — Export events occurring or users updated before date and time exclusive (yyyy-MM-dd HH:mm:ss [ZZ])
  - `omitFields` string — Fields to omit from the export (comma separated)
  - `onlyFields` string — Only include these fields in the export (comma separated)
  - `outputFormat` 'text/csv' | 'application/x-json-stream', required — Output format
  - `startDateTime` string — Export events occurring or users updated after date and time inclusive (yyyy-MM-dd HH:mm:ss [ZZ])

## Response `200`

successful operation

- StartExportResponse
  - `jobId` integer, required — The ID of the export job

---

[API](https://skmtc.net/iterable/apis/iterable-api.md) · [All operations](https://skmtc.net/iterable/apis/iterable-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/iterable/iterable-api/revisions/afaab604b58c/schema)
