Skip to content
TAM ReportingReference

Run a one-time report

POST
/api/reports/run

Queue a one-time report from filters, dimensions, and metrics in the JSON body. Rate limit: 1 call / 30 seconds per seat. Counts against the rolling 24-hour run quota. At least one dimension and one metric are required. Poll GET /api/reports/status/{uid} until status is finished, then download the file from uri.

Authorization

TamApiKey
Authorization<token>

TAM API key generated in Teads Ad Manager (Settings → API Keys). Send the raw key. Do not prefix with Bearer.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/reports/run" \  -H "Content-Type: application/json" \  -d '{    "format": "csv",    "filters": {      "date": {        "start": "2024-01-01T00:00:00.000",        "end": "2024-01-31T23:59:59.000",        "timezone": "UTC"      }    },    "dimensions": [      "day",      "advertiser_name"    ],    "metrics": [      "impression"    ]  }'
{  "id": "5f82a2a6-7f6f-4aaa-8bbc-c73d2457d2e9",  "start": "2018-11-13T07:15:00.045Z",  "lastStatusUpdate": "2018-11-13T07:15:00.045Z",  "status": "queued",  "valid": true,  "reportProgress": {    "stepMax": 4  }}