Skip to main content
GET
List results for an experiment

Authorizations

Authorization
string
header
required

Biscuit-based bearer token. Obtain tokens from the Adaptyv Portal or via the /tokens endpoint. Tokens encode organization membership and role-based capabilities; the API verifies the token's cryptographic signature and authorization claims before processing requests. Use /tokens/attenuate to create restricted tokens for delegation.

Path Parameters

experiment_id
string<uuid>
required

Experiment identifier (UUID)

Query Parameters

limit
integer<int64>

Maximum number of items to return (1-100, default 50).

offset
integer<int64>

Number of items to skip (default 0).

filter
string

Filter expression in s-expression syntax.

Comparison: eq(field,value), neq(field,value), gt(field,value), lt(field,value), gte(field,value), lte(field,value), contains(field,substring)

Range/set: between(field,lo,hi), in(field,v1,v2,...)

Logical: and(expr1,expr2,...), or(expr1,expr2,...), not(expr)

Null checks: is_null(field), is_not_null(field)

JSONB access: at(field,key) — e.g. eq(at(metadata,score),42)

Cast functions: float(expr), int(expr), text(expr), timestamp(expr), date(expr)

Example: and(gte(created_at,2026-01-01),eq(status,draft))

Free-text search term applied to searchable columns.

sort
string

Sort expression. Supports multi-column sort (comma-separated, up to 8), JSONB path access, and type casts.

Three accepted surface forms produce the same ordering:

  • Canonicaldesc(field) / asc(field); also wraps casts and at(...) JSONB path access. Example: asc(date(at(metadata,start_date))).
  • Prefix short form-field (descending), +field or bare field (ascending). GitHub / Stripe / Jira convention. Bare field only; no casts.
  • Suffix short formfield:asc / field:desc. Also bare field.

Examples: -created_at, -created_at,+name, created_at:desc, desc(created_at),asc(name), asc(at(metadata,score)).

Response

Results for the experiment

Paginated list response with offset-based navigation metadata.

All list endpoints return this shape. Use offset and limit query parameters to page through results; total reports how many items match the query across all pages.

count
integer<int64>
required

Number of items in this response.

items
object[]
required

The page of results.

offset
integer<int64>
required

Offset used for this page (mirrors the offset query parameter).

total
integer<int64>
required

Total number of items matching the query (across all pages).