Skip to main content
GET
Get an agent's key metrics

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST endpoints the Workspace write API scope.

Path Parameters

agentId
string
required

The agent id.

Query Parameters

days
integer

Lookback in days ending at endDate. Default 30. Ignored when startDate is given.

Required range: 1 <= x <= 365
startDate
string

ISO timestamp for a fixed period instead of a lookback.

endDate
string

ISO timestamp. Default now.

recentLimit
integer

Recent records to include per metric (ref, note, value, when). Default 0.

Required range: 0 <= x <= 500

Response

Success. Empty result sets are also 200.

Key metrics for one agent over a period, in the agent's definition order.

agentId
string
required
agentName
string
required
period
object
required
metrics
object[]
required