GetUsageHeatmapResponse
Response from `GET /v1/usage/heatmap` with validation density by weekday and hour.
Properties
| Field | Type | Description |
|---|---|---|
data | object | Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`). |
type | string | JSON:API resource type. Always `usage_heatmap`. |
attributes | object | Heatmap data: the window in days, the maximum value, and the cells. |
days | integer | Heatmap window in days (typically 30 or 90). |
max_count | integer | Maximum `count` value across all cells; useful for scaling color intensity when rendering. |
buckets | array | Map cells; each entry is a (`day_of_week`, `hour_of_day`) combination with its count. |
meta | object | Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC. |
version | string | API version that processed the request. |
api_version | string | API route prefix version (e.g. `v1`). |
request_id | string | Unique request identifier (hex). |
datetime | object | Companion descriptor present in the `meta` block of every response (and in the `meta` of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec. |
timezone* | string | Always `UTC`: The canonical timezone for every datetime field in the body. |
format* | string | Always `ISO 8601`: Explicit `Z` suffix on every datetime. |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
Used in operations
GET /v1/usage/heatmap