API - Get Status of Running Report

This article guides you on how to get the status of a running report

Updated over a week ago

Get Status of Running Report

GET: https://ads.teads.tv/api/reports/status/:uid

Request:

Field

Type

Description

Authorization

Header - String

API key

Success Response (200):

Field

Type

Description

id

UUID

ID of the run

start

ISO8601

Timestamp when the report request was registered in Teads backend

lastStatusUpdate

ISO8601

Timestamp 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)

uri

URL

URL to the CSV file containing the results.

Only present if the report status is finished.

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

Did this answer your question?