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

Obtener el mapa de calor de validaciones por día y hora

Audiencia
public
Autenticación
API key
Permiso
usage:read_self
Guía de uso →

Devuelve las validaciones del usuario agrupadas por día de la semana y hora del día, para los últimos days días (máximo 90).

Sólo se devuelven las combinaciones con al menos una validación: el cliente rellena la rejilla de 7×24 poniendo a cero las celdas que falten.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
daysqueryintegeropcional

Número de días a incluir en el mapa de calor.

Predeterminado: 30

p. ej. 30
Petición
curl -X GET 'https://api.veriko.mx/v1/usage/heatmap' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200GetUsageHeatmapResponse — Datos del mapa de calor agrupados por día y hora, incluyendo la cantidad de registros en cada intervalo.
CampoTipoDescripción
dataobject

Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con type, id, attributes).

typestring

Tipo de recurso JSON:API. Siempre usage_heatmap.

p. ej. usage_heatmap
attributesobject

Datos del mapa de calor: la ventana en días, el valor máximo y las celdas.

daysinteger

Ventana del mapa de calor en días (típicamente 30 o 90).

p. ej. 30
max_countinteger

Valor máximo de count entre todas las celdas; sirve para escalar la intensidad del color al representarlo.

p. ej. 48
bucketsarray

Lista de celdas del mapa; cada entrada es una combinación de day_of_week y hour_of_day con su conteo.

metaobject

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.

versionstring

Versión de la API que procesó la petición.

p. ej. 1.47.0
api_versionstring

Versión del prefijo de ruta de la API (ej. v1).

p. ej. v1
request_idstring

Identificador único de la petición (hex).

p. ej. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

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.

p. ej. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Siempre UTC: La zona canónica para cada campo datetime del cuerpo.

p. ej. UTC
format*string

Siempre ISO 8601: Sufijo Z explícito en cada datetime.

p. ej. ISO 8601
linksobject

Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Códigos de respuestaGET /v1/usage/heatmap
CódigoClaseDescripciónCuerpo
2002xxDatos del mapa de calor agrupados por día y hora, incluyendo la cantidad de registros en cada intervalo.GetUsageHeatmapResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
Errores de GET /v1/usage/heatmap
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d