← Back to schema index

GetUsageHeatmapResponse

Response from `GET /v1/usage/heatmap` with validation density by weekday and hour.

Properties

FieldTypeDescription
dataobjectMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
typestringJSON:API resource type. Always `usage_heatmap`.
attributesobjectHeatmap data: the window in days, the maximum value, and the cells.
daysintegerHeatmap window in days (typically 30 or 90).
max_countintegerMaximum `count` value across all cells; useful for scaling color intensity when rendering.
bucketsarrayMap cells; each entry is a (`day_of_week`, `hour_of_day`) combination with its count.
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion 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*stringAlways `UTC`: The canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601`: Explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

  • GET /v1/usage/heatmap