Skip to main content
GET
Usage-vs-cap reporting for one person, or an account's at-limit counts.

Authorizations

Authorization
string
header
required

JWT token passed in authorization header

Query Parameters

userId
string

Target user id (per-user mode; requires institutionId/instanceId).

institutionId
string

Digital Twin id for the per-user mode.

instanceId
string

Alias for institutionId.

window
integer
default:30

Over-time window in days (per-user mode).

accountId
string

Account id (account-wide at-limit mode).

Response

Usage-vs-cap or at-limit summary (success, then either the per-user gauges capsEnabled, accountWide, perInstitution, h24, buckets, totals, or the account counts capsEnabled, atLimit.perInstitution, atLimit.accountWide).