Skip to main content
GET
Get runs

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Query Parameters

ids
string[]

Filter by run IDs

productIds
string[]

Filter by product IDs

versionIds
string[]

Filter by version IDs

customIds
string[]

Filter by the caller-supplied run labels

statuses
enum<string>[]

Filter by run statuses

Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELLED
sort
string[]

Sort instructions (field and direction pairs)

fromCreatedAt
string<date-time>

Filter runs created at or after this timestamp (ISO 8601 format)

toCreatedAt
string<date-time>

Filter runs created at or before this timestamp (ISO 8601 format)

limit
integer
default:10000

Maximum number of results

Required range: 0 <= x <= 9007199254740991
offset
integer
default:0

Number of results to skip

Required range: x >= 0

Response

Runs retrieved successfully

id
string
required
Example:

"run_123"

productId
string
required
Example:

"product_123"

versionId
string | null
required
Example:

"version_123"

userId
string | null
required
Example:

"user_123"

ordinal
integer
required

Per-product launch number, starting at 1 and never reused

Example:

42

customId
string | null
required

Caller-supplied label

Example:

"nightly-regression"

relaunchedFromRunId
string | null
required

The run this one repeats, when POST /runs/{id}/relaunch minted it

Example:

"run_122"

openedBy
enum<string>
required

LAUNCH when a launch endpoint opened the run, which then closes when its last launch ends. CALLER when POST /runs opened it, which only POST /runs/{id}/close ends.

Available options:
LAUNCH,
CALLER
Example:

"LAUNCH"

status
enum<string>
required
Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELLED
Example:

"COMPLETED"

evaluationCount
integer
required

Evaluations this run launched

Example:

120

sessionCount
integer
required

Distinct sessions covered by the evaluations of this run

Example:

30

finishedAt
string<date-time> | null
required
deletedAt
string<date-time> | null
required
createdAt
string<date-time>
launches
object[]

The launches the platform performed inside this run, oldest first. Single-run reads only.