API Reference

Return a job

Returns an object describing the status of the queried job.

A queued job can have a COMPLETED, ERROR, FAILED, or CANCELLED status.

  • A COMPLETED status indicates that the queued job was completed and is ready for download.
  • An ERROR status indicates an error occurred during the job execution. The job will automatically re-run every 15 minutes for a maximum of 5 tries or until it succeeds (whichever comes first).
  • A FAILED status indicates that the job couldn’t be completed after 5 tries.
  • Only an impact.com system administrator can put a job into a CANCELLED state.

⚠️

Note

Jobs shouldn’t have the FAILED and CANCELLED states. If your job results in either of these 2 statuses, reach out to your CSM (or contact support) to find out why.

Parameters

No parameters.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Jobs/<JobId>' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example response

{
  "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": "/Mediapartners/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download"
}