← Volver al índice de esquemas
GetUsageHeatmapResponse
Respuesta de `GET /v1/usage/heatmap`. Densidad de validaciones por combinación (día de la semana, hora del día) sobre la ventana consultada.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
data | object | Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`). |
type | string | Discriminador JSON:API. Siempre `usage_heatmap`. |
attributes | object | Densidad de uso por (día de la semana, hora del día) sobre la ventana consultada. |
days | integer | Ventana del heatmap en días (típicamente 30 o 90). |
max_count | integer | Valor máximo de `count` entre todas las celdas; útil para escalar la intensidad del color en la UI. |
buckets | array | Lista de celdas del heatmap; cada entrada es una combinación (day_of_week, hour_of_day) con su conteo. |
meta | object | Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC. |
version | string | Versión de la API que procesó la petición. |
api_version | string | Versión del prefijo de ruta de la API (ej. `v1`). |
request_id | string | Identificador único de la petición (hex). |
datetime | object | Descriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec. |
timezone* | string | Siempre `UTC` — la zona canónica para cada campo datetime del cuerpo. |
format* | string | Siempre `ISO 8601` — sufijo `Z` explícito en cada datetime. |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
Usado en operaciones
GET /v1/usage/heatmap