Skip to main content
Read viewing analytics for a single video or across the workspace. Metrics count plays (a viewer starting the video), unique viewer sessions, watch time, and how much of the video was watched, broken down by day, position in the video, country, referring domain, and UTM parameters. Dates are whole UTC days; omit both to get all time.

​
get_video_analytics

Viewing analytics for one video: summary, plays per day, retention per one-percent slice, geography, referrers, UTM traffic sources, and call-to-action clicks. Available for videos you created, collaborate on, or that are shared with your workspace.
​
string
required
Video ID
​
string
First day of the range, inclusive, as YYYY-MM-DD in UTC
​
string
Last day of the range, inclusive, as YYYY-MM-DD in UTC
​
string
IANA time zone used to bucket viewsOverTime into days (default: UTC)

​
get_workspace_analytics

Viewing analytics aggregated across videos: by default every video shared with the workspace, or with scope: "mine" only the videos you created. Returns the summary, plays per day, retention, geography and referrer breakdowns, plus topVideos ranked by plays. Only topVideos is paginated — pass pagination.nextCursor as cursor for the next page.
​
enum<string>
workspace (default) or mine
​
string
First day of the range, inclusive, as YYYY-MM-DD in UTC
​
string
Last day of the range, inclusive, as YYYY-MM-DD in UTC
​
string
IANA time zone used to bucket viewsOverTime into days (default: UTC)
​
integer
Top videos per page (1-100, default: 20)
​
string
Pagination cursor from the previous response