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
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
SUBAID
required for most reportsA program Id. Further refine the report to only retrieve data from a specific program.
StartDate
required for most reports
StartDate
required for most reportsFrom what date and time the report should retrieve data. See ISO 8601.
EndDate
required for most reports
EndDate
required for most reportsTo what date and time the report should retrieve data. See ISO 8601.
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"
}