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

# Read a video's summary

> The headline numbers for one video over a date range: plays, unique plays, completions, completion rate, average watch time, and bounces. This is the play-to-buyer story in one call.

The response carries `Cache-Control: private, max-age=60` and an `ETag`. Send the `ETag` back as `If-None-Match` and a repeat within the window returns `304 Not Modified` with no body.

Requires a token with the `analytics:read` scope.

Server: `https://app.trackplay.io/api/v1`



## OpenAPI

````yaml /api-reference/openapi.json get /videos/{video}/analytics/summary
openapi: 3.1.0
info:
  title: TrackPlay API
  description: >-
    Send conversions and events to TrackPlay, and read them back. Authenticated
    with scoped tokens you mint in the dashboard.
  version: 1.0.0
servers:
  - url: https://app.trackplay.io/api/v1
    description: App API. Conversions, videos, webhooks.
  - url: https://e.trackplay.io
    description: Events API. High-volume event ingest.
security:
  - bearerAuth: []
paths:
  /videos/{video}/analytics/summary:
    get:
      tags:
        - Analytics
      summary: Read a video's summary
      description: >-
        The headline numbers for one video over a date range: plays, unique
        plays, completions, completion rate, average watch time, and bounces.
        This is the play-to-buyer story in one call.


        The response carries `Cache-Control: private, max-age=60` and an `ETag`.
        Send the `ETag` back as `If-None-Match` and a repeat within the window
        returns `304 Not Modified` with no body.


        Requires a token with the `analytics:read` scope.


        Server: `https://app.trackplay.io/api/v1`
      operationId: getVideoAnalyticsSummary
      parameters:
        - name: video
          in: path
          required: true
          schema:
            type: integer
          description: >-
            The video's numeric ID. It is the `video_id` returned in every
            analytics response.
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            Start of the range, as an ISO date (`YYYY-MM-DD`). Defaults to 30
            days ago.
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date
          description: End of the range, as an ISO date (`YYYY-MM-DD`). Defaults to today.
        - name: tz
          in: query
          required: false
          schema:
            type: string
            default: UTC
          description: >-
            Timezone the range is read in, as an IANA name (`America/New_York`).
            Defaults to `UTC`.
      responses:
        '200':
          description: The summary for the range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsSummaryResponse'
              examples:
                summary:
                  value:
                    video_id: 481
                    video_code: 9f2c1a7e-4d3b-4a11-9e77-0b2c5d8e1f34
                    from: '2026-06-17'
                    to: '2026-07-17'
                    tz: UTC
                    summary:
                      plays: 59627
                      unique_plays: 51204
                      completion_count: 8143
                      completion_rate: 13.7
                      avg_watch_time_s: 214.6
                      bounce_count: 6021
        '304':
          description: >-
            Not modified. The `ETag` you sent as `If-None-Match` still matches,
            so no body is returned.
        '401':
          description: >-
            `AUTH_REQUIRED`: no token sent. `INVALID_TOKEN`: the token is
            invalid, expired, or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`INSUFFICIENT_SCOPE`: the token does not carry `analytics:read`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: No video with that ID exists in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: >-
            Validation failed. A date could not be parsed, or `to` fell before
            `from`.
        '429':
          description: Rate limited. Reads are capped at 600 requests per minute per token.
components:
  schemas:
    AnalyticsSummaryResponse:
      type: object
      properties:
        video_id:
          type: integer
        video_code:
          type: string
        from:
          type: string
          description: The start date the summary was read over.
        to:
          type: string
          description: The end date the summary was read over.
        tz:
          type: string
          description: The timezone the range was read in.
        summary:
          type: object
          properties:
            plays:
              type: integer
              description: Total plays in the range.
            unique_plays:
              type: integer
              description: Plays from distinct viewers.
            completion_count:
              type: integer
              description: Plays that reached the end.
            completion_rate:
              type: number
              description: >-
                Completions as a percent, to one decimal place. `13.7` means
                13.7%.
            avg_watch_time_s:
              type: number
              description: Average watch time in seconds.
            bounce_count:
              type: integer
              description: Plays that left almost immediately.
    ApiError:
      type: object
      description: The error shape the app API returns on a failed read or export.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                A stable error code, e.g. `INSUFFICIENT_SCOPE`,
                `VIDEO_NOT_FOUND`, `EXPORT_NOT_FOUND`.
            message:
              type: string
              description: What went wrong, in plain English.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A scoped token minted in **Settings → API tokens**. Send it as
        `Authorization: Bearer tplt_…` or `X-API-Key: tplt_…`.

````