Report Export

Schedule an asynchronous report export and poll for results via the Partner Jobs API.

Export a report (asynchronous)

get

Schedules a background job to export a report. Returns immediately with a QueuedUri pointing to the Partner Jobs API — poll that endpoint to track progress, then download the result from ResultUri once the job is complete.

Use this endpoint instead of Run Report for any dataset that may exceed 20,000 rows.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

The report handle (e.g., mp_action_listing_fast). Get this from the Id field returned by List Reports.

Query parameters
SUBAIDstringOptional

Program ID to scope the report to a single brand. Omit to include all programs you partner with.

Example: 10306
START_DATEstring · dateRequired

Start date for the report's date range, in YYYY-MM-DD format.

Example: 2026-01-01
END_DATEstring · dateRequired

End date for the report's date range, in YYYY-MM-DD format.

Example: 2026-01-31
ResultFormatstring · enumOptional

Format for the exported result file.

Default: CSVPossible values:
Responses
200

Job successfully queued.

application/json
StatusstringOptional

The initial status of the queued export job.

Example: QUEUED
QueuedUristringOptional

API resource path for polling the job's status via the Partner Jobs API.

Example: /Mediapartners/<AccountSID>/Jobs/18edc7d5-034d-4d95-b88f-cd351635ebd9
ResultUristringOptional

API resource path to download the result file once the job has completed.

Example: /Mediapartners/<AccountSID>/Jobs/18edc7d5-034d-4d95-b88f-cd351635ebd9/Download
ReplayUristringOptional

API resource path to replay the export job once it has completed, failed, or been cancelled.

Example: /Mediapartners/<AccountSID>/Jobs/18edc7d5-034d-4d95-b88f-cd351635ebd9/Replay
get
/Mediapartners/{AccountSID}/ReportExport/{Id}
curl

Last updated