Skip to main content
GET
Usage-vs-cap reporting (per-user) or account-wide 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

Institution id for the per-user mode.

instanceId
string

Alias for institutionId (forwarded by the usage chart).

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.

Per-user mode response.

success
boolean
capsEnabled
boolean
accountWide
object
perInstitution
object
h24
object
buckets
object[]
totals
object