Skip to navigation
Analytics APIAnalytics SaaS

Getsaasusage

View as Markdown

Daily usage series for the workspace over dateFrom–dateTo (inclusive calendar days).

At most one of agentId, memberId, departmentId may be set → 40020 if more than one.

Success data: { "period", "series": [{ "date", "requests", "cost", "tokens" }] } — cost is USD float from storage units.

Authentication

AuthorizationBearer
Bearer credential containing a JWT, Virtual Key, or PAT.

Headers

X-Workspace-IdstringOptionalformat: "uuid"

Required for a normal JWT, Virtual Key, or PAT. A JWT may instead send X-Openmodel-User-Id. Not used by the public health endpoint.

X-Openmodel-User-IdstringOptionalformat: "uuid"

JWT-only alternative to X-Workspace-Id. Must be a UUID equal to the JWT subject; the server uses it as the workspace id. Not valid as the sole workspace header for Virtual Key or PAT authentication.

Query parameters

dateFromstringRequired

Inclusive start YYYY-MM-DD (UTC calendar).

dateTostringRequired

Inclusive end YYYY-MM-DD.

agentIdstringOptionalformat: "uuid"
Optional agent UUID filter.
memberIdstringOptionalformat: "uuid"

Optional member/user UUID filter.

departmentIdstringOptionalformat: "uuid"
Optional department UUID filter.

Response

This endpoint returns an object.
codeinteger
messagestring
dataany