Skip to main content
GET
Read a video's summary

Authorizations

Authorization
string
header
required

A scoped token minted in Settings → API tokens. Send it as Authorization: Bearer tplt_… or X-API-Key: tplt_….

Path Parameters

video
integer
required

The video's numeric ID. It is the video_id returned in every analytics response.

Query Parameters

from
string<date>

Start of the range, as an ISO date (YYYY-MM-DD). Defaults to 30 days ago.

to
string<date>

End of the range, as an ISO date (YYYY-MM-DD). Defaults to today.

tz
string
default:UTC

Timezone the range is read in, as an IANA name (America/New_York). Defaults to UTC.

Response

The summary for the range.

video_id
integer
video_code
string
from
string

The start date the summary was read over.

to
string

The end date the summary was read over.

tz
string

The timezone the range was read in.

summary
object