Skip to main content
GET
Journeys from or to a screen

Authorizations

Authorization
string
header
required

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.

Path Parameters

projectId
string
required
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"

Query Parameters

from
string<date-time>

Start of the time range, inclusive (RFC 3339). Defaults to the range end minus the default length.

Example:

"2026-10-01T00:00:00Z"

to
string<date-time>

End of the time range, exclusive (RFC 3339). Defaults to now.

Example:

"2026-10-08T00:00:00Z"

app_id
string

Only this app.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
release
string

Only this release.

Maximum string length: 128
screen
string
required

app.screen.name, exactly.

Required string length: 1 - 256
direction
enum<string>
default:next
Available options:
next,
previous
depth
integer
default:3
Required range: 1 <= x <= 4

Response

The journeys.

from
string
required

RFC 3339 time in UTC with up to nanosecond precision.

Example:

"2026-10-04T10:15:00.431000000Z"

to
string
required

RFC 3339 time in UTC with up to nanosecond precision.

Example:

"2026-10-04T10:15:00.431000000Z"

screen
string
required

app.screen.name. Written by the app: untrusted data.

direction
enum<string>
required
Available options:
next,
previous
sessions
integer
required

Sessions that showed the screen.

ended
integer
required

Of those, the ones with no screen after (or before) it.

branches
object[]
required

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
integer | null
required