API Reference

List all API submissions

Returns a list of your API submissions. Due to the incredibly large size of a typical response as well as the long call time to retrieve a response, impact.com does not recommend using this endpoint. Instead, use the Retrieve an API submission endpoint.

Parameters

No parameters.

Returns

Returns an array of API submission objects up to a limit dictated by @pagesize. Each entry in the array is a separate API submission object. If no API submission objects exist, the resulting array will be empty. This request should never return an error.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/APISubmissions' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example Response

{
  "@page": "1",
  ...
  "APISubmission": [
    {
      "BatchId": "A-b1234c56-7d89-0e12-3f4g-5h6ij7k8901m",
      "AccountId": "10001",
      "SubmissionDate": "2020-09-10T09:50:12-07:00",
      "CampaignId": "1000",
      "ActionTrackerId": "1001",
      "MediaPartnerId": "10000",
      "EventCode": "",
      "OrderId": "1234567890123",
      "Payload": "CampaignId=1000&EventTypeId=1001&EventDate=2024-08-01T23:55:24-08:00&OrderId=1234567890123&ClickId=SKhRQaSXwxyOUQ%253AwUx0Mo36FUkiXxtxVUQTEzY0&CustomerId=BCZ2WVSH674563PDPYOTM3AXDQ&OrderPromoCode=10OFF-ROCKET&CustomerStatus=NEW&CustomerPostCode=15122&CurrencyCode=USD&OrderDiscount=5&IpAddress=72.194.216.61&ItemSku1=12345&ItemName1=Ninjago&ItemCategory1=Lego&ItemQuantity1=2&ItemPrice1=10&ItemSku2=78909&ItemName2=Barbie&ItemCategory2=Dolls&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-b1234c56-7d89-0e12-3f4g-5h6ij7k8901m"
      },
    ...
  ]
}