Teads Developer Portal

All operations use the base URL https://api.teads.tv/v1/analytics and require the bearer token described in Getting started.

Create a report

`POST /custom`

Queues an asynchronous report. The request must include filters.date, dimensions, and metrics. emails and output format are optional.

The response includes:

Field	Description
`id`	Unique report identifier.
`start`	Time the request was registered.
`lastStatusUpdate`	Time of the last backend status update.
`status`	`queued`, `processing`, `error`, `finished`, or `killed`.
`valid`	Whether the request format and content are valid.
`reportProgress`	Current processing step and progress counters.
`url`	Download URL when `status` is `finished`.
`message`	Additional details when `status` is `error`.

Get report status

`GET /custom/{id}`

Returns the status of a report. The response may include reportProgress while the report is queued or processing. When finished, retrieve the result from url.

{
  "id": "abcdefgh-cff2-4753-a08b-ee4587de4e9d",
  "start": "2020-12-14T16:35:05.269Z",
  "lastStatusUpdate": "2020-12-14T16:35:05.269Z",
  "status": "processing",
  "valid": true,
  "reportProgress": {
    "stepMax": 4,
    "step": 1,
    "progress": 1,
    "progressMax": 2
  }
}

Returns 404 when the report identifier cannot be found. See Limits and errors for the full error reference.

List processing reports

`GET /running/list`

Lists reports currently queued or processing:

[
  {
    "id": "abcdefgh-cff2-4753-a08b-ee4587de4e9d",
    "status": "processing",
    "start": "2020-01-28T07:37:55.273Z"
  }
]

Cancel a report

`PUT /custom/{id}/kill`

Cancels a report that is currently queued or processing. A successful response has this shape:

{
  "status": "killed",
  "id": "abcdefgh-cff2-4753-a08b-ee4587de4e9d"
}

An invalid or unknown report can return:

{
  "status": 400,
  "msg": "REPORTING.ERROR.APPLICATION_NOT_FOUND"
}

See Limits and errors for other error codes.

Status lifecycle

queued → processing → finished
                   ↘ error
queued/processing → killed

queued: waiting for processing capacity.
processing: report computation is underway.
finished: result is available at url.
error: processing failed; inspect message.
killed: processing was canceled.

Operations