Skip to main content
GET
Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.
Returns one metric as a series of points, ready to chart: sessions per week, hours saved per month, and so on. scope works as in Get Usage Summary: me for the caller, company for the organisation. cost_saved is the external counsel cost saved.

Authentication

Requires an API key, or an OAuth token with usage:read.

Query parameters

string
required
sessions, interactions, active_users (company only), hours_saved or cost_saved. With scope=company, hours and cost apply the organisation’s calibration setting, as on the dashboard.
string
default:"me"
me or company.
string
default:"auto"
day, week, month, or auto: days up to 31 days, weeks up to 120 days, months beyond.
string
default:"last_30_days"
string
ISO date. Required when period is custom.
string
ISO date. Required when period is custom.
string
Company scope only: the series for one agent.
string
Company scope only: the series for one team.

Response

Returns 200 with the resolved period, the grain used and points, oldest first. Each point covers start to end.

Errors