Skip to main content
GET
Requires version 2.0.1 or later of the Archetype platform.

Overview

This endpoint returns a cursor-paginated page of the sessions of every project you can see, newest first by default. Narrow it to one project with project_id, to one deployment with deployment_id, to the deployments of one package with package_id, to one status, and to one kind. Choose a different ordering with sort and order. Sessions with no start or no duration come last in either direction. Under status, running sessions come first in either direction. Each group is ordered by when the session was opened.

Request

integer
default:"100"
Page size. Minimum 1, maximum 1000.
string
Forward cursor: return the sessions ranked after it in the current sort order. Pass the next_cursor of the previous page. The cursor is opaque: never build it from session fields. Mutually exclusive with before.
string
Backward cursor: return the sessions ranked before it in the current sort order. Pass the prev_cursor of the current page. The cursor is opaque: never build it from session fields. Mutually exclusive with after.
string
Filter by project. Omitted: the sessions of every project you can see. A project’s prj_ id: that project’s sessions only (404 when it does not exist or you cannot see it).
string
Only the sessions of this deployment (dpl_ id).
string
Only the sessions of this package’s deployments (pkg_ id). v2.0.1+
string
Only sessions in this status: pending, running, completed, failed, or cancelled.
string
Only sessions of this kind, which is their deployment’s: batch or serving. v2.0.1+
string
default:"created_at"
Sort field: created_at (default) by when the session was opened, started_at by when it started running, duration by how long it ran, or status to put running sessions ahead of every other. A cursor is only valid under the sort it was minted for. Replaying it with a different sort returns 400. v2.0.1+
string
default:"desc"
Sort direction: asc or desc (default). Keep it constant while paging with a cursor. v2.0.1+
boolean
default:"false"
When true, the response includes total. Off by default because it costs an extra count per request. v2.0.1+

Response

array
required
The page, in the requested sort and order (by default newest first) in both cursor directions. Each entry is a session, with the same fields as Get Session returns.
boolean
required
True when more results exist beyond this page in the direction of travel.
string
Cursor for the next page in the same direction. Pass it as after when paging forward, or as before when you supplied before. null when has_more is false.
string
Cursor to step back the way this page was reached. Pass it as before after paging forward, or as after after paging backward. null on a request that carried no cursor.
integer
How many sessions match the request’s filters across all pages, ignoring limit and the cursor. Present only when you set include_total=true. v2.0.1+

Important Notes

  • Passing both after and before returns 400, as does a malformed cursor, a cursor minted under another sort, or an invalid project_id, deployment_id, package_id, status, kind, sort, or order.
  • A project_id that does not exist or that you cannot see returns 404.