← Back to schema index

UsageHeatmapResource

JSON:API resource carrying the validation heatmap.

Properties

FieldTypeDescription
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.

Used in operations

  • GET /v1/usage/heatmap

Referenced by schemas