Analytics SDKAnalytics APIAnalytics SaaS

Getsaasoverview

View as Markdown

High-level KPIs for the period (totals, success rate, active agents/members, top model).

Success data: period, totalRequests, totalCost, token fields, avgLatency, successRate, activeAgents, activeMembers, topModel.

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

presetenumOptional

Calendar preset. When present it takes precedence over dateFrom and dateTo; otherwise both date parameters are required.

dateFromstringOptional

Inclusive start YYYY-MM-DD.

dateTostringOptional

Inclusive end YYYY-MM-DD.

Response

codeinteger
messagestring
dataany