← Volver al índice de esquemas

GetUsageHeatmapResponse

Respuesta de `GET /v1/usage/heatmap` con la densidad de validaciones por día de la semana y hora.

Propiedades

CampoTipoDescripción
dataobjectPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
typestringTipo de recurso JSON:API. Siempre `usage_heatmap`.
attributesobjectDatos del mapa de calor: la ventana en días, el valor máximo y las celdas.
daysintegerVentana del mapa de calor en días (típicamente 30 o 90).
max_countintegerValor máximo de `count` entre todas las celdas; sirve para escalar la intensidad del color al representarlo.
bucketsarrayLista de celdas del mapa; cada entrada es una combinación de `day_of_week` y `hour_of_day` con su conteo.
metaobjectMetadatos 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.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor 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*stringSiempre `UTC`: La zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601`: Sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • GET /v1/usage/heatmap