Validation heatmap by day and hour

GET https://api.veriko.mx/v1/usage/heatmap

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

Aggregates the user's validations by day of week and hour of day over the last N days (max 90). Returns only combinations with at least one validation (sparse buckets); the client densifies into a 7×24 grid. day_of_week: 0 = Sunday, 6 = Saturday. hour_of_day: 0–23 server time.

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

Request

cURLPython•JavaScript•PHP•

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

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200** `GetUsageHeatmapResponse` — Sparse heatmap buckets with count per day×hour combination.
Field	Type	Description
`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.

**Response status codes** `GET /v1/usage/heatmap`
Status	Class	Description	Body
200	`2xx`	Sparse heatmap buckets with count per day×hour combination.	`GetUsageHeatmapResponse`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Permisos insuficientes	`ErrorResponse`

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