WIwithchima
Clips

List mouse events on a clip

Changed on

Returns 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 recording's dimensions — the same coordinate space as zoom focus points. Events during cut-out footage are dropped, and move events are sampled (default one per 100ms, intervalMs=0 for every event). Use types=clicks to return only clicks. Returns an empty list when the recording has no mouse data (camera-only clips, uploads, older recorder versions). Pass startTimeMs/endTimeMs to read a long recording in windows; a window returns the same events the whole-clip response has in that range.

get/v1/videos/{id}/clips/{clipId}/mouse-events

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Query parameters

startTimeMsinteger

Only return items at or after this time, in ms on the clip's playback timeline. Defaults to the clip's start.

Example:60000
endTimeMsinteger

Only return items before this time (exclusive), in ms on the clip's playback timeline. Must be greater than startTimeMs. Defaults to the clip's end. Page through a long clip with windows that meet end to start.

Example:120000
intervalMsinteger

Thin move events to at most one per this many ms of playback — clicks are always kept. Defaults to 100. Pass 0 for every recorded event (can be tens of thousands on long recordings).

Example:100
typesstring

Comma-separated event kinds to return: clicks, moves. Default: both. Use types=clicks for the positions where a mouse button went down — one event per press, not one per sample of a held button.

Example:clicks

Response

OK

Example response

{
  "events": [
    {
      "timestampMs": 1000,
      "xPct": 42.5,
      "yPct": 63.1
    }
  ]
}

Changes

  • 704d6fc3bc60Revision changes
    • info

      added the new optional query request parameter endTimeMs

    • info

      added the new optional query request parameter startTimeMs

  • ac47c99c144fRevision changes
    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status