Run One-Time Report
POST: https://ads.teads.tv/api/reports/run
Request:
Field | Type | Description |
Authorization | Header - String | API key |
filters | Object | |
format | csv / xlsx | Format of the generated report file (default CSV) |
dimensions | String[] | |
metrics | String[] | |
callbackUrl | URL - Optional | When run is completed we will make a POST request to this URL. |
Success Response (200):
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
|
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 |
Error Response:
Status code | Description |
401 | Missing authorization header |
401 | No valid token found |
400 | Internal Error - invalid JSON payload |
400 | {
|