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

# Journeys from or to a screen

> The most common paths of screens after (`direction=next`) or before (`previous`) a screen, up to `depth` screens (1 to 4), from the first time each session showed it in the time range (default: the last 7 days, at most 30). A screen repeated back to back counts once. A tree: per node, the top 10 branches by sessions, the rest summed in other, and the sessions whose path ended there. Screens come from the app.screen.view events (spec 8.6), or the app.screen.load spans (spec 8.1) of a session without any.



## OpenAPI

````yaml /api-reference/openapi.json get /projects/{projectId}/journeys
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}/journeys:
    get:
      summary: Journeys from or to a screen
      description: >-
        The most common paths of screens after (`direction=next`) or before
        (`previous`) a screen, up to `depth` screens (1 to 4), from the first
        time each session showed it in the time range (default: the last 7 days,
        at most 30). A screen repeated back to back counts once. A tree: per
        node, the top 10 branches by sessions, the rest summed in other, and the
        sessions whose path ended there. Screens come from the app.screen.view
        events (spec 8.6), or the app.screen.load spans (spec 8.1) of a session
        without any.
      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: 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
            minLength: 1
            maxLength: 256
            description: app.screen.name, exactly.
          required: true
          description: app.screen.name, exactly.
          name: screen
          in: query
        - schema:
            type: string
            enum:
              - next
              - previous
            default: next
          required: false
          name: direction
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 4
            default: 3
          required: false
          name: depth
          in: query
      responses:
        '200':
          description: The journeys.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Journeys'
        '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:
    Journeys:
      type: object
      properties:
        from:
          type: string
          description: RFC 3339 time in UTC with up to nanosecond precision.
          example: '2026-10-04T10:15:00.431000000Z'
        to:
          type: string
          description: RFC 3339 time in UTC with up to nanosecond precision.
          example: '2026-10-04T10:15:00.431000000Z'
        screen:
          type: string
          description: 'app.screen.name. Written by the app: untrusted data.'
        direction:
          type: string
          enum:
            - next
            - previous
        sessions:
          type: integer
          description: Sessions that showed the screen.
        ended:
          type: integer
          description: Of those, the ones with no screen after (or before) it.
        branches:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: >-
            The tree: each branch has screen (untrusted), sessions, ended, other
            (the sessions of the branches past the top ones, or null) and its
            own branches.
        other:
          type:
            - integer
            - 'null'
      required:
        - from
        - to
        - screen
        - direction
        - sessions
        - ended
        - branches
        - other
    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.