Skip to main content
Read viewing analytics for a single video or across the workspace, and list who watched a video, a playlist’s videos, or the workspace’s videos. 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. Without a Premium plan it is required and must be within the last 30 days.
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. Without a Premium plan it is required and must be within the last 30 days.
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

list_video_views

Who watched one video, newest first, one row per play: the viewer, when they started, how far they got (percentViewed), watchTimeSeconds, device, location and referrer. viewer has the userId and name of a viewer who was signed in, and an email when they are in your workspace or gave it to the video’s email gate; it is null for anonymous viewers. Available for the same videos as get_video_analytics. Pass pagination.nextCursor as cursor for the next page.
string
required
Video ID
string
First day of the range, inclusive, as YYYY-MM-DD in UTC. Without a Premium plan it is required and must be within the last 30 days.
string
Last day of the range, inclusive, as YYYY-MM-DD in UTC
integer
Views per page (1-100, default: 20)
string
Pagination cursor from the previous response

list_playlist_views

Who watched a playlist’s videos, newest first, with the same fields as list_video_views plus the video each play was of. Only for playlists you can add videos to.
string
required
Playlist ID
string
First day of the range, inclusive, as YYYY-MM-DD in UTC. Without a Premium plan it is required and must be within the last 30 days.
string
Last day of the range, inclusive, as YYYY-MM-DD in UTC
integer
Views per page (1-100, default: 20)
string
Pagination cursor from the previous response

list_workspace_views

Who watched across videos, newest first: by default every video shared with the workspace, or with scope: "mine" only the videos you created, the same videos get_workspace_analytics covers. Each play has the same fields as list_video_views plus the video it was of.
enum<string>
workspace (default) or mine
string
First day of the range, inclusive, as YYYY-MM-DD in UTC. Without a Premium plan it is required and must be within the last 30 days.
string
Last day of the range, inclusive, as YYYY-MM-DD in UTC
integer
Views per page (1-100, default: 20)
string
Pagination cursor from the previous response
Last modified on November 9, 2026