> ## Documentation Index
> Fetch the complete documentation index at: https://www.tella.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Mouse events

> Read the cursor path and clicks recorded with a screen recording.

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`.

<Note>
  **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`.
</Note>

## 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.

<ParamField path="videoId" type="string" required>
  Video ID
</ParamField>

<ParamField path="clipId" type="string" required>
  Clip ID
</ParamField>

<ParamField path="startTimeMs" type="integer">
  First time to include, in ms on the clip's playback timeline (default: clip start). Must be at least 0.
</ParamField>

<ParamField path="endTimeMs" type="integer">
  First time to exclude, in ms on the clip's playback timeline (default: clip end). Must be greater than `startTimeMs`.
</ParamField>

<ParamField path="intervalMs" type="integer">
  Sampling interval for move events in ms (default 100). Pass 0 for every recorded event — can be tens of thousands on long recordings.
</ParamField>

<ParamField path="types" type="enum<string>[]">
  Event kinds to return — `clicks`, `moves`. Default: both. Use `["clicks"]` for click positions only.
</ParamField>


## Related topics

- [List mouse events on a clip](/docs/api-reference/clips/list-mouse-events-on-a-clip.md)
- [Mac App](/docs/changelog/mac-app.md)
- [Model Context Protocol (MCP)](/docs/mcp-server.md)
- [Product Changelog](/docs/changelog.md)
- [Auto-generate zooms from mouse activity](/docs/api-reference/clips/auto-generate-zooms-from-mouse-activity.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.