Skip to main content
GET
Per-agent usage for a period

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST, PUT, PATCH and DELETE endpoints the Workspace write API scope, and sending or revoking invitations (POST and DELETE /workspaceapi/invites) the Invite members scope. A key stops working when it expires or is disabled.

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.

Response

Success. Empty result sets are also 200.

Per-agent usage for a period: what each agent delivered (key metrics), how much it was used and what it cost. Restricted and personal agents are included, marked with isPrivate.

period
object
required
rows
object[]
required