> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/reference/jobs/jobs.md).

# Jobs

## List All Jobs

> Returns a list of jobs, which can be filtered by their creation date.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Jobs","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Job":{"type":"object","properties":{"Id":{"type":"string","description":"The unique job identifier."},"Type":{"type":"string","enum":["DownloadReport","ApiReport","UploadAds","TermModification","ClickExport"],"description":"The type of job."},"ProgramId":{"type":"string","description":"The Program ID (CampaignId) this job was scheduled for."},"CreatedBy":{"type":"string","description":"The Account SID of the account that scheduled this job."},"CreatedDate":{"type":"string","format":"date-time","description":"The date and time the job was created."},"StartedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job started processing."},"CompletedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job completed successfully."},"AbandonedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job was abandoned, if applicable."},"CancelledDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job was cancelled, if applicable."},"FailedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job failed, if applicable."},"LastProgressUpdateDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time of the most recent progress update."},"Status":{"type":"string","enum":["QUEUED","RUNNING","COMPLETED","CANCELLED","ERROR","FAILED"],"description":"The current status of job processing."},"StatusMessage":{"type":"string","description":"A message describing the current job status."},"RecordsProcessed":{"type":"integer","description":"The number of records processed."},"PercentageComplete":{"type":"integer","description":"The percentage of work completed."},"Replayable":{"type":"boolean","description":"Indicates if this job type can be replayed."},"ResultUri":{"type":"string","format":"uri-reference","nullable":true,"description":"A URI pointing to the result file of a successfully completed job."}}}}},"paths":{"/Advertisers/{AccountSID}/Jobs":{"get":{"summary":"List All Jobs","description":"Returns a list of jobs, which can be filtered by their creation date.","operationId":"listJobs","tags":["Jobs"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"CreatedAfter","in":"query","description":"Return jobs scheduled after this date (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"CreatedBefore","in":"query","description":"Return jobs scheduled before this date (ISO 8601).","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A list of job objects.","content":{"application/json":{"schema":{"type":"object","properties":{"Jobs":{"type":"array","description":"The list of job objects.","items":{"$ref":"#/components/schemas/Job"}}}}}}}}}}}}
```

## Get Job Status

> Returns an object describing the status of the queried job.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Jobs","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Job":{"type":"object","properties":{"Id":{"type":"string","description":"The unique job identifier."},"Type":{"type":"string","enum":["DownloadReport","ApiReport","UploadAds","TermModification","ClickExport"],"description":"The type of job."},"ProgramId":{"type":"string","description":"The Program ID (CampaignId) this job was scheduled for."},"CreatedBy":{"type":"string","description":"The Account SID of the account that scheduled this job."},"CreatedDate":{"type":"string","format":"date-time","description":"The date and time the job was created."},"StartedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job started processing."},"CompletedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job completed successfully."},"AbandonedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job was abandoned, if applicable."},"CancelledDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job was cancelled, if applicable."},"FailedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job failed, if applicable."},"LastProgressUpdateDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time of the most recent progress update."},"Status":{"type":"string","enum":["QUEUED","RUNNING","COMPLETED","CANCELLED","ERROR","FAILED"],"description":"The current status of job processing."},"StatusMessage":{"type":"string","description":"A message describing the current job status."},"RecordsProcessed":{"type":"integer","description":"The number of records processed."},"PercentageComplete":{"type":"integer","description":"The percentage of work completed."},"Replayable":{"type":"boolean","description":"Indicates if this job type can be replayed."},"ResultUri":{"type":"string","format":"uri-reference","nullable":true,"description":"A URI pointing to the result file of a successfully completed job."}}}}},"paths":{"/Advertisers/{AccountSID}/Jobs/{JobId}":{"get":{"summary":"Get Job Status","description":"Returns an object describing the status of the queried job.","operationId":"getJobById","tags":["Jobs"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"JobId","in":"path","required":true,"description":"The unique identifier for the job.","schema":{"type":"string"}}],"responses":{"200":{"description":"A single job object representing the status of the job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}}}}}}
```

## Download Job Result File

