Jobs

Schedule, monitor, replay, and download large-scale asynchronous jobs.

List all jobs

get

Returns the jobs scheduled by this agency account. Use the optional date filters to narrow results to a specific window.

Path parameters

AccountSIDstringRequired

Your Agency Account SID.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

Query parameters

CreatedAfterstring · dateOptional

Return only jobs created on or after this date, in YYYY-MM-DD format.

Example: 2026-05-01

CreatedBeforestring · dateOptional

Return only jobs created on or before this date, in YYYY-MM-DD format.

Example: 2026-05-29

Responses

200

A list of job objects.

application/json

A scheduled job — created automatically by other endpoints (such as ReportExport) and tracked through its lifecycle.

Idstring · uuidOptional

The unique job identifier (UUID).

Example: 81258bc5-54cf-4a09-9fbc-eb837637d02f

Typestring · enumOptional

The kind of work the job performs. Created automatically by the endpoint that schedules the job.

Value	Description
`DownloadReport`	Download an existing pre-generated report file.
`ApiReport`	Asynchronous report export created via `GET /ReportExport/{ReportId}`.
`UploadAds`	Bulk ad upload job.
`TermModification`	Bulk modification of contract terms.

Additional job types may exist beyond the values listed above.

Example: ApiReportPossible values:

ProgramIdstringOptional

The program (also known as CampaignId) the job is scoped to, if applicable.

Example: 3629

CreatedBystringOptional

The Account SID of the user or account that created this job.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

CreatedDatestring · date-timeOptional

The date and time the job was created, in ISO 8601 format with UTC offset.

Example: 2026-05-29T04:33:50-05:00

StartedDatestring · date-timeOptional

The date and time the job began processing. Empty until the job transitions out of QUEUED.

Example: 2026-05-29T04:33:55-05:00

CompletedDatestring · date-timeOptional

The date and time the job finished successfully. Only populated when Status is COMPLETED.

Example: 2026-05-29T04:35:12-05:00

AbandonedDatestring · date-timeOptional

The date and time the job was abandoned (timed out before completing).

CancelledDatestring · date-timeOptional

The date and time the job was cancelled. Only populated when Status is CANCELLED.

FailedDatestring · date-timeOptional

The date and time the job entered a failed state. Only populated when Status is FAILED or ERROR.

LastProgressUpdateDatestring · date-timeOptional

The date and time PercentageComplete was last updated.

Example: 2026-05-29T04:34:30-05:00

Statusstring · enumOptional

The current lifecycle status of the job.

Value	Description
`QUEUED`	The job is scheduled and awaiting processing.
`RUNNING`	The job is actively processing.
`COMPLETED`	The job finished successfully — a result file is available via the `Download` endpoint.
`CANCELLED`	The job was cancelled before completion.
`ERROR`	The job stopped due to an unrecoverable system error.
`FAILED`	The job ran but did not produce a usable result.

Example: COMPLETEDPossible values:

StatusMessagestringOptional

A human-readable description of the current status — useful for diagnosing failures.

Example: Job processing completed successfully.

RecordsProcessedintegerOptional

The total number of records the job has processed so far.

Example: 250

PercentageCompleteinteger · max: 100Optional

Progress through the job, from 0 to 100.

Example: 100

ReplayablebooleanOptional

Whether this job can be replayed (re-run with the same parameters) using PUT /Jobs/{JobId}/Replay. Typically true for jobs in a terminal state.

Example: true

ResultUristring · uri-referenceOptional

The relative URI to download the job's result file. Available once Status is COMPLETED.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/81258bc5-54cf-4a09-9fbc-eb837637d02f/Download

401

Unauthorized. Check that your Account SID and Auth Token are correct.

get/Agencies/{AccountSID}/Jobs

curl

curl -L \
  --url 'https://api.impact.com/Agencies/{AccountSID}/Jobs' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

