API Reference

Retrieve an API submission

Retrieves an API submission object. You will need to pass the unique impact.com API submission BatchId value.

Parameters

No parameters.

Returns

Returns an API submission object if a valid identifier is provided. Returns an error for invalid API submission identifiers.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/APISubmissions/A-b1234c56-7d89-0e12-3f4g-5h6ij7k8901m' \
  -X GET \
  -u '<AccountSid>:<AuthToken>' \
  -H 'Accept: application/json'

Example Response

{
  "BatchId": "A-b1234c56-7d89-0e12-3f4g-5h6ij7k8901m",
  "AccountId": "10001",
  "SubmissionDate": "2020-09-10T09:50:12-07:00",
  "CampaignId": "1000",
  "ActionTrackerId": "4000",
  "MediaPartnerId": "10000",
  "EventCode": "",
  "OrderId": "1234567890123",
  "Payload": "CampaignId=1000&EventTypeId=4000&EventDate=2024-08-01T23:55:24-08:00&OrderId=1234567890123&ClickId=SKhRQaSXwxyOUQ%253AwUx0Mo36FUkiXxtxVUQTEzY0&CustomerId=BCZ2WVSH674563PDPYOTM3AXDQ&OrderPromoCode=10OFF-FORGE&CustomerStatus=NEW&CustomerPostCode=93107&CurrencyCode=USD&OrderDiscount=5&IpAddress=12.345.678.90&ItemSku1=12345&ItemName1=Anvil&ItemCategory1=Anvils&ItemQuantity1=2&ItemPrice1=10&ItemSku2=55555&ItemName2=Hammer&ItemCategory2=Hammers&ItemQuantity2=1&ItemPrice2=6.99",
  "Type": "Conversion",
  "Status": "Complete",
  "CompletionDate": "2020-09-10T10:11:15-07:00",
  "ErrorType": "Contract Error",
  "ErrorReason": "NO_VALID_REFERRERS_FOUND RESTRICTED_PROMOCODE",
  "Uri": "/Advertisers/<AccountSID>/APISubmissions/A-f6675c69-4a69-4c04-8a1d-3f2eb7a6754e"
}