API Reference

Download a job result

Download the job result file if the job was completed successfully. If the job isn’t done, the job status will be returned. If redirects are not supported, set the optional Mode parameter to Stream.

How long will the result be available to download?

A job result is available for download 90 days after the job was run.

Is there a limit to the number of times a download result can be polled?

There is no limit to the number of times you can poll for the download result.

Parameters

Modeoptional

The download mode. If this value is set to Stream, the job result file will be streamed directly in the response instead of redirecting the client to a signed URL first.

Example request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Jobs/<JobId>/Download' \
  -X GET \
  -L 
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/octet-stream'

Example response

There are three responses it can return:

Response codeResult
🟢 200Returns a result file.
🟢 202Returns an object describing the status of the queried job.
🟠 302Redirects the REST client to a temporary signed URL for result file download.
{
  "Id": "d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f",
  "Type": "ClickExport",
  "ProgramId": "3629",
  "CreatedBy": "<AccountSID>",
  "CreatedDate": "2022-06-07T04:33:50-05:00",
  "StartedDate": "2022-06-07T04:33:50-05:00",
  "AbandonedDate": "2022-06-07T04:33:50-05:00",
  "CompletedDate": "2022-06-07T04:33:50-05:00",
  "CancelledDate": "2022-06-07T04:33:50-05:00",
  "FailedDate": "2022-06-07T04:33:50-05:00",
  "LastProgressUpdateDate": "2022-06-07T04:33:50-05:00",
  "Status": "COMPLETED",
  "StatusMessage": "Job processing completed successfully.",
  "RecordsProcessed": "250",
  "PercentageComplete": "100",
  "Replayable": "true",
  "ResultUri": "/Advertisers/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download"
}