[
  {
    "Id": "81258bc5-54cf-4a09-9fbc-eb837637d02f",
    "Type": "ApiReport",
    "ProgramId": "3629",
    "CreatedBy": "IRq8mWJybvoQ1020978kbj7am8zzM2dBL1",
    "CreatedDate": "2026-05-29T04:33:50-05:00",
    "StartedDate": "2026-05-29T04:33:55-05:00",
    "CompletedDate": "2026-05-29T04:35:12-05:00",
    "AbandonedDate": "",
    "CancelledDate": "",
    "FailedDate": "",
    "LastProgressUpdateDate": "2026-05-29T04:34:30-05:00",
    "Status": "COMPLETED",
    "StatusMessage": "Job processing completed successfully.",
    "RecordsProcessed": 250,
    "PercentageComplete": 100,
    "Replayable": true,
    "ResultUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/81258bc5-54cf-4a09-9fbc-eb837637d02f/Download"
  }
]

Get a job

get

Retrieves the current status and details of a specific job. Use this to poll a job created from another endpoint (such as GET /ReportExport/{ReportId}) until it reaches a terminal Status (COMPLETED, CANCELLED, ERROR, or FAILED).

Path parameters

AccountSIDstringRequired

Your Agency Account SID.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

JobIdstring · uuidRequired

The unique job identifier (UUID). Returned in the QueuedUri of any endpoint that schedules a job (for example GET /ReportExport/{ReportId}).

Example: 81258bc5-54cf-4a09-9fbc-eb837637d02f

Responses

200

The job's current status and details.

application/json

A scheduled job — created automatically by other endpoints (such as ReportExport) and tracked through its lifecycle.

Idstring · uuidOptional

The unique job identifier (UUID).

Example: 81258bc5-54cf-4a09-9fbc-eb837637d02f

Typestring · enumOptional

The kind of work the job performs. Created automatically by the endpoint that schedules the job.

Value	Description
`DownloadReport`	Download an existing pre-generated report file.
`ApiReport`	Asynchronous report export created via `GET /ReportExport/{ReportId}`.
`UploadAds`	Bulk ad upload job.
`TermModification`	Bulk modification of contract terms.

Additional job types may exist beyond the values listed above.

Example: ApiReportPossible values:

ProgramIdstringOptional

The program (also known as CampaignId) the job is scoped to, if applicable.

Example: 3629

CreatedBystringOptional

The Account SID of the user or account that created this job.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

CreatedDatestring · date-timeOptional

The date and time the job was created, in ISO 8601 format with UTC offset.

Example: 2026-05-29T04:33:50-05:00

StartedDatestring · date-timeOptional

The date and time the job began processing. Empty until the job transitions out of QUEUED.

Example: 2026-05-29T04:33:55-05:00

CompletedDatestring · date-timeOptional

The date and time the job finished successfully. Only populated when Status is COMPLETED.

Example: 2026-05-29T04:35:12-05:00

AbandonedDatestring · date-timeOptional

The date and time the job was abandoned (timed out before completing).

CancelledDatestring · date-timeOptional

The date and time the job was cancelled. Only populated when Status is CANCELLED.

FailedDatestring · date-timeOptional

The date and time the job entered a failed state. Only populated when Status is FAILED or ERROR.

LastProgressUpdateDatestring · date-timeOptional

The date and time PercentageComplete was last updated.

Example: 2026-05-29T04:34:30-05:00

Statusstring · enumOptional

The current lifecycle status of the job.

Value	Description
`QUEUED`	The job is scheduled and awaiting processing.
`RUNNING`	The job is actively processing.
`COMPLETED`	The job finished successfully — a result file is available via the `Download` endpoint.
`CANCELLED`	The job was cancelled before completion.
`ERROR`	The job stopped due to an unrecoverable system error.
`FAILED`	The job ran but did not produce a usable result.

Example: COMPLETEDPossible values:

StatusMessagestringOptional

A human-readable description of the current status — useful for diagnosing failures.

Example: Job processing completed successfully.

RecordsProcessedintegerOptional

The total number of records the job has processed so far.

Example: 250

PercentageCompleteinteger · max: 100Optional

Progress through the job, from 0 to 100.

Example: 100

ReplayablebooleanOptional

Whether this job can be replayed (re-run with the same parameters) using PUT /Jobs/{JobId}/Replay. Typically true for jobs in a terminal state.

Example: true

ResultUristring · uri-referenceOptional

The relative URI to download the job's result file. Available once Status is COMPLETED.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/81258bc5-54cf-4a09-9fbc-eb837637d02f/Download

401

Unauthorized. Check that your Account SID and Auth Token are correct.

404

Job not found. Verify the JobId belongs to a job created by this agency.

get/Agencies/{AccountSID}/Jobs/{JobId}

curl

curl -L \
  --url 'https://api.impact.com/Agencies/{AccountSID}/Jobs/{JobId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "Id": "81258bc5-54cf-4a09-9fbc-eb837637d02f",
  "Type": "ApiReport",
  "ProgramId": "3629",
  "CreatedBy": "IRq8mWJybvoQ1020978kbj7am8zzM2dBL1",
  "CreatedDate": "2026-05-29T04:33:50-05:00",
  "StartedDate": "2026-05-29T04:33:55-05:00",
  "CompletedDate": "2026-05-29T04:35:12-05:00",
  "AbandonedDate": "",
  "CancelledDate": "",
  "FailedDate": "",
  "LastProgressUpdateDate": "2026-05-29T04:34:30-05:00",
  "Status": "COMPLETED",
  "StatusMessage": "Job processing completed successfully.",
  "RecordsProcessed": 250,
  "PercentageComplete": 100,
  "Replayable": true,
  "ResultUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/81258bc5-54cf-4a09-9fbc-eb837637d02f/Download"
}

Download a job result

get

Downloads the result file produced by a completed job.

Response behaviour by job state

Job complete — returns the result file. By default, the response is a 302 redirect to a short-lived signed URL on cloud storage; pass Mode=Stream to receive the file bytes directly with HTTP 200.
Job still running — returns HTTP 202 with the current Job object instead of a file. Poll with GET /Jobs/{JobId} until the job reaches COMPLETED.

Path parameters

AccountSIDstringRequired

Your Agency Account SID.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

JobIdstring · uuidRequired

The unique job identifier (UUID). Returned in the QueuedUri of any endpoint that schedules a job (for example GET /ReportExport/{ReportId}).

Example: 81258bc5-54cf-4a09-9fbc-eb837637d02f

Query parameters

Modestring · enumOptional

Set to Stream to receive the result file bytes directly in the response body (HTTP 200) instead of following a 302 redirect to a signed download URL.

Example: StreamPossible values:

Responses

200

The result file. Returned directly when Mode=Stream is set.

application/octet-stream

string · binaryOptional

202

Job is still in progress. The body contains the current job status — poll the job again later.

application/json

302

Default behaviour for completed jobs (when Mode is not Stream). Redirects to a temporary signed URL on cloud storage. Follow the Location header to download the file.

401

Unauthorized. Check that your Account SID and Auth Token are correct.

404

Job not found.

get/Agencies/{AccountSID}/Jobs/{JobId}/Download

curl

curl -L \
  --url 'https://api.impact.com/Agencies/{AccountSID}/Jobs/{JobId}/Download' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

binary

Replay a job

put

Re-runs a previously executed job with the same parameters. Useful for jobs in a terminal state (COMPLETED, CANCELLED, ERROR, or FAILED) when fresh data is wanted over the same export window.

The Job.Replayable field on the original job indicates whether the job can be replayed. Replaying creates a new job with a new Id — the original job is not modified.

Path parameters

AccountSIDstringRequired

Your Agency Account SID.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

JobIdstring · uuidRequired

The unique job identifier (UUID). Returned in the QueuedUri of any endpoint that schedules a job (for example GET /ReportExport/{ReportId}).

Example: 81258bc5-54cf-4a09-9fbc-eb837637d02f

Responses

200

The status of the newly replayed job.

application/json

A scheduled job — created automatically by other endpoints (such as ReportExport) and tracked through its lifecycle.

Idstring · uuidOptional

The unique job identifier (UUID).

Example: 81258bc5-54cf-4a09-9fbc-eb837637d02f

Typestring · enumOptional

The kind of work the job performs. Created automatically by the endpoint that schedules the job.

Value	Description
`DownloadReport`	Download an existing pre-generated report file.
`ApiReport`	Asynchronous report export created via `GET /ReportExport/{ReportId}`.
`UploadAds`	Bulk ad upload job.
`TermModification`	Bulk modification of contract terms.

Additional job types may exist beyond the values listed above.

Example: ApiReportPossible values:

ProgramIdstringOptional

The program (also known as CampaignId) the job is scoped to, if applicable.

Example: 3629

CreatedBystringOptional

The Account SID of the user or account that created this job.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

CreatedDatestring · date-timeOptional

The date and time the job was created, in ISO 8601 format with UTC offset.

Example: 2026-05-29T04:33:50-05:00

StartedDatestring · date-timeOptional

The date and time the job began processing. Empty until the job transitions out of QUEUED.

Example: 2026-05-29T04:33:55-05:00

CompletedDatestring · date-timeOptional

The date and time the job finished successfully. Only populated when Status is COMPLETED.

Example: 2026-05-29T04:35:12-05:00

AbandonedDatestring · date-timeOptional

The date and time the job was abandoned (timed out before completing).

CancelledDatestring · date-timeOptional

The date and time the job was cancelled. Only populated when Status is CANCELLED.

FailedDatestring · date-timeOptional

The date and time the job entered a failed state. Only populated when Status is FAILED or ERROR.

LastProgressUpdateDatestring · date-timeOptional

The date and time PercentageComplete was last updated.

Example: 2026-05-29T04:34:30-05:00

Statusstring · enumOptional

The current lifecycle status of the job.

Value	Description
`QUEUED`	The job is scheduled and awaiting processing.
`RUNNING`	The job is actively processing.
`COMPLETED`	The job finished successfully — a result file is available via the `Download` endpoint.
`CANCELLED`	The job was cancelled before completion.
`ERROR`	The job stopped due to an unrecoverable system error.
`FAILED`	The job ran but did not produce a usable result.

Example: COMPLETEDPossible values:

StatusMessagestringOptional

A human-readable description of the current status — useful for diagnosing failures.

Example: Job processing completed successfully.

RecordsProcessedintegerOptional

The total number of records the job has processed so far.

Example: 250

PercentageCompleteinteger · max: 100Optional

Progress through the job, from 0 to 100.

Example: 100

ReplayablebooleanOptional

Whether this job can be replayed (re-run with the same parameters) using PUT /Jobs/{JobId}/Replay. Typically true for jobs in a terminal state.

Example: true

ResultUristring · uri-referenceOptional

The relative URI to download the job's result file. Available once Status is COMPLETED.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/81258bc5-54cf-4a09-9fbc-eb837637d02f/Download

401

Unauthorized. Check that your Account SID and Auth Token are correct.

403

Either the credentials lack permission to access this job, or the job is not in a replayable state (e.g., it is still QUEUED or RUNNING). The response Message will indicate which case applies.

404

Job not found.

put/Agencies/{AccountSID}/Jobs/{JobId}/Replay

curl

curl -L \
  --request PUT \
  --url 'https://api.impact.com/Agencies/{AccountSID}/Jobs/{JobId}/Replay' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "Id": "81258bc5-54cf-4a09-9fbc-eb837637d02f",
  "Type": "ApiReport",
  "ProgramId": "3629",
  "CreatedBy": "IRq8mWJybvoQ1020978kbj7am8zzM2dBL1",
  "CreatedDate": "2026-05-29T04:33:50-05:00",
  "StartedDate": "2026-05-29T04:33:55-05:00",
  "CompletedDate": "2026-05-29T04:35:12-05:00",
  "AbandonedDate": "",
  "CancelledDate": "",
  "FailedDate": "",
  "LastProgressUpdateDate": "2026-05-29T04:34:30-05:00",
  "Status": "COMPLETED",
  "StatusMessage": "Job processing completed successfully.",
  "RecordsProcessed": 250,
  "PercentageComplete": 100,
  "Replayable": true,
  "ResultUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Jobs/81258bc5-54cf-4a09-9fbc-eb837637d02f/Download"
}

PreviousJobs Management NextModels

Last updated 14 hours ago