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

# List a session's replay segments

> The session's replay segments in time order (spec 10.2): sequence ranges, keyframes and whether each attachment arrived. Frames are masked on the device (spec 10.3).



## OpenAPI

````yaml /api-reference/openapi.json get /projects/{projectId}/sessions/{sessionId}/replay/segments
openapi: 3.1.0
info:
  title: Apsio API
  version: 0.1.0
  description: >-
    Read API v0: your projects, release health and comparisons, missing symbols,
    issues, sessions, vitals, cohort comparisons, performance (app start,
    screens, hangs, MetricKit) and network endpoints and traces for one project.
    Authenticate with a project token as a bearer token, with an OAuth access
    token from Apsio's authorization server (MCP clients), or, from the console,
    with the session cookie of a member of the project's organization.
servers:
  - url: https://api.apsio.io/v1
security: []
paths:
  /projects/{projectId}/sessions/{sessionId}/replay/segments:
    get:
      summary: List a session's replay segments
      description: >-
        The session's replay segments in time order (spec 10.2): sequence
        ranges, keyframes and whether each attachment arrived. Frames are masked
        on the device (spec 10.3).
      parameters:
        - schema:
            type: string
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            example: 0192f3a4-0000-7000-8000-00000000a101
          required: true
          name: projectId
          in: path
        - schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,128}$
            example: 7f3c9b02-5d1e-4a8b-9c0f-2e6a1d4be19a
          required: true
          name: sessionId
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 200
            description: Page size, 1 to 1000.
            example: 200
          required: false
          description: Page size, 1 to 1000.
          name: limit
          in: query
        - schema:
            type: string
            maxLength: 1024
            description: The `next_cursor` of the previous page. Opaque.
          required: false
          description: The `next_cursor` of the previous page. Opaque.
          name: cursor
          in: query
        - schema:
            type: string
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            description: Only this app.
          required: false
          description: Only this app.
          name: app_id
          in: query
      responses:
        '200':
          description: The segments; empty when the session has no replay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplaySegments'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No valid bearer token or console session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The credentials cannot read this project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
        - session: []
components:
  schemas:
    ReplaySegments:
      type: object
      properties:
        segments:
          type: array
          items:
            $ref: '#/components/schemas/ReplaySegment'
        next_cursor:
          type:
            - string
            - 'null'
          description: Pass as `cursor` to get the next page; null on the last page.
      required:
        - segments
        - next_cursor
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
    ReplaySegment:
      type: object
      properties:
        attachment_id:
          type: string
          description: >-
            apsio.attachment.id: get the frames from
            /projects/{projectId}/attachments/{id}.
        app_id:
          type: string
        start_at:
          type: string
          description: The segment's first frame.
          example: '2026-10-04T10:15:00.431000000Z'
        end_at:
          type:
            - string
            - 'null'
          description: Its last frame; null if the app did not say.
          example: '2026-10-04T10:15:00.431000000Z'
        first_sequence:
          type: integer
        last_sequence:
          type: integer
        keyframe:
          type: boolean
          description: Whether it holds a keyframe (a player starts there).
        stored:
          type: boolean
          description: >-
            Whether the attachment arrived. A player shows a gap for one that
            did not (spec 1.7).
        bytes:
          type: integer
          description: Compressed size of the stored object; 0 if not stored.
      required:
        - attachment_id
        - app_id
        - start_at
        - end_at
        - first_sequence
        - last_sequence
        - keyframe
        - stored
        - bytes
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        A project token (apsio_pt_v0...), which reads exactly one project, or an
        OAuth access token issued for the API, which reads what its user can.
        Access tokens issued for Apsio's MCP server are accepted only from the
        MCP server itself.
    session:
      type: apiKey
      in: cookie
      name: apsio_session
      description: >-
        The console session, set by /v1/auth/callback (`__Host-apsio_session`
        when host-only).

````

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