# API Submissions ## List All API Submissions > Returns a list of your API submissions. Note that impact.com does not recommend using this endpoint due to potentially large response sizes. ```json {"openapi":"3.1.0","info":{"title":"Brand API - Submissions","version":"v12"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"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 the record was submitted to."},"ActionTrackerId":{"type":"integer","description":"Id of the action tracker (event type) the record applies to."},"MediaPartnerId":{"type":"integer","description":"Id of the partner that drove the record."},"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 that was submitted."},"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":{"summary":"List All API Submissions","description":"Returns a list of your API submissions. Note that impact.com does not recommend using this endpoint due to potentially large response sizes.","operationId":"listApiSubmissions","tags":["API Submissions"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Your unique Account SID."}],"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 details and status of a single record submission made via the API. ```json {"openapi":"3.1.0","info":{"title":"Brand API - Submissions","version":"v12"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"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 the record was submitted to."},"ActionTrackerId":{"type":"integer","description":"Id of the action tracker (event type) the record applies to."},"MediaPartnerId":{"type":"integer","description":"Id of the partner that drove the record."},"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 that was submitted."},"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":{"summary":"Retrieve an API Submission","description":"Retrieves the details and status of a single record submission made via the API.","operationId":"getApiSubmissionById","tags":["API Submissions"],"parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique Account SID.","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: 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: ``` GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v12/reference/submissions/api-submissions.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.