GEThttps://api.veriko.mx/v1/usage/heatmap

Validation heatmap by day and hour

Audience: public
Auth: API key
Permission: usage:read_self

Returns the user's validations grouped by day of week and hour of day, over the last days days (max 90).

Only combinations with at least one validation are returned: the client fills in the 7×24 grid with the missing cells at zero.

Parameters
Parameter	In	Type	Required	Description
`days`	query	`integer`	optional	Number of days to include in the heatmap. Default: `30` e.g. `30`

Request

cURLPython•JavaScript•PHP•

curl -X GET 'https://api.veriko.mx/v1/usage/heatmap' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200**`GetUsageHeatmapResponse` — Heatmap data grouped by day and hour, with the number of records in each interval.
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`. e.g. `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). e.g. `30`
`max_count`	`integer`	Maximum `count` value across all cells; useful for scaling color intensity when rendering. e.g. `48`
`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. e.g. `1.47.0`
`api_version`	`string`	API route prefix version (e.g. `v1`). e.g. `v1`
`request_id`	`string`	Unique request identifier (hex). e.g. `a1b2c3d4e5f66f5e4d3c2b1a`
`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. e.g. `{"timezone":"UTC","format":"ISO 8601"}`
`timezone`*	`string`	Always `UTC`: The canonical timezone for every datetime field in the body. e.g. `UTC`
`format`*	`string`	Always `ISO 8601`: Explicit `Z` suffix on every datetime. e.g. `ISO 8601`
`links`	`object`	Pagination or related links, present only when the endpoint returns a paginated collection.

**Response status codes**`GET /v1/usage/heatmap`
Status	Class	Description	Body
200	`2xx`	Heatmap data grouped by day and hour, with the number of records in each interval.	`GetUsageHeatmapResponse`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Insufficient permissions.	`ErrorResponse`

**Errors from `GET /v1/usage/heatmap`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b99b8a7f6e5d4c`
403	`permission_denied`	You do not have permission to access this resource. Envelope meta.request_id `d5e6f7a8b9c00c9b8a7f6e5d`