`GetUsageHeatmapResponse`

Response of `GET /v1/usage/heatmap`. Validation density by (day-of-week, hour-of-day) combinations over the queried window.

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 discriminator. Always `usage_heatmap`.
`attributes`	`object`	Usage density by (day-of-week, hour-of-day) over the queried window.
`days`	`integer`	Heatmap window in days (typically 30 or 90).
`max_count`	`integer`	Maximum `count` value across all cells; useful for scaling color intensity in the UI.
`buckets`	`array`	Heatmap 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 every response's meta block (and in outgoing webhook payloads). 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.