Skip to main content
GET
List and search test cases

Authorizations

Authorization
string
header
required

An org-scoped API key, sent as Authorization: Bearer <key>. Existing v1 tokens work here unchanged. There is no enqueue-only or read/write scope: an org key authorized for merge-queue writes can invoke every merge-queue mutation, including changing merge-protection configuration and pausing, draining or deleting a queue.

Query Parameters

limit
integer
default:25

Page size, between 1 and 100.

Required range: 1 <= x <= 100
Example:

25

cursor
string

Opaque cursor from a previous response's nextCursor. A cursor is bound to the operation and filter it was minted for.

Example:

"AQEKZm9vYmFy"

includeTotal
boolean
default:false

Set true to include total in the response. Costs an extra COUNT query, so it is off by default.

Example:

false

testCollectionId
string

Narrow to one collection, by its id. Omitted searches every collection in your organization.

Minimum string length: 1
Example:

"aB3xY9kQ"

status
string

Comma-separated statuses to include: healthy, flaky, broken.

Minimum string length: 1
Example:

"flaky,broken"

q
string

Free-text search, with optional file: / class: / parent: / name: qualifiers.

Minimum string length: 1
Example:

"file:checkout flaky"

file
string

Substring match on the test's file path.

Minimum string length: 1
Example:

"src/payments"

owner
string

Exact match on one of the test's code owners.

Minimum string length: 1
Example:

"@acme/platform"

variant
string

Exact match on the test's variant.

Minimum string length: 1
Example:

"ubuntu-22.04"

include
enum<string>

Set to metrics to embed each test's metrics for period in the same response, instead of fetching them per test.

Available options:
metrics
Example:

"metrics"

label
string

Only tests carrying this label, by name. Matched exactly, including case, since two labels may differ only in case. An unknown name returns an empty page, not an error.

Minimum string length: 1
Example:

"slow-on-prs"

quarantineState
enum<string>

Filter on effective quarantine state, derived from the test's status, its collection's quarantine settings and any per-test override.

Available options:
quarantined,
notQuarantined
Example:

"quarantined"

markedFlaky
boolean

Filter on whether the manual 'flag as flaky' mark is currently set.

Example:

true

newlyFlaky
boolean

Only tests that first became flaky inside period. Requires period.

Example:

true

period
enum<string>

Metrics window for include=metrics, any metric sort, and newlyFlaky. Required by each of them.

Available options:
1d,
7d,
14d,
30d
Example:

"7d"

sort
enum<string>
default:name

Field to sort by. A metric sort requires period, and excludes tests with no comparable value in it — no runs at all for most metrics, and additionally no failure for lastFailureAt.

Available options:
name,
failureRate,
durationP95,
prsImpacted,
lastRunAt,
lastFailureAt
direction
enum<string>

Sort direction. Defaults per sort: ascending for name, descending for every metric sort, which order worst-first.

Available options:
asc,
desc

Response

A page of test cases

data
object[]
required
Maximum array length: 100
nextCursor
string | null
required

Opaque cursor for the next page, or null on the last page. Pass it back verbatim as cursor; do not construct or inspect one.

Example:

"AQEKZm9vYmFy"

hasMore
boolean
required

True when another page is available.

Example:

true

total
integer

Total rows matching the filter. Present only when the request set includeTotal=true.

Example:

1247