Encuentra la respuesta que buscas

Utiliza nuestra API de análisis desde Live

La  API de análisis de Live brinda acceso programático a los datos y métricas de las conversaciones, tanto en tiempo real como históricas.

⬇ Con esta API, los equipos técnicos pueden:

  1. Integrar reportes y análisis de conversaciones en sus propios sistemas.
  2. Acceder al historial de chats y a métricas clave como tiempos de respuesta, resolución y cumplimiento de SLA.
  3. Analizar la productividad de los agentes, el feedback de clientes y las tendencias a lo largo del tiempo.
  4. Exportar datos en formato CSV para análisis externo.
  5. Crear reportes personalizados y automatizar procesos de monitoreo.

⚠ Importante: su uso requiere conocimientos técnicos.

🔗 URL Base: https://live-public-api.agentbot.net


📶 Obtendrás la siguiente información:

  1. Get SLA: devuelve las métricas SLA (Acuerdo de Nivel de Servicio) de las conversaciones agrupadas por equipo/grupo.
  2. Get Export Simple List: exporta datos de conversaciones en formato CSV con información detallada sobre cada conversación, incluyendo tiempos, participantes, resolución y feedback.
  3. Get Conversation List: arroja un historial detallado de todas las conversaciones que los agentes han tenido con los usuarios, incluyendo metadatos de conversación, información de los participantes y detalles de la sesión.
  4. Get Stats: devuelve métricas estadísticas e indicadores de rendimiento para conversaciones dentro de un periodo de tiempo especificado.
  5. Get Feedback: resultados de encuestas. Recibe la cantidad de comentarios.
  6. Get Histogram: retorna datos agregados de conversaciones agrupados por intervalos de tiempo, mostrando métricas como total de conversaciones, conversaciones cerradas, perdidas, transferencias y cantidad de agentes activos.
  7. Get Summary: trae un resumen detallado de métricas de conversaciones agrupadas por período de tiempo, grupo y protocolo, incluyendo tiempos de respuesta, tasas de finalización, feedback de usuarios y métricas de SLA.
  8. Get Agents Stats: devuelve métricas de rendimiento y estadísticas detalladas de los agentes, incluidas el manejo de conversaciones, los tiempos de respuesta, los puntajes de retroalimentación y los indicadores de productividad.
  9. Conversation List Detail: ofrece los detalles de la conversación según el ID de la conversación. Desde ahí, puedes acceder a todas las consultas introducidas por el usuario durante la conversación, con las respuestas correspondientes obtenidas de Live.

ℹ Para consumir la API necesitas:

  1. Acceder a la documentación oficial.
  2. Solicitar el token y el X-token del canal a través de un Service Request en Aivo Support Center. 
  3. Usar un usuario que: 
    1. Esté registrado en el bot correspondiente a la instancia de Live a analizar.
    2. Tenga permisos habilitados para la sección de Reportes.

✅ Datos clave

  1. Autenticación: especificar el método de autenticación utilizado: API Key, OAuth, Bearer Token, etc. Todas las solicitudes a la API deben incluir credenciales de autenticación válidas.
  2. El token de autenticación tiene una vigencia de 10 horas. Se recomienda incluir una regla en tus servicios para la renovación automática cuando sea posible. 
  3. X-token: debes utilizar el x-token del bot que tienes activo. Todos los canales del bot comparten el mismo.
  4. Se sugiere utilizar una cuenta de correo corporativa para registrar las credenciales (p. ej.: nombre@corporativo.com). 

➡ Consideraciones técnicas:

  1. Threads: nuestras APIs soportan 1 solo thread por consulta. 
  2. Intervalo recomendado para filtrar datos: 7 días. Se puede establecer cualquier rango de tiempo requerido. No obstante, el tiempo de respuesta de la API dependerá del volumen de datos involucrado: a mayor cantidad de información, mayor será el tiempo de procesamiento.
  3. Límites de Consulta: algunos endpoints tienen restricciones en el rango de fechas según la frecuencia seleccionada.
    • Endpoint Frecuencia Límite Máximo
      • Half-hour = Máximo 7 días
      • Hour = Máximo 7 días
      • Week= Máximo 1 mes
      • Month= Máximo 1 mes.
  4. Formato de Respuesta: todas las respuestas de la API se devuelven en formato JSON, excepto el endpoint de exportación que devuelve archivos CSV.
    1. Content-Type: application/json (para la mayoría de endpoints)  
    2. Content-Type: text/csv; charset=utf-8 (para endpoints de exportación)

➡ Parámetros Comunes:

↗ Parámetros de Fecha: la mayoría de los endpoints requieren parámetros de rango de fechas.

from: Fecha y hora de inicio (formato: yyyy-MM-dd HH : mm : ss) Ejemplo: from=2025-12-01 00:00:00

 to: Fecha y hora de fin (formato: yyyy-MM-dd HH : mm : ss) Ejemplo: to=2025-12-07 23:59:59

↗ Parámetros de Frecuencia: algunos endpoints permiten agrupar datos por frecuencia temporal:

• HALF-HOUR: media hora

• HOUR: hora

• DAY: día

• WEEK: semana

• MONTH: mes

↗ Parámetros Opcionales: consulta la documentación de cada endpoint para parámetros opcionales específicos como filtros por grupo, agente, protocolo, etc.


➡ Endpoints Disponibles:

↗ Conversaciones

• GET /live/public/conversation/list - Lista detallada de conversaciones

• GET /live/public/conversation/stats - Estadísticas agregadas de conversaciones

• GET /live/public/conversation/sla - Métricas de cumplimiento de SLA

↗ Análisis y Reportes

• GET /live/public/histogram - Histograma de conversaciones por período

• GET /live/public/summary - Resumen detallado con múltiples métricas

• GET /live/public/agent/performance - Reporte de desempeño de agentes

↗ Exportación

• GET /live/public/export-simple - Exportación de datos en formato CSV


➡ Códigos de estado HTTP:

CódigoDescripción200Solicitud exitosa400Solicitud inválida (parámetros incorrectos o faltantes)401No autenticado (credenciales faltantes o inválidas)403Prohibido (sin permisos para acceder al recurso)404Recurso no encontrado429Demasiadas solicitudes (límite de rate limit excedido)500Error interno del servidor

➡ Manejo de Errores: las respuestas de error incluyen información detallada sobre el problema:

{

    "error": {

        "code": "INVALID_DATE_RANGE",

        "message": "El rango de fechas excede el límite máximo permitido para la frecuencia seleccionada",

        "details": {

            "max_range": "7 days",

            "provided_range": "15 days",

            "frequency": "HOUR"

        }

    }

}

➡ Soporte de Idiomas: algunos endpoints, como /export-simple, soportan múltiples idiomas para encabezados y etiquetas: es - Español / en - Inglés / pt - Portugués.

Este sitio web almacena cookies en tu computadora. Estas cookies se utilizan para recopilar información sobre cómo interactúas con nuestro sitio web y nos permite recordarte. Utilizamos esta información para mejorar y personalizar tu experiencia de navegación y para obtener estadísticas y métricas sobre nuestros visitantes tanto en este sitio web como en otros medios. Para obtener más información sobre las cookies que utilizamos, consulta nuestra Política de privacidad.

Si rechazas, tu información no será rastreada cuando visites este sitio web. Se usará una sola cookie en tu navegador para recordar tu preferencia de no ser rastreado.