Skip to main content
GET
Read a video's retention curve

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.

Query Parameters

from
string<date>

Start of the range, as an ISO date. Defaults to 30 days ago.

to
string<date>

End of the range, as an ISO date. Defaults to today.

tz
string
default:UTC

Timezone the range is read in, as an IANA name. Defaults to UTC.

buckets
integer
default:100

How many points to divide the video into. Defaults to 100. Capped at 200.

Required range: x <= 200

Response

The retention curve.

video_id
integer
buckets
object[]

One entry per point through the video, in order.