Métricas del periodo
Los mismos cortes de la pantalla de Métricas: totales del periodo y del anterior, serie por día, perfil por hora, ranking por persona y por cuenta de recaudo. Acepta los filtros del libro. fromTime/toTime acotan a un turno (por ejemplo, 18:00–23:59 para la noche).
Autorización
apiKey metrics.readLa llave del negocio, creada en el panel: Integraciones → API pública. Formato vk_live_… (o vk_test_… fuera de producción).
Va en: header
Permiso: metrics.read
Parámetros de consulta
Sobre qué negocio actúa la petición. Obligatorio solo si la llave entra a varios negocios (plan Multi); con uno solo, se deduce.
Repetible.
Hora de inicio del turno, HH:mm en hora de Colombia.
Cuerpo de la respuesta
application/json
application/json
application/json
curl -X GET "https://example.com/metrics"{ "object": "metrics", "range": {}, "income": {}, "expenses": {}, "previous": {}, "series": [ {} ], "hours": [ {} ], "team": [ {} ], "accounts": [ {} ], "suspicious": {}}Estado de la conexión GET
Por dónde entran los avisos del banco y si el canal sigue vivo. healthy es el dato que importa: cuando se pone en false, el negocio dejó de tener con qué verificar y todavía no lo sabe. Un monitor que consulte esto cada mañana se entera antes que el cliente que reclama.
Crear un webhook POST
Devuelve el secreto de firma en claro. Guárdalo: con él verificas que cada entrega vino de nosotros. La URL tiene que ser https y resolver a una dirección pública — se valida al guardar y otra vez en cada entrega, porque un dominio que hoy apunta a un servidor público puede apuntar mañana a una red interna.