Jobs

List All Jobs

get

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

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Query parameters

CreatedAfterstring · date-timeOptional

Return jobs scheduled after this date (ISO 8601).

CreatedBeforestring · date-timeOptional

Return jobs scheduled before this date (ISO 8601).

Responses

200

A list of job objects.

application/json

get/Advertisers/{AccountSID}/Jobs

cURL

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

200

A list of job objects.

{
  "Jobs": [
    {
      "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",
      "CompletedDate": "2022-06-07T04:33:50-05:00",
      "AbandonedDate": "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"
    }
  ]
}

Get Job Status

get

Returns an object describing the status of the queried job.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

JobIdstringRequired

The unique identifier for the job.

Responses

200

A single job object representing the status of the job.

application/json

IdstringOptional

The unique job identifier.

Example: d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f

Typestring · enumOptional

The type of job.

Example: ClickExportPossible values:

ProgramIdstringOptional

The Program ID (CampaignId) this job was scheduled for.

Example: 3629

CreatedBystringOptional

The Account SID of the account that scheduled this job.

Example: <AccountSID>

CreatedDatestring · date-timeOptional

The date and time the job was created.

Example: 2022-06-07T04:33:50-05:00

StartedDatestring · date-time · nullableOptional

The date and time the job started processing.

Example: 2022-06-07T04:33:50-05:00

CompletedDatestring · date-time · nullableOptional

The date and time the job completed successfully.

Example: 2022-06-07T04:33:50-05:00

AbandonedDatestring · date-time · nullableOptional

The date and time the job was abandoned, if applicable.

Example: 2022-06-07T04:33:50-05:00

CancelledDatestring · date-time · nullableOptional

The date and time the job was cancelled, if applicable.

Example: 2022-06-07T04:33:50-05:00

FailedDatestring · date-time · nullableOptional

The date and time the job failed, if applicable.

Example: 2022-06-07T04:33:50-05:00

LastProgressUpdateDatestring · date-time · nullableOptional

The date and time of the most recent progress update.

Example: 2022-06-07T04:33:50-05:00

Statusstring · enumOptional

The current status of job processing.

Example: COMPLETEDPossible values:

StatusMessagestringOptional

A message describing the current job status.

Example: Job processing completed successfully.

RecordsProcessedintegerOptional

The number of records processed.

Example: 250

PercentageCompleteintegerOptional

The percentage of work completed.

Example: 100

ReplayablebooleanOptional

Indicates if this job type can be replayed.

Example: true

ResultUristring · uri-reference · nullableOptional

A URI pointing to the result file of a successfully completed job.

Example: /Advertisers/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download

get/Advertisers/{AccountSID}/Jobs/{JobId}

cURL

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

200

A single job object representing the status of the 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",
  "CompletedDate": "2022-06-07T04:33:50-05:00",
  "AbandonedDate": "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"
}

Download Job Result File

get

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').

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

JobIdstringRequired

The unique identifier for the job.

Query parameters

Modestring · enumOptional

Set to 'Stream' to get the file directly in the response instead of a redirect.

Possible values:

Responses

200

The job result file.

application/octet-stream

string · binaryOptional

202

The job is not yet complete. The response body contains the current job status object.

application/json

302

Redirect to a temporary signed URL for result file download.

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

cURL

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

binary

Replay a Job

put

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.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

JobIdstringRequired

The unique identifier for the job to be replayed.

Responses

200

The job was successfully re-queued. The response body contains the new status of the replayed job.

application/json

IdstringOptional

The unique job identifier.

Example: d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f

Typestring · enumOptional

The type of job.

Example: ClickExportPossible values:

ProgramIdstringOptional

The Program ID (CampaignId) this job was scheduled for.

Example: 3629

CreatedBystringOptional

The Account SID of the account that scheduled this job.

Example: <AccountSID>

CreatedDatestring · date-timeOptional

The date and time the job was created.

Example: 2022-06-07T04:33:50-05:00

StartedDatestring · date-time · nullableOptional

The date and time the job started processing.

Example: 2022-06-07T04:33:50-05:00

CompletedDatestring · date-time · nullableOptional

The date and time the job completed successfully.

Example: 2022-06-07T04:33:50-05:00

AbandonedDatestring · date-time · nullableOptional

The date and time the job was abandoned, if applicable.

Example: 2022-06-07T04:33:50-05:00

CancelledDatestring · date-time · nullableOptional

The date and time the job was cancelled, if applicable.

Example: 2022-06-07T04:33:50-05:00

FailedDatestring · date-time · nullableOptional

The date and time the job failed, if applicable.

Example: 2022-06-07T04:33:50-05:00

LastProgressUpdateDatestring · date-time · nullableOptional

The date and time of the most recent progress update.

Example: 2022-06-07T04:33:50-05:00

Statusstring · enumOptional

The current status of job processing.

Example: COMPLETEDPossible values:

StatusMessagestringOptional

A message describing the current job status.

Example: Job processing completed successfully.

RecordsProcessedintegerOptional

The number of records processed.

Example: 250

PercentageCompleteintegerOptional

The percentage of work completed.

Example: 100

ReplayablebooleanOptional

Indicates if this job type can be replayed.

Example: true

ResultUristring · uri-reference · nullableOptional

A URI pointing to the result file of a successfully completed job.

Example: /Advertisers/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download

403

Forbidden. The job is not in a replayable state (e.g., it is still running) or is not a replayable type.

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

cURL

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

{
  "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",
  "CompletedDate": "2022-06-07T04:33:50-05:00",
  "AbandonedDate": "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"
}

PreviousJobs

NextModels

Last updated 4 months ago