Skip to navigation
Analytics APIAnalytics SaaS

Getsaasmasterkeysvault

View as Markdown

Vault-style breakdown for one master key over the period (summary + member/agent lists).

Requires valid non-nil masterKeyId. Success data: period, masterKeyId, limit, summary, members, agents.

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.

masterKeyIdstringRequiredformat: "uuid"

Master key UUID (cannot be all-zero).

limitintegerOptional1-200Defaults to 50

List cap for member/agent sections (default 50, max 200).

Response

This endpoint returns an object.
codeinteger
messagestring
dataany