Jobs

Return a list of jobs

get

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Query parameters

CreatedAfterstring · date-timeOptional

Return jobs scheduled after this date and time (ISO 8601).

CreatedBeforestring · date-timeOptional

Return jobs scheduled before this date and time (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"
    }
  ]
}

Return a job

get

Returns an object describing the current status and metadata of a specific job.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

JobIdstring · uuidRequired

The unique identifier for the job.

Responses

200

A single job object representing the status of the job.

application/json

Idstring · uuidOptional

The unique identifier for the job.

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 a job result

get

Downloads the result file if the job is COMPLETED. If the job is still processing, it returns the current status object.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

JobIdstring · uuidRequired

The unique identifier for the job whose result you want to download.

Query parameters

Modestring · enumOptional

Set to 'Stream' to stream the file directly instead of redirecting to a signed URL.

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

Replays a completed, failed, or canceled job. Useful if additional results are expected for the original export window.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

JobIdstring · uuidRequired

The unique identifier for the job to replay.

Responses

200

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

application/json

Idstring · uuidOptional

The unique identifier for the job.

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 or 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"
}