← Back to schema index

UsageHeatmapResource

JSON:API resource carrying the heatmap.

Properties

FieldTypeDescription
typestringJSON:API discriminator. Always `usage_heatmap`.
attributesobjectUsage density by (day-of-week, hour-of-day) over the queried window.
daysintegerHeatmap window in days (typically 30 or 90).
max_countintegerMaximum `count` value across all cells; useful for scaling color intensity in the UI.
bucketsarrayHeatmap 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