Obtener analíticas

Recupera métricas de analíticas de uso del chat en un intervalo de tiempo específico por dispositivo de WhatsApp y/o miembros del equipo Nota: las analíticas solo están disponibles en los planes Platform Business y Ente

API de WhatsApp y CRM

Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.

GET https://api.getincloud.ai/v1/analytics

Recupera métricas de analíticas de uso del chat en un intervalo de tiempo específico por dispositivo de WhatsApp y/o miembros del equipo

Nota: las analíticas solo están disponibles en los planes Platform Business y Enterprise; de lo contrario, la API devolverá un error 409

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y prueba la API en el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Parámetros

Campo	Dónde	Tipo	Obligatorio	Descripción
`from`	query	string	Sí	Fecha de inicio en formato ISO 8601. Ejemplo: `2023-01-15T00:00:00.000Z` `format: date-time`
`to`	query	string	Sí	Fecha de fin en formato ISO 8601. Ejemplo: `2023-02-15T00:00:00.000Z` `format: date-time`
`compareFrom`	query	string	No	Fecha de inicio de comparación en formato ISO 8601. Ejemplo: `2023-01-15T00:00:00.000Z` `format: date-time`
`compareTo`	query	string	No	Fecha de fin de comparación en formato ISO 8601. Ejemplo: `2023-02-15T00:00:00.000Z` `format: date-time`
`timeframe`	query	string	No	Unidad de tiempo de los datos para las métricas agregadas `enum: ['hourly', 'daily', 'monthly']` · `default: daily`
`scope`	query	string	No	Alcance de los datos de las métricas `enum: ['agent', 'chat']` · `default: chat`
`include`	query	array	No	Incluye en la respuesta los datos de los miembros del equipo (agentes)
`exclude`	query	array	No	Excluye de la respuesta los datos de los chats
`devices`	query	array	No	Filtra por IDs de dispositivos de WhatsApp
`agents`	query	array	No	Filtra por agentes
`compareDevices`	query	array	No	Compara con los IDs de dispositivos de WhatsApp

Respuestas

Código	Descripción
`200`	Datos de analíticas
`400`	Datos de consulta o de cuerpo de la solicitud no válidos
`401`	No autorizado: token de API no válido o ausente
`403`	Faltan los permisos necesarios
`404`	Recurso no encontrado
`409`	Las analíticas no son compatibles con el plan actual
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio temporalmente no disponible: inténtalo de nuevo más tarde

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Retrieve chat usage analytics
curl --request GET \
  --url 'https://api.getincloud.ai/v1/analytics?timeframe=hour&device={{device.id}}' \
  --header 'Token: <api token goes here>'


// Retrieve chat usage per team member
curl --request GET \
  --url 'https://api.getincloud.ai/v1/analytics?timeframe=daily&scope=agent&agents={{user.id}}%2C{{user.id}}' \
  --header 'Token: <api token goes here>'

AnteriorMarcar chat como leído/no leído SiguienteObtener chat por WID

¿Te sirvió esta página?