Jobs

Endpoints for listing, retrieving, downloading, and replaying partner jobs.

List Jobs

get

Returns a list of jobs based on creation date filters.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters

CreatedAfterstring · dateOptional

Return jobs scheduled after this date (YYYY-MM-DD).

CreatedBeforestring · dateOptional

Return jobs scheduled before this date (YYYY-MM-DD).

Responses

200

A list of job objects.

application/json

get/Mediapartners/{AccountSID}/Jobs

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{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": "/Mediapartners/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download"
    }
  ]
}

Retrieve Job Status

get

Returns an object describing the status of the queried job.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

JobIdstringRequired

The unique job identifier.

Responses

200

Current job status and details.

application/json

IdstringOptional

The unique identifier for this job.

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

Typestring · enumOptional

The type of job.

Example: ClickExportPossible values:

ProgramIdstringOptional

The impact.com 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 initially scheduled.

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

StartedDatestring · date-timeOptional

The date and time the job last started running.

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

CompletedDatestring · date-timeOptional

The date and time the job was last successfully completed.

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

AbandonedDatestring · date-timeOptional

Set when an attempt is made to start a job that is already running.

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

CancelledDatestring · date-timeOptional

The date and time the job was last canceled.

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

FailedDatestring · date-timeOptional

The date and time processing of this job last raised an error.

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

LastProgressUpdateDatestring · date-timeOptional

The date and time progress on job processing was last updated.

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

Statusstring · enumOptional

The current processing status of the job.

Example: COMPLETEDPossible values:

StatusMessagestringOptional

A human-readable message describing the current job status.

Example: Job processing completed successfully.

RecordsProcessedintegerOptional

The number of records processed up to the last progress update.

Example: 250

PercentageCompleteintegerOptional

The percentage of job processing that has been completed.

Example: 100

ReplayablebooleanOptional

Indicates whether this job type supports replay.

Example: true

ResultUristringOptional

API resource path to download the result file once the job is complete.

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

get/Mediapartners/{AccountSID}/Jobs/{JobId}

curl

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

200

Current job status and details.

{
  "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": "/Mediapartners/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download"
}

Download Job Results

get

Download the job result file if the job was completed successfully. If the job isn't done, the job status will be returned. A job result is available for download for 90 days.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

JobIdstringRequired

The unique job identifier.

Query parameters

Modestring · enumOptional

If set to Stream, the file is streamed directly instead of using a signed URL redirect.

Possible values:

Responses

200

Returns the job result file.

application/octet-stream

string · binaryOptional

202

Job is not yet complete. Returns the current job status.

application/json

302

Redirects to a temporary signed URL for file download.

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

curl

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

binary

Replay Job

put

Replay a completed job. Replays are intended for jobs with COMPLETED, FAILED, or CANCELLED status, or if additional results are expected for the chosen export window.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

JobIdstringRequired

The unique job identifier.

Responses

200

Job successfully queued for replay.

application/json

IdstringOptional

The unique identifier for this job.

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

Typestring · enumOptional

The type of job.

Example: ClickExportPossible values:

ProgramIdstringOptional

The impact.com 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 initially scheduled.

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

StartedDatestring · date-timeOptional

The date and time the job last started running.

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

CompletedDatestring · date-timeOptional

The date and time the job was last successfully completed.

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

AbandonedDatestring · date-timeOptional

Set when an attempt is made to start a job that is already running.

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

CancelledDatestring · date-timeOptional

The date and time the job was last canceled.

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

FailedDatestring · date-timeOptional

The date and time processing of this job last raised an error.

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

LastProgressUpdateDatestring · date-timeOptional

The date and time progress on job processing was last updated.

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

Statusstring · enumOptional

The current processing status of the job.

Example: COMPLETEDPossible values:

StatusMessagestringOptional

A human-readable message describing the current job status.

Example: Job processing completed successfully.

RecordsProcessedintegerOptional

The number of records processed up to the last progress update.

Example: 250

PercentageCompleteintegerOptional

The percentage of job processing that has been completed.

Example: 100

ReplayablebooleanOptional

Indicates whether this job type supports replay.

Example: true

ResultUristringOptional

API resource path to download the result file once the job is complete.

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

403

The job is not in a replayable state or is not of a replayable type.

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

curl

curl -L \
  --request PUT \
  --url 'https://api.impact.com/Mediapartners/{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": "/Mediapartners/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download"
}