# Reports ## List All Available Reports > Retrieves a list of all reports available to your account, indicating whether they can be run via the API. ```json {"openapi":"3.1.0","info":{"title":"Brand API - Reports","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":{"ReportInfo":{"type":"object","description":"General information about an available report.","properties":{"Name":{"type":"string","description":"The display name of the report."},"Id":{"type":"string","description":"The unique identifier or handle for the report."},"Category":{"type":"string","description":"The category the report belongs to."},"Description":{"type":"string","description":"A description of what the report contains."},"ApiAccessible":{"type":"boolean","description":"Whether this report can be run via the API."},"ApiRunUri":{"type":"string","format":"uri-reference","description":"The URI to run this report synchronously."},"DeferredApiRunUri":{"type":"string","format":"uri-reference","description":"The URI to schedule this report as an asynchronous export job."},"MetaDataUri":{"type":"string","format":"uri-reference","description":"The URI to retrieve this report's metadata."},"RunUri":{"type":"string","format":"uri-reference","description":"The URI to run this report in the impact.com platform."}}}}},"paths":{"/Advertisers/{AccountSID}/Reports":{"get":{"summary":"List All Available Reports","description":"Retrieves a list of all reports available to your account, indicating whether they can be run via the API.","operationId":"listReports","tags":["Reports"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Your unique Account SID."}],"responses":{"200":{"description":"A paginated list of report metadata objects.","content":{"application/json":{"schema":{"type":"object","properties":{"Reports":{"type":"array","description":"The list of report objects.","items":{"$ref":"#/components/schemas/ReportInfo"}}}}}}}}}}}} ``` ## Run a Report Synchronously > Runs a report and returns the data directly in the response.\ > The required filter parameters (like \`SUBAID\`, \`StartDate\`, \`EndDate\`) depend on the specific report being run.\ > Retrieve the report's metadata to see all available filters. ```json {"openapi":"3.1.0","info":{"title":"Brand API - Reports","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."}}},"paths":{"/Advertisers/{AccountSID}/Reports/{ReportId}":{"get":{"summary":"Run a Report Synchronously","description":"Runs a report and returns the data directly in the response.\nThe required filter parameters (like `SUBAID`, `StartDate`, `EndDate`) depend on the specific report being run.\nRetrieve the report's metadata to see all available filters.","operationId":"runReport","tags":["Reports"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"ReportId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier of the report to run."},{"name":"SUBAID","in":"query","schema":{"type":"integer"},"description":"Required for most reports. The ID of the program (campaign) to filter by."},{"name":"StartDate","in":"query","schema":{"type":"string","format":"date"},"description":"Required for most reports. The start of the date range for the report data."},{"name":"EndDate","in":"query","schema":{"type":"string","format":"date"},"description":"Required for most reports. The end of the date range for the report data."}],"responses":{"200":{"description":"A paginated list of report records. The structure of each record depends on the report run.","content":{"application/json":{"schema":{"type":"object","properties":{"Records":{"type":"array","description":"The records from the report.","items":{"type":"object"}}}}}}}}}}}} ``` ## Export a Report Asynchronously > Schedules a job to export a report as a file.\ > Returns URIs to monitor the job's status and download the result. ```json {"openapi":"3.1.0","info":{"title":"Brand API - Reports","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."}}},"paths":{"/Advertisers/{AccountSID}/ReportExport/{ReportId}":{"get":{"summary":"Export a Report Asynchronously","description":"Schedules a job to export a report as a file.\nReturns URIs to monitor the job's status and download the result.","operationId":"exportReport","tags":["Reports"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"ReportId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier of the report to export."},{"name":"SUBAID","in":"query","schema":{"type":"integer"},"description":"Required for most reports. The ID of the program (campaign)."},{"name":"StartDate","in":"query","schema":{"type":"string","format":"date"},"description":"Required for most reports. The start of the date range."},{"name":"EndDate","in":"query","schema":{"type":"string","format":"date"},"description":"Required for most reports. The end of the date range."},{"name":"ResultFormat","in":"query","schema":{"type":"string","enum":["CSV","JSON","XML"],"default":"CSV"}}],"responses":{"200":{"description":"The report export job was successfully queued.","content":{"application/json":{"schema":{"type":"object","properties":{"Status":{"type":"string","description":"Indicates whether the job was queued successfully."},"QueuedUri":{"type":"string","format":"uri-reference","description":"The URI to poll for the job's status."},"ResultUri":{"type":"string","format":"uri-reference","description":"The URI to download the result file once the job completes."}}}}}}}}}}} ``` ## Retrieve Report Metadata > Retrieves the dynamic documentation for a specific API-accessible report, including its available filters and attributes. ```json {"openapi":"3.1.0","info":{"title":"Brand API - Reports","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":{"ReportMetadata":{"type":"object","description":"Dynamic documentation for a specific report, detailing its filters and attributes.","properties":{"Name":{"type":"string","description":"The display name of the report."},"Id":{"type":"string","description":"The unique identifier or handle for the report."},"Description":{"type":"string","description":"A description of what the report contains."},"Filters":{"type":"array","description":"The filter parameters available when running the report.","items":{"$ref":"#/components/schemas/ReportFilter"}},"Attributes":{"type":"array","description":"The attributes (columns) returned by the report.","items":{"$ref":"#/components/schemas/ReportAttribute"}},"RunUri":{"type":"string","format":"uri-reference","description":"The URI to run this report."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this metadata object in the impact.com API."}}},"ReportFilter":{"type":"object","properties":{"Name":{"type":"string","description":"The filter parameter name."},"DataType":{"type":"string","description":"The data type of the filter (e.g., String, Integer, Date)."},"Format":{"type":"string","description":"The expected format of the filter value, if applicable."}}},"ReportAttribute":{"type":"object","properties":{"Name":{"type":"string","description":"The attribute name."},"DataType":{"type":"string","description":"The data type of the attribute."},"Description":{"type":"string","description":"A description of the attribute."}}}}},"paths":{"/Advertisers/{AccountSID}/Reports/{ReportId}/MetaData":{"get":{"summary":"Retrieve Report Metadata","description":"Retrieves the dynamic documentation for a specific API-accessible report, including its available filters and attributes.","operationId":"getReportMetadata","tags":["Reports"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"ReportId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A report metadata object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportMetadata"}}}}}}}}} ``` --- # 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/report-export/reports.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.