Analytics SDKAnalytics APIAnalytics Atomic

Gettodayhourly

View as Markdown
Today's dashboard, bucketed by hour in the requested timezone offset. **Query:** `timeZoneDifference` or `timezoneDifference`, numeric minute offset; defaults to 0 when missing or invalid. **Success `data`:** `hours`, `dailySpendUsd`, `projectedSpendUsd`, `vsYesterday`, `topAgents`, `topMembers`, and `topDepartments`.

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

timeZoneDifferencedoubleOptionalDefaults to 0
Timezone offset in minutes used by the server's today window.
timezoneDifferencedoubleOptionalDefaults to 0

Alias for timeZoneDifference.

Response

codeinteger
messagestring
dataany