API - Run One-Time Report | Teads Ad Manager Help Center

POST: https://ads.teads.tv/api/reports/run

Field	Type	Description
Authorization	Header - String	API key
filters	Object	Filters for the report
format	csv / xlsx	Format of the generated report file (default CSV)
dimensions	String[]	Dimensions for the report
metrics	String[]	Metrics for the report
callbackUrl	URL - Optional	When run is completed we will make a POST request to this URL. The payload will contain the "uri" key which has a link to download the CSV file containing the results of the run. {"reportUid": "", "uri":"http://..."}

Field	Type	Description
id	UUID	ID of the run
start	ISO8601	Date when the report request was registered in Teads backend
lastStatusUpdate	ISO8601	Date of the last internal status update in Teads backend
status	String	Status of the run queued (Teads platform has put the report in the queue to be processed, this stage may vary depending on our resources availability) processing (The report is now being computed) error (An issue prevented the report from being computed, please look at message field for more details) finished (The report is now finished, you can download the result at url field)
valid	Boolean	True if the format and content report request is valid and is being process
reportProgress	Object	Object containing report progress
reportProgress.stepMax	Number	Number of steps to finish report
reportProgress.step	Number	Current step in the report
reportProgress.progressMax	Number	Max progress to finish step
reportProgress.progress	Number	Current progress in the step

Status code	Description
401	Missing authorization header
401	No valid token found
400	Internal Error - invalid JSON payload
400	{ "error": { "message": "Error message", "details": [] } } Possible error messages: Required parameters not found. At least one dimension and one metric need to be selected Status 429: User X reached its Api quota CURRENT_QUOTAS / TOTAL learn more