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"

metric
string
required

A metric id, e.g. went_wrong.

Pattern: ^[a-z0-9_]+$

Query Parameters

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
from
string

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

to
string

ISO end.

groupBy
string

With group: only the calls of one series group.

group
string

The group's key.

part
string

Only one part of the metric.

limit
integer

Accepted for symmetry with the other lists; every group holds up to 200 calls.

Required range: 1 <= x <= 200
cursor
string

Accepted for symmetry; the drill-down is not paged.

Response

The calls.

The drill-down's groups and calls.

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