Analytics SDKAnalytics APIAnalytics Atomic

Getusagetimeseries

View as Markdown
Time series for one metric; buckets are **days** or **hours**. **Required:** `metric`. **Optional:** `granularity` (`day` default, or `hour`), plus date window (see query params). **Constraint:** `granularity=hour` does **not** support `success_rate` or `latency` → HTTP 400 / `40010`. **Success `data`:** `{ "granularity", "metric", "window", "points": [{ "bucket", "value" }] }`

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

metricenumRequired

One of cost, requests, tokens, avg_cost_per_req, success_rate, latency.

granularitystringOptionalDefaults to day

hour selects hourly buckets; omitted or any other value selects day.

presetenumOptionalDefaults to 30d

Same allowed values as usage summary; default 30d when no explicit start and end.

startstringOptional

YYYY-MM-DD, paired with end.

endstringOptional

YYYY-MM-DD, paired with start.

Response

codeinteger
messagestring
dataany