> Downloads the result file for a successfully completed job.\
> \- Returns 200 with the file if completed.\
> \- Returns 202 with the job status if still processing.\
> \- Returns 302 to redirect to a temporary signed URL for download (if \`Mode\` is not 'Stream').

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Jobs","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Job":{"type":"object","properties":{"Id":{"type":"string","description":"The unique job identifier."},"Type":{"type":"string","enum":["DownloadReport","ApiReport","UploadAds","TermModification","ClickExport"],"description":"The type of job."},"ProgramId":{"type":"string","description":"The Program ID (CampaignId) this job was scheduled for."},"CreatedBy":{"type":"string","description":"The Account SID of the account that scheduled this job."},"CreatedDate":{"type":"string","format":"date-time","description":"The date and time the job was created."},"StartedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job started processing."},"CompletedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job completed successfully."},"AbandonedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job was abandoned, if applicable."},"CancelledDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job was cancelled, if applicable."},"FailedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job failed, if applicable."},"LastProgressUpdateDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time of the most recent progress update."},"Status":{"type":"string","enum":["QUEUED","RUNNING","COMPLETED","CANCELLED","ERROR","FAILED"],"description":"The current status of job processing."},"StatusMessage":{"type":"string","description":"A message describing the current job status."},"RecordsProcessed":{"type":"integer","description":"The number of records processed."},"PercentageComplete":{"type":"integer","description":"The percentage of work completed."},"Replayable":{"type":"boolean","description":"Indicates if this job type can be replayed."},"ResultUri":{"type":"string","format":"uri-reference","nullable":true,"description":"A URI pointing to the result file of a successfully completed job."}}}}},"paths":{"/Advertisers/{AccountSID}/Jobs/{JobId}/Download":{"get":{"summary":"Download Job Result File","description":"Downloads the result file for a successfully completed job.\n- Returns 200 with the file if completed.\n- Returns 202 with the job status if still processing.\n- Returns 302 to redirect to a temporary signed URL for download (if `Mode` is not 'Stream').","operationId":"downloadJobResult","tags":["Jobs"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"JobId","in":"path","required":true,"description":"The unique identifier for the job.","schema":{"type":"string"}},{"name":"Mode","in":"query","description":"Set to 'Stream' to get the file directly in the response instead of a redirect.","schema":{"type":"string","enum":["Stream"]}}],"responses":{"200":{"description":"The job result file.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"202":{"description":"The job is not yet complete. The response body contains the current job status object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"302":{"description":"Redirect to a temporary signed URL for result file download."}}}}}}
```

## Replay a Job

> Re-queues a completed, failed, or cancelled job for processing. This is useful if you expect additional results to be present for your original export window.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Jobs","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Job":{"type":"object","properties":{"Id":{"type":"string","description":"The unique job identifier."},"Type":{"type":"string","enum":["DownloadReport","ApiReport","UploadAds","TermModification","ClickExport"],"description":"The type of job."},"ProgramId":{"type":"string","description":"The Program ID (CampaignId) this job was scheduled for."},"CreatedBy":{"type":"string","description":"The Account SID of the account that scheduled this job."},"CreatedDate":{"type":"string","format":"date-time","description":"The date and time the job was created."},"StartedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job started processing."},"CompletedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job completed successfully."},"AbandonedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job was abandoned, if applicable."},"CancelledDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job was cancelled, if applicable."},"FailedDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the job failed, if applicable."},"LastProgressUpdateDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time of the most recent progress update."},"Status":{"type":"string","enum":["QUEUED","RUNNING","COMPLETED","CANCELLED","ERROR","FAILED"],"description":"The current status of job processing."},"StatusMessage":{"type":"string","description":"A message describing the current job status."},"RecordsProcessed":{"type":"integer","description":"The number of records processed."},"PercentageComplete":{"type":"integer","description":"The percentage of work completed."},"Replayable":{"type":"boolean","description":"Indicates if this job type can be replayed."},"ResultUri":{"type":"string","format":"uri-reference","nullable":true,"description":"A URI pointing to the result file of a successfully completed job."}}}}},"paths":{"/Advertisers/{AccountSID}/Jobs/{JobId}/Replay":{"put":{"summary":"Replay a Job","description":"Re-queues a completed, failed, or cancelled job for processing. This is useful if you expect additional results to be present for your original export window.","operationId":"replayJob","tags":["Jobs"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"JobId","in":"path","required":true,"description":"The unique identifier for the job to be replayed.","schema":{"type":"string"}}],"responses":{"200":{"description":"The job was successfully re-queued. The response body contains the new status of the replayed job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"403":{"description":"Forbidden. The job is not in a replayable state (e.g., it is still running) or is not a replayable type."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/reference/jobs/jobs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.