Report Export

Export a Report Asynchronously

get

Schedules a job to export a report. The response contains URIs to poll for job status and to download the result file.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

ReportId_or_HandlestringRequired

The unique ID or handle for the report (e.g., '4222' or 'adv_click_data_pm_only').

Query parameters

SUBAIDintegerOptional

Program ID to refine the report. Required for most reports.

StartDatestring · date-timeOptional

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

EndDatestring · date-timeOptional

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

CONV_CURRENCYstringOptional

Specify the report's currency (e.g., USD).

ResultFormatstring · enumOptional

The file format for the exported report.

Default: CSVPossible values:

Responses

200

The job has been queued successfully.

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_or_Handle}

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/ReportExport/{ReportId_or_Handle}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

The job has been queued successfully.

{
  "Status": "QUEUED",
  "QueuedUri": "../folder",
  "ResultUri": "../folder"
}