Skip to main content
The cursor path and clicks recorded with the clip’s screen recording, mapped onto the clip’s playback timeline (cuts applied). Positions are percentages of the screen dimensions (0-100) — the same coordinate space as zoom focus points, so an event’s position can be used directly as a focusPoint.
All times are milliseconds on the clip’s playback timeline — the video as watched, with cuts applied. It is the same timeline as get_transcript, thumbnails, and previews, so nothing needs converting. A start at or past the end of the clip is rejected with a 400.

​
get_mouse_events

Get the mouse events from the clip’s screen recording. Move events are sampled (clicks are always kept); events during cut-out footage are dropped. Returns an empty list when the recording has no mouse data (camera-only clips, uploads, older recorder versions). For a long clip, pass startTimeMs and endTimeMs to read events in windows. Adjacent windows don’t repeat events, and each window returns the same events as that range of the whole-clip response — move sampling does not restart at the window boundary. Omit both to get the whole clip.
​
string
required
Video ID
​
string
required
Clip ID
​
integer
First time to include, in ms on the clip’s playback timeline (default: clip start). Must be at least 0.
​
integer
First time to exclude, in ms on the clip’s playback timeline (default: clip end). Must be greater than startTimeMs.
​
integer
Sampling interval for move events in ms (default 100). Pass 0 for every recorded event — can be tens of thousands on long recordings.
​
enum<string>[]
Event kinds to return — clicks, moves. Default: both. Use ["clicks"] for click positions only.
Last modified on September 29, 2026