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

# Search sessions

> Sessions that started in the time range (default: the last 7 days, at most 30), newest first, filtered by app, release, outcome, device model, OS version, errors or issue. Open one with the session timeline.



## OpenAPI

````yaml /api-reference/openapi.json get /projects/{projectId}/sessions
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:
    get:
      summary: Search sessions
      description: >-
        Sessions that started in the time range (default: the last 7 days, at
        most 30), newest first, filtered by app, release, outcome, device model,
        OS version, errors or issue. Open one with the session timeline.
      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
            format: date-time
            description: >-
              Start of the time range, inclusive (RFC 3339). Defaults to the
              range end minus the default length.
            example: '2026-10-01T00:00:00Z'
          required: false
          description: >-
            Start of the time range, inclusive (RFC 3339). Defaults to the range
            end minus the default length.
          name: from
          in: query
        - schema:
            type: string
            format: date-time
            description: End of the time range, exclusive (RFC 3339). Defaults to now.
            example: '2026-10-08T00:00:00Z'
          required: false
          description: End of the time range, exclusive (RFC 3339). Defaults to now.
          name: to
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
            description: Page size, 1 to 200.
            example: 50
          required: false
          description: Page size, 1 to 200.
          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
        - schema:
            type: string
            maxLength: 128
            description: Only this release.
          required: false
          description: Only this release.
          name: release
          in: query
        - schema:
            type: string
            enum:
              - crashed
              - abnormal_exit
              - ok
            description: >-
              `crashed`, `abnormal_exit`, or `ok` (every session that neither
              crashed nor ended abnormally).
          required: false
          description: >-
            `crashed`, `abnormal_exit`, or `ok` (every session that neither
            crashed nor ended abnormally).
          name: outcome
          in: query
        - schema:
            type: string
            maxLength: 128
            description: device.model.identifier, exactly.
            example: iPhone17,1
          required: false
          description: device.model.identifier, exactly.
          name: device_model
          in: query
        - schema:
            type: string
            maxLength: 64
            description: os.version, exactly.
          required: false
          description: os.version, exactly.
          name: os_version
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: Only sessions with (true) or without (false) handled errors.
          required: false
          description: Only sessions with (true) or without (false) handled errors.
          name: has_error
          in: query
        - schema:
            type: string
            pattern: ^[A-Za-z0-9._:-]{1,128}$
            description: Only sessions with an occurrence of this issue in the time range.
          required: false
          description: Only sessions with an occurrence of this issue in the time range.
          name: issue_id
          in: query
        - schema:
            type: string
            pattern: ^[A-Z_]{1,16}$
            description: 'With endpoint_host and endpoint_template: one network endpoint.'
          required: false
          description: 'With endpoint_host and endpoint_template: one network endpoint.'
          name: endpoint_method
          in: query
        - schema:
            type: string
            maxLength: 255
          required: false
          name: endpoint_host
          in: query
        - schema:
            type: string
            maxLength: 256
            description: >-
              Only sessions with a request to this endpoint in the time range
              (/network/endpoints lists them).
          required: false
          description: >-
            Only sessions with a request to this endpoint in the time range
            (/network/endpoints lists them).
          name: endpoint_template
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: >-
              With the endpoint: only sessions where a request to it failed (5xx
              or no response).
          required: false
          description: >-
            With the endpoint: only sessions where a request to it failed (5xx
            or no response).
          name: endpoint_failed
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 256
            description: >-
              Only sessions that loaded this screen (app.screen.name) in the
              time range.
          required: false
          description: >-
            Only sessions that loaded this screen (app.screen.name) in the time
            range.
          name: screen
          in: query
        - schema:
            type:
              - integer
              - 'null'
            minimum: 0
            maximum: 600000
            description: >-
              With screen: only loads of it with a TTID of at least this many
              milliseconds.
          required: false
          description: >-
            With screen: only loads of it with a TTID of at least this many
            milliseconds.
          name: min_ttid_ms
          in: query
      responses:
        '200':
          description: A page of sessions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessions:
                    type: array
                    items:
                      $ref: '#/components/schemas/SessionListItem'
                  next_cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Pass as `cursor` to get the next page; null on the last
                      page.
                required:
                  - sessions
                  - next_cursor
        '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:
    SessionListItem:
      type: object
      properties:
        session_id:
          type: string
          description: 'session.id, as the app sent it. Written by the app: untrusted data.'
        app_id:
          type: string
        outcome:
          type: string
          description: >-
            active, exited, crashed or abnormal_exit, as last reported (spec
            3.4).
        started_at:
          type: string
          description: RFC 3339 time in UTC with up to nanosecond precision.
          example: '2026-10-04T10:15:00.431000000Z'
        last_seen_at:
          type: string
          description: RFC 3339 time in UTC with up to nanosecond precision.
          example: '2026-10-04T10:15:00.431000000Z'
        error_count:
          type: integer
        release:
          type: string
          description: 'service.version. Written by the app: untrusted data.'
        build:
          type: string
          description: 'app.build_id. Written by the app: untrusted data.'
        os_name:
          type: string
          description: 'os.name. Written by the app: untrusted data.'
        os_version:
          type: string
          description: 'os.version. Written by the app: untrusted data.'
        device_model:
          type: string
          description: 'device.model.identifier. Written by the app: untrusted data.'
        country:
          type: string
        installation_id:
          type: string
          description: 'app.installation.id. Written by the app: untrusted data.'
      required:
        - session_id
        - app_id
        - outcome
        - started_at
        - last_seen_at
        - error_count
        - release
        - build
        - os_name
        - os_version
        - device_model
        - country
        - installation_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  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.