Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

An API key (sig_...), or a session token from the web app.

Path Parameters

agentId
string<uuid>
required

The agent's id.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

Query Parameters

metrics
string

Metric ids, comma separated.

range
enum<string>

A preset range. Default: the board's (30d, or all calls when the agent has fewer than 14 days).

Available options:
24h,
7d,
14d,
30d,
90d,
all
groupBy
string

Split by this dimension: version, outcome, use_case.

from
string

ISO start; with to, a custom range instead of a preset.

to
string

ISO end.

sinceVersion
integer | null

Start the range at this version's first call.

Required range: x >= 0

Response

The series.

The board's series, verdicts and range.

object
enum<string>
required
Available options:
metrics
{key}
any