BotDesk

Consultar métricas

Obtén las métricas de uso de tu cuenta — conversaciones totales, mensajes y promedios — en una sola petición.

Un endpoint sencillo para pulsar el uso de tu cuenta: cuántas conversaciones y mensajes se han acumulado, cuántas conversaciones siguen activas y la media de mensajes por conversación. Útil para tus propios paneles o informes.

Autenticación

La petición se autentica con tu API key pública en la cabecera X-API-Key. Las métricas son siempre las de tu propia cuenta.

Obtener métricas

Ruta base: /v1/public/v1/analytics

Método Ruta Propósito
GET /analytics Métricas de uso básicas de tu cuenta.

Petición

GET /v1/public/v1/analytics
X-API-Key: <tu-api-key>

Respuesta (200 OK)

{
  "total_conversations": 1280,
  "total_messages": 5920,
  "active_conversations": 37,
  "avg_messages_per_conversation": 4.63
}
Campo Tipo Descripción
total_conversations entero Todas las conversaciones creadas en tu cuenta.
total_messages entero Todos los mensajes de todas las conversaciones.
active_conversations entero Conversaciones actualmente en estado active.
avg_messages_per_conversation decimal Media de mensajes por conversación.

Errores

Código Significado
401 Falta la cabecera X-API-Key o la clave no es válida.
403 Tu plan no incluye acceso a la API pública.