The job object holds information about a job action. You can retrieve a job result file, as well as list all jobs, replay completed jobs and monitor job statuses.
Attributes
Id string
Id stringThe unique job identifier.
Type string
Type stringThe type of job.
| Enum Values | Description |
|---|---|
DownloadReport | Report download job. |
ApiReport | API report job. |
UploadAds | Upload ads job. |
TermModification | Contract terms modification Job. |
ClickExport | Click export job. |
ProgramId string
ProgramId stringThe impact.com Program ID this job was scheduled for. Also known as CampaignId.
CreatedBy string
CreatedBy stringThe Account SID of the account that scheduled this job.
CreatedDate string
CreatedDate stringThe date and time the job was initially scheduled.
StartedDate string
StartedDate stringThe date and time the job last started running.
CompletedDate string
CompletedDate stringThe date and time the job was last successfully completed.
AbandonedDate string
AbandonedDate stringWhen the date and time of starting the job were last abandoned. This value is set when an attempt is made to start a job that is already running.
CancelledDate string
CancelledDate stringThe date and time the job was last canceled.
FailedDate string
FailedDate stringThe date and time processing of this job last raised an error.
LastProgressUpdateDate string
LastProgressUpdateDate stringThe date and time progress on job processing was updated. This value is updated every time an update is made to the 'RecordsProcessed' or 'PercentageComplete' fields.
Status enum
Status enumThe status of job processing.
| Possible enum values | Description |
|---|---|
| QUEUED | A job that has been queued. |
| RUNNING | When a job is being run. |
| COMPLETED | A job that is completed. |
| CANCELLED | A job that is cancelled. |
| ERROR | A job that raises an error. 'ERROR' state jobs will be retried automatically every 15 minutes. |
| FAILED | After 5 unsuccessful tries, the job will be put into a 'FAILED' state and no subsequent processing attempts will be made. |
StatusMessage string
StatusMessage stringA message describing the current job status.
RecordsProcessed integer
RecordsProcessed integerThe number of records processed up to the last progress update. This value is updated differently for each job type.
PercentageComplete integer
PercentageComplete integerThe percentage of work completed for this job up to the last progress update. This value is updated differently for each job type.
Replayable boolean
Replayable booleanAn indication if this job type can be replayed.
ResultUri string
ResultUri stringA URI pointing to a result file generated by a successfully completed job.
{
"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/<JobID>/Download"
}