Analytics APIAnalytics SaaS

Getsaasmodels

View as Markdown

Model rollup for the date range (requests, cost USD, token totals).

At most one of agentId, memberId, and departmentId may be set.

Success data: { "period", "models": [...] }

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.

dateTostringRequired

Inclusive end YYYY-MM-DD.

agentIdstringOptionalformat: "uuid"

Optional agent UUID filter; mutually exclusive with the other entity filters.

memberIdstringOptionalformat: "uuid"

Optional member UUID filter; mutually exclusive with the other entity filters.

departmentIdstringOptionalformat: "uuid"

Optional department UUID filter; mutually exclusive with the other entity filters.

Response

codeinteger
messagestring
dataany