> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/brand-api-reference-v11/reference/submissions/api-submissions.md).
# API Submissions
## List all API submissions
> Returns a list of all API submissions. Note: impact.com does not recommend \
> using this endpoint due to typical response size; use Retrieve an API \
> Submission instead.
```json
{"openapi":"3.1.0","info":{"title":"Brand Submissions API","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"ApiSubmission":{"type":"object","properties":{"BatchId":{"type":"string","description":"Id of the API submission."},"AccountId":{"type":"integer","description":"Id of the brand account that submitted the API submission."},"SubmissionDate":{"type":"string","format":"date-time","description":"Date and time the API submission was submitted (ISO 8601)."},"CampaignId":{"type":"integer","description":"Id of the program (formerly known as campaign) to which the record was submitted."},"ActionTrackerId":{"type":"integer","description":"Id of the action tracker (event type) the record applies to."},"MediaPartnerId":{"type":"integer","description":"Id of the partner (formerly known as media partner) that drove the record submitted via API."},"EventCode":{"type":"string","description":"Configurable string code identifying the event type, if used instead of EventTypeId."},"OrderId":{"type":"string","nullable":true,"description":"If the record submitted is a conversion, this is the unique Id associated with that conversion."},"Payload":{"type":"string","description":"Information about the tracking data itself that was submitted to impact.com via an API call."},"Type":{"type":"string","description":"Type of record submitted.","enum":["Conversion","Modification","Reversal"]},"Status":{"type":"string","description":"Status of the API submission. Will always begin as Queued.","enum":["Queued","In Progress","Complete"]},"CompletionDate":{"type":"string","format":"date-time","nullable":true,"description":"Date and time that the submission finished processing. Empty if not finished (ISO 8601)."},"ErrorType":{"type":"string","nullable":true,"description":"Type of errors encountered during the submission process. Empty if no errors were encountered.","enum":["Validation","Contract Error"]},"ErrorReason":{"type":"string","nullable":true,"description":"List of error explanations to help describe the ErrorType."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this API submission in the impact.com API."}}}}},"paths":{"/Advertisers/{AccountSID}/APISubmissions":{"get":{"operationId":"listApiSubmissions","tags":["API Submissions"],"summary":"List all API submissions","description":"Returns a list of all API submissions. Note: impact.com does not recommend \nusing this endpoint due to typical response size; use Retrieve an API \nSubmission instead.\n","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"The unique identifier for the account.","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of API submission objects.","content":{"application/json":{"schema":{"type":"object","properties":{"APISubmission":{"type":"array","description":"The list of API submission objects.","items":{"$ref":"#/components/schemas/ApiSubmission"}}}}}}}}}}}}
```
## Retrieve an API submission
> Retrieves the status and error details for a specific API submission.
```json
{"openapi":"3.1.0","info":{"title":"Brand Submissions API","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"ApiSubmission":{"type":"object","properties":{"BatchId":{"type":"string","description":"Id of the API submission."},"AccountId":{"type":"integer","description":"Id of the brand account that submitted the API submission."},"SubmissionDate":{"type":"string","format":"date-time","description":"Date and time the API submission was submitted (ISO 8601)."},"CampaignId":{"type":"integer","description":"Id of the program (formerly known as campaign) to which the record was submitted."},"ActionTrackerId":{"type":"integer","description":"Id of the action tracker (event type) the record applies to."},"MediaPartnerId":{"type":"integer","description":"Id of the partner (formerly known as media partner) that drove the record submitted via API."},"EventCode":{"type":"string","description":"Configurable string code identifying the event type, if used instead of EventTypeId."},"OrderId":{"type":"string","nullable":true,"description":"If the record submitted is a conversion, this is the unique Id associated with that conversion."},"Payload":{"type":"string","description":"Information about the tracking data itself that was submitted to impact.com via an API call."},"Type":{"type":"string","description":"Type of record submitted.","enum":["Conversion","Modification","Reversal"]},"Status":{"type":"string","description":"Status of the API submission. Will always begin as Queued.","enum":["Queued","In Progress","Complete"]},"CompletionDate":{"type":"string","format":"date-time","nullable":true,"description":"Date and time that the submission finished processing. Empty if not finished (ISO 8601)."},"ErrorType":{"type":"string","nullable":true,"description":"Type of errors encountered during the submission process. Empty if no errors were encountered.","enum":["Validation","Contract Error"]},"ErrorReason":{"type":"string","nullable":true,"description":"List of error explanations to help describe the ErrorType."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this API submission in the impact.com API."}}}}},"paths":{"/Advertisers/{AccountSID}/APISubmissions/{BatchId}":{"get":{"operationId":"getApiSubmission","tags":["API Submissions"],"summary":"Retrieve an API submission","description":"Retrieves the status and error details for a specific API submission.","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"The unique identifier for the account.","schema":{"type":"string"}},{"name":"BatchId","in":"path","required":true,"description":"The unique batch ID of the API submission.","schema":{"type":"string"}}],"responses":{"200":{"description":"A single API submission object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSubmission"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v11/reference/submissions/api-submissions.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.