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

# List mouse events on a clip

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



## OpenAPI

````yaml /openapi.json get /v1/videos/{id}/clips/{clipId}/mouse-events
openapi: 3.0.3
info:
  description: >-
    The Tella Public API allows you to programmatically access your videos and
    playlists, including transcripts, chapters, and thumbnails.


    ## Authentication


    All requests require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer tella_pk_xxxxx...

    ```


    API keys can be generated in your Tella workspace settings.


    ## Rate Limiting


    The API is rate-limited to 100 requests per minute per organization.

    Rate limit information is returned in response headers:

    - `X-RateLimit-Limit`: Maximum requests per window

    - `X-RateLimit-Remaining`: Remaining requests in current window

    - `X-RateLimit-Reset`: Unix timestamp when the window resets
  title: Tella Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.tella.com
security: []
tags:
  - description: Video operations
    name: Videos
  - description: Sections of a video
    name: Clips
  - description: Playlist operations
    name: Playlists
  - description: Sidebar groups for organizing playlists
    name: Playlist Groups
  - description: Tags for categorizing and filtering videos
    name: Tags
  - description: Personal, workspace, and default video backgrounds
    name: Backgrounds
  - description: >-
      Reusable media saved to a workspace, plus Tella's curated sound effect
      catalog — the same items the editor's media panels show
    name: Library
  - description: Webhook endpoint management
    name: Webhooks
paths:
  /v1/videos/{id}/clips/{clipId}/mouse-events:
    get:
      tags:
        - Clips
      summary: List mouse events on a clip
      description: >-
        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).
      operationId: listClipMouseEvents
      parameters:
        - description: Video identifier
          in: path
          name: id
          required: true
          schema:
            description: Video identifier
            example: vid_abc123def456
            type: string
        - description: Clip identifier
          in: path
          name: clipId
          required: true
          schema:
            description: Clip identifier
            example: cl_xyz789ghi012
            type: string
        - description: >-
            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).
          in: query
          name: intervalMs
          schema:
            description: >-
              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
            maximum: 9007199254740991
            minimum: 0
            type: integer
        - description: >-
            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.
          in: query
          name: types
          schema:
            description: >-
              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
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClipMouseEventsResponse'
          description: OK
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '422':
          $ref: '#/components/responses/422ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    ListClipMouseEventsResponse:
      additionalProperties: false
      description: >-
        Mouse events from the clip's screen recording. Empty when the recording
        has no mouse data (camera-only clips, uploads, older recorder versions).
      properties:
        events:
          items:
            $ref: '#/components/schemas/ClipMouseEvent'
          type: array
      required:
        - events
      type: object
    ClipMouseEvent:
      additionalProperties: false
      description: >-
        A cursor position or click recorded with the clip's screen recording,
        mapped onto the clip's playback timeline
      properties:
        clicked:
          description: >-
            True when a mouse button went down at this event. Recordings sample
            the button state continuously, so a drag reports true only on the
            initial press — the samples while the button stays held are returned
            as move events.
          type: boolean
        isLocalEvent:
          description: >-
            True when the event happened inside Tella's own recorder UI (e.g.
            the recording controls) rather than the recorded content
          type: boolean
        timestampMs:
          description: Time in ms on the clip's playback timeline (cuts applied)
          example: 1000
          minimum: 0
          type: number
        xPct:
          description: >-
            Horizontal cursor position as a percentage of the screen recording's
            width (0-100) — the same coordinate space as zoom focus points.
          example: 42.5
          type: number
        yPct:
          description: >-
            Vertical cursor position as a percentage of the screen recording's
            height (0-100)
          example: 63.1
          type: number
      required:
        - timestampMs
        - xPct
        - yPct
        - clicked
        - isLocalEvent
      type: object
    ErrorResponse:
      additionalProperties: false
      description: Standard error response format
      properties:
        error:
          additionalProperties: false
          description: Error details
          properties:
            code:
              description: Machine-readable error code
              enum:
                - bad_request
                - unauthorized
                - forbidden
                - not_found
                - unprocessable_entity
                - rate_limit_exceeded
                - internal_server_error
              example: not_found
              type: string
            doc_url:
              description: Link to documentation for this error
              example: https://tella.tv/docs/api-reference/errors#not-found
              format: uri
              type: string
            message:
              description: Human-readable error message
              example: The requested resource was not found.
              type: string
          required:
            - code
            - message
            - doc_url
          type: object
      required:
        - error
      type: object
  responses:
    400ErrorResponse:
      content:
        application/json:
          example:
            error:
              code: bad_request
              doc_url: https://tella.tv/docs/api-reference/errors#bad-request
              message: The request was malformed or contained invalid parameters.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: The request was malformed or contained invalid parameters.
    401ErrorResponse:
      content:
        application/json:
          example:
            error:
              code: unauthorized
              doc_url: https://tella.tv/docs/api-reference/errors#unauthorized
              message: Authentication is required. Provide a valid API key.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Authentication is required. Provide a valid API key.
    403ErrorResponse:
      content:
        application/json:
          example:
            error:
              code: forbidden
              doc_url: https://tella.tv/docs/api-reference/errors#forbidden
              message: You don't have permission to access this resource.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: You don't have permission to access this resource.
    404ErrorResponse:
      content:
        application/json:
          example:
            error:
              code: not_found
              doc_url: https://tella.tv/docs/api-reference/errors#not-found
              message: The requested resource was not found.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: The requested resource was not found.
    422ErrorResponse:
      content:
        application/json:
          example:
            error:
              code: unprocessable_entity
              doc_url: https://tella.tv/docs/api-reference/errors#unprocessable-entity
              message: The request was well-formed but contained semantic errors.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: The request was well-formed but contained semantic errors.
    429ErrorResponse:
      content:
        application/json:
          example:
            error:
              code: rate_limit_exceeded
              doc_url: https://tella.tv/docs/api-reference/errors#rate-limit-exceeded
              message: You have exceeded the rate limit. Please slow down.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: You have exceeded the rate limit. Please slow down.
    500ErrorResponse:
      content:
        application/json:
          example:
            error:
              code: internal_server_error
              doc_url: https://tella.tv/docs/api-reference/errors#internal-server-error
              message: An unexpected error occurred on the server.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: An unexpected error occurred on the server.
  securitySchemes:
    BearerAuth:
      description: API key obtained from your Tella account settings
      scheme: bearer
      type: http

````

## Related topics

- [Model Context Protocol (MCP)](/docs/mcp-server.md)
- [Auto-generate zooms from mouse activity](/docs/api-reference/clips/auto-generate-zooms-from-mouse-activity.md)
- [Mac App](/docs/changelog/mac-app.md)
- [List webhook endpoints](/docs/api-reference/webhooks/list-webhook-endpoints.md)
- [List recent webhook messages](/docs/api-reference/webhooks/list-recent-webhook-messages.md)
