Request a campaign data export
Queues an asynchronous export of the campaign’s call history or survey responses as CSV or XLSX and returns immediately with a job handle — nothing is generated during the request. Poll the job with the export-status call.
When the job completes, fetch the file through the export-download call, which mints a pre-signed link; the same link is also emailed to the requester. Optional filters narrow the export by contact, agent or date range — omit them to export everything for the campaign.
The call is not idempotent: every request enqueues a new job, so a retry after a timeout creates a second export and a second link. There is no deduplication window or idempotency key.
filters.contactId and filters.userId must be positive ids, and dateFrom / dateTo must be strict ISO 8601 — anything else is a 400 and no job is enqueued. Supplying only one bound is valid: a missing dateTo resolves to the time the job runs, a missing dateFrom to the campaign’s creation. Each bound you do supply must itself be parseable as a date-time — strict ISO 8601 admits forms such as the week date 2026-W33 that cannot be read, and such a bound returns 422 (dateFrom must be a parseable ISO 8601 date-time, or the dateTo equivalent) whether or not the other bound is present. Supplying both with a dateTo that is not after dateFrom returns 422 (dateTo must be after dateFrom), and again nothing is enqueued.
Authorizations
HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).
Path Parameters
Dialer campaign ID.
^[1-9][0-9]*$Body
Body of the export enqueue call.
What to export. call_history exports the campaign's dial log; survey_responses exports answers collected by the campaign's survey.
call_history, survey_responses "call_history"
Serialisation format of the generated file.
csv, xlsx "csv"
Optional narrowing filters. Omitting the whole object exports everything for the campaign. Supplying only one of dateFrom / dateTo is valid — a missing end resolves to the time the job runs, a missing start to the campaign's creation.
Response
The export job was accepted and queued.