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

# Playback heat-map



## OpenAPI

````yaml api-reference/openapi.yaml GET /distributions/{id}/heatmap
openapi: 3.1.0
info:
  title: TrailerCast Integration API
  version: 1.0.0
  summary: >-
    Read-only access to call summaries, prospect engagement and Decision Room
    metrics, plus signed webhooks.
  description: >
    Read-only, workspace-scoped API for pulling the deal signals TrailerCast
    captures during a sale,

    and outbound webhooks for near-real-time notification. Start with the guides
    in this section (Introduction, Quickstart, Authentication, Webhooks); the
    endpoint pages below are generated from this spec.


    **Authentication.** Data endpoints take an API key: `Authorization: Bearer
    tck_live_…`.

    Management endpoints take an admin session JWT with the `integrations.crm`
    permission.


    **Pagination.** Every list is keyset-paginated and ascending: `{ data,
    nextCursor, hasMore }`.

    Pass `cursor=<nextCursor>` to continue. `limit` 1–500, default 100.


    **Rate limit.** 300 requests/minute per API key; `429` with `Retry-After`
    when exceeded.


    **Versioning.** Breaking changes ship as a new path (`/api/v2`). Additive
    changes (new fields,

    event types, parameters) may ship at any time; ignore what you do not
    recognise.
  contact:
    name: TrailerCast
    url: https://trailercast.io
servers:
  - url: https://{host}/api/v1
    variables:
      host:
        default: trailercst-backend-production.up.railway.app
        description: Your TrailerCast API host.
  - url: http://localhost:5000/api/v1
    description: Local development
security:
  - apiKey: []
tags:
  - name: Status
  - name: Calls
  - name: Engagement
  - name: Decision Rooms
  - name: Webhook deliveries
  - name: Management — API keys
  - name: Management — Webhooks
paths:
  /distributions/{id}/heatmap:
    get:
      tags:
        - Engagement
      summary: Playback heat-map and drop-off for one share link
      operationId: getHeatmap
      parameters:
        - $ref: '#/components/parameters/uuidId'
      responses:
        '200':
          description: The heat-map
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Heatmap'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    uuidId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    Heatmap:
      type: object
      properties:
        distributionId:
          type: string
          format: uuid
        demoId:
          type:
            - string
            - 'null'
          format: uuid
        durationSeconds:
          type:
            - integer
            - 'null'
        bucketSeconds:
          type:
            - number
            - 'null'
        sessions:
          type: integer
        buckets:
          type: array
          items:
            type: object
            properties:
              index:
                type: integer
              startSeconds:
                type: number
              endSeconds:
                type: number
              sessions:
                type: integer
                description: Distinct playback sessions covering this slice.
              replays:
                type: integer
                description: Additional passes over this slice.
        dropOff:
          type: array
          description: Largest falls in session count, worst first (max 5).
          items:
            type: object
            properties:
              atSeconds:
                type: number
              sessionsLost:
                type: integer
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable; not stable.
        code:
          type: string
          description: Stable machine code.
  responses:
    NotFound:
      description: >-
        Not found — or belongs to another workspace (indistinguishable by
        design)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not found
            code: NOT_FOUND
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: tck_live_…
      description: Workspace API key minted via POST /api-keys. Read-only.

````