API Submissions

List All API Submissions

get

Returns a list of your API submissions. Note that impact.com does not recommend using this endpoint due to potentially large response sizes.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique Account SID.

Responses

200

A list of API submission objects.

application/json

get/Advertisers/{AccountSID}/APISubmissions

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/APISubmissions HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A list of API submission objects.

{
  "APISubmission": [
    {
      "BatchId": "BATCH-789",
      "AccountId": 12345,
      "SubmissionDate": "2026-09-10T22:55:32-08:00",
      "CampaignId": 1000,
      "ActionTrackerId": 18500,
      "MediaPartnerId": 2552842,
      "EventCode": "ACME_SALE",
      "OrderId": "9217374917471",
      "Payload": "EventTypeCode=ACME_SALE&OrderId=9217374917471",
      "Type": "Conversion",
      "Status": "Queued",
      "CompletionDate": "2026-09-10T22:55:35-08:00",
      "ErrorType": "Validation",
      "ErrorReason": "",
      "Uri": "/Advertisers/<AccountSID>/APISubmissions/BATCH-789"
    }
  ]
}

Retrieve an API Submission

get

Retrieves the details and status of a single record submission made via the API.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique Account SID.

BatchIdstringRequired

The unique batch ID of the API submission.

Responses

200

A single API submission object.

application/json

BatchIdstringOptional

Id of the API submission.

Example: BATCH-789

AccountIdintegerOptional

Id of the brand account that submitted the API submission.

Example: 12345

SubmissionDatestring · date-timeOptional

Date and time the API submission was submitted (ISO 8601).

Example: 2026-09-10T22:55:32-08:00

CampaignIdintegerOptional

Id of the program the record was submitted to.

Example: 1000

ActionTrackerIdintegerOptional

Id of the action tracker (event type) the record applies to.

Example: 18500

MediaPartnerIdintegerOptional

Id of the partner that drove the record.

Example: 2552842

EventCodestringOptional

Configurable string code identifying the event type, if used instead of EventTypeId.

Example: ACME_SALE

OrderIdstring · nullableOptional

If the record submitted is a conversion, this is the unique Id associated with that conversion.

Example: 9217374917471

PayloadstringOptional

Information about the tracking data that was submitted.

Example: EventTypeCode=ACME_SALE&OrderId=9217374917471

Typestring · enumOptional

Type of record submitted.

Possible values:

Statusstring · enumOptional

Status of the API submission. Will always begin as Queued.

Possible values:

CompletionDatestring · date-time · nullableOptional

Date and time that the submission finished processing. Empty if not finished (ISO 8601).

Example: 2026-09-10T22:55:35-08:00

ErrorTypestring · enum · nullableOptional

Type of errors encountered during the submission process. Empty if no errors were encountered.

Possible values:

ErrorReasonstring · nullableOptional

List of error explanations to help describe the ErrorType.

Uristring · uri-referenceOptional

The unique reference to this API submission in the impact.com API.

Example: /Advertisers/<AccountSID>/APISubmissions/BATCH-789

get/Advertisers/{AccountSID}/APISubmissions/{BatchId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/APISubmissions/{BatchId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A single API submission object.

{
  "BatchId": "BATCH-789",
  "AccountId": 12345,
  "SubmissionDate": "2026-09-10T22:55:32-08:00",
  "CampaignId": 1000,
  "ActionTrackerId": 18500,
  "MediaPartnerId": 2552842,
  "EventCode": "ACME_SALE",
  "OrderId": "9217374917471",
  "Payload": "EventTypeCode=ACME_SALE&OrderId=9217374917471",
  "Type": "Conversion",
  "Status": "Queued",
  "CompletionDate": "2026-09-10T22:55:35-08:00",
  "ErrorType": "Validation",
  "ErrorReason": "",
  "Uri": "/Advertisers/<AccountSID>/APISubmissions/BATCH-789"
}