ReportExport

Asynchronously export reports through impact.com's Jobs system. Recommended for all report downloads.

Export a report

get

Schedules a report to be exported asynchronously through impact.com's Jobs system. Returns immediately with the initial job status and three URIs to interact with the job.

Use the returned QueuedUri to poll job status, ResultUri to download the result file once the job has completed, and ReplayUri to re-run the same job.

Available query parameters

• ResultFormat — output file format (universal).
• Report-specific filters — every report accepts its own set of filter parameters (START_DATE, END_DATE, SUBAID, Advertiser, etc.). Call GET /Reports/{ReportId}/MetaData first to discover which filters a given report supports.

Error handling

Invalid input is returned as HTTP 200 with an error envelope in the body — for example, an unknown ReportId returns {"Status":"ERROR","Message":"Not permitted to run report ..."}. Always check the Status field before treating the response as a queued job.

Path parameters

AccountSIDstringRequired

Your Agency Account SID.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

ReportIdstringRequired

The unique ID of the report to export. Use GET /Reports to list all reports and find each report's Id.

Example: agency_action_listing

Query parameters

ResultFormatstring · enumOptional

The file format the exported report should be returned in.

Default: CSVExample: CSVPossible values:

START_DATEstring · dateOptional

The start date (inclusive) for the report data, in YYYY-MM-DD format. Required by most reports — check the report's MetaData to confirm.

Example: 2026-05-01

END_DATEstring · dateOptional

The end date (inclusive) for the report data, in YYYY-MM-DD format. Required by most reports — check the report's MetaData to confirm.

Example: 2026-05-29

SUBAIDstringOptional

A program (campaign) ID to refine the report to data from a single program. Required for some reports.

Example: 12345

Responses

200

Success — the export job was queued. Response includes URIs for polling and downloading the result.

Error — invalid input (e.g., bad ReportId, unrecognised ResultFormat, invalid date) returns the same HTTP 200 status with an error envelope. See the ErrorResponse schema and the operation description.

application/json

Job-handle response returned from the ReportExport endpoint. The export runs asynchronously through impact.com's Jobs system; use the URIs in this response to track and retrieve the result.

On invalid input the API returns the same HTTP 200 with an ErrorResponse envelope instead — check the Status field.

Statusstring · enumOptional

The initial status of the export job. Returns QUEUED on successful submission, or ERROR if the request was invalid (in which case a Message field will be populated instead of the URIs).

Example: QUEUEDPossible values:

QueuedUristring · uri-referenceOptional

The relative URI of the underlying job. Use it (or its trailing job ID) with the Jobs API to poll for status updates.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/8ef45463-8b0b-499f-8cdc-8d6e4c2a8c12

ResultUristring · uri-referenceOptional

The relative URI to download the exported result file. Available once the job completes — calling it before completion returns the job status, not the file.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/8ef45463-8b0b-499f-8cdc-8d6e4c2a8c12/Download

ReplayUristring · uri-referenceOptional

The relative URI to re-run the same export with the same parameters. Useful for retrying failed jobs without re-specifying inputs.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/8ef45463-8b0b-499f-8cdc-8d6e4c2a8c12/Replay

MessagestringOptional

A human-readable error description. Only present when Status is ERROR.

Example: Not permitted to run report nonexistent_report

401

Unauthorized. Check that your Account SID and Auth Token are correct.

get/Agencies/{AccountSID}/ReportExport/{ReportId}

curl

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

{
  "Status": "QUEUED",
  "QueuedUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/8ef45463-8b0b-499f-8cdc-8d6e4c2a8c12",
  "ResultUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/8ef45463-8b0b-499f-8cdc-8d6e4c2a8c12/Download",
  "ReplayUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/8ef45463-8b0b-499f-8cdc-8d6e4c2a8c12/Replay"
}