For the complete documentation index, see llms.txt. This page is also available as Markdown.

Report Export

Export a report asynchronously

get

Schedules an asynchronous job to export report data. Returns a job ID which can be polled via the Jobs endpoint. To include specific columns, append them to the query string (e.g., SHOW_ACTION_BATCH_DATE=1).

Authorizations
AuthorizationstringRequired
Path parameters
AccountSIDstringRequired

The unique identifier for the account.

ReportIdstringRequired

The unique ID or handle of the report to export.

Query parameters
SUBAIDintegerRequired

The Program ID to filter report data.

StartDatestring · date-timeRequired

Start date for the report as an ISO 8601 date-time (YYYY-MM-DDThh:mm:ssZ), e.g. 2026-01-15T00:00:00Z.

EndDatestring · date-timeRequired

End date for the report as an ISO 8601 date-time (YYYY-MM-DDThh:mm:ssZ), e.g. 2026-01-15T00:00:00Z.

ResultFormatstring · enumOptional

The file format for the exported report.

Default: CSVPossible values:
Responses
200

The report export job has been successfully queued.

application/json
StatusstringOptional

Indicates whether the job was queued successfully.

Example: QUEUED
QueuedUristring · uri-referenceOptional

The URI to poll for the job's status.

ResultUristring · uri-referenceOptional

The URI to download the result file once the job completes.

get/Advertisers/{AccountSID}/ReportExport/{ReportId}
cURL
200

The report export job has been successfully queued.

Last updated