Analytics SDKAnalytics APIAnalytics Atomic

Getmasterkeysvaultsummary

View as Markdown

Single master key KPIs over a calendar window (vault). Requires valid non-nil masterKeyId.

Success data: { "window", "masterKeyId", "summary": { ... } } — summary fields align with daily rollup KPIs (strings from CH).

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

masterKeyIdstringRequiredformat: "uuid"

Master key UUID (cannot be all-zero UUID).

presetenumOptionalDefaults to 30d

Calendar preset when start+end omitted; default 30d.

startstringOptional

YYYY-MM-DD with end.

endstringOptional

YYYY-MM-DD with start.

Response

codeinteger
messagestring
dataany