API Reference

Export a report

The ReportExport endpoint schedules a job to export reports asynchronously. It returns an object describing the initial job status, a URI to poll for status updates, and a URI to download the job result file. You can check the status of a job using the Jobs endpoint.

🚧

Note

For the latest version (version 3), all columns will be visible in the CSV by default.

For versions older than version 3, you need to add the field you require data for, in the query string in order to have the desired columns visible in the CSV.

For example, to see the Action Batch Date, you must add SHOW_ACTION_BATCH_DATE=1 to the query string.

Parameters

SUBAID required for most reports

A program Id. Further refine the report to only retrieve data from a specific program.

StartDate required for most reports

From what date and time the report should retrieve data. See ISO 8601.

EndDate required for most reports

To what date and time the report should retrieve data. See ISO 8601.

ResultFormat optional

Which file format the report will be returned in.

View possible enum values
CSVReturns the report file in CSV format.
JSONReturns the report file in JSON format.
XMLReturns the report file in XML format.

Example Request

curl 'https://api.impact.com/Agencies/<AccountSID>/ReportExport/<ID> \
  -G \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \

Example Response

{ "Status": "QUEUED", 
 "QueuedUri": "/Agencies/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f", 
 "ResultUri": "/Agencies/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download" 
}