{"info":{"_postman_id":"6105cb3f-72aa-4d4e-836e-f50f96c9a933","name":"LivePublicApi","description":"

API Pública de Live Chat - Documentación

\n

Descripción General

\n

La API Pública de Live Chat proporciona acceso programático a datos y métricas de conversaciones en tiempo real y históricas. Esta API permite a los desarrolladores integrar capacidades de reporting, análisis y exportación de datos de chat en sus aplicaciones y sistemas empresariales.

\n

Características Principales

\n\n

URL Base

\n
https://live-public-api.agentbot.net\n\n

Autenticación

\n

(Nota: Especificar el método de autenticación utilizado - API Key, OAuth, Bearer Token, etc.)

\n

Todas las solicitudes a la API deben incluir credenciales de autenticación válidas. Consulte la sección de autenticación para más detalles sobre cómo obtener y utilizar sus credenciales.

\n

Formato de Respuesta

\n

Todas las respuestas de la API se devuelven en formato JSON, excepto el endpoint de exportación que devuelve archivos CSV.

\n

Content-Type: application/json (para la mayoría de endpoints)
Content-Type: text/csv; charset=utf-8 (para endpoints de exportación)

\n

Parámetros Comunes

\n

Parámetros de Fecha

\n

La mayoría de los endpoints requieren parámetros de rango de fechas:

\n\n

Ejemplo:

\n
from=2025-12-01 00:00:00\nto=2025-12-07 23:59:59\n\n

Parámetros de Frecuencia

\n

Algunos endpoints permiten agrupar datos por frecuencia temporal:

\n\n

Parámetros Opcionales

\n

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

\n

Límites de Consulta

\n

Algunos endpoints tienen restricciones en el rango de fechas según la frecuencia seleccionada:

\n
EndpointFrecuenciaLímite Máximo/histogramHALF-HOUR7 días/histogramHOUR7 días/histogramWEEK1 mes/histogramMONTH1 año/summaryHALF-HOUR7 días/summaryHOUR7 días/summaryWEEK1 mes/summaryMONTH1 año/conversation/list-7 días/conversation/stats-7 días\n\n

Endpoints Disponibles

\n

Conversaciones

\n\n

Análisis y Reportes

\n\n

Exportación

\n\n

Códigos de Estado HTTP

\n
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\n\n

Manejo de Errores

\n

Las respuestas de error incluyen información detallada sobre el problema:

\n

json

\n
{\n    \"error\": {\n        \"code\": \"INVALID_DATE_RANGE\",\n        \"message\": \"El rango de fechas excede el límite máximo permitido para la frecuencia seleccionada\",\n        \"details\": {\n            \"max_range\": \"7 days\",\n            \"provided_range\": \"15 days\",\n            \"frequency\": \"HOUR\"\n        }\n    }\n}\n\n

Soporte de Idiomas

\n

Algunos endpoints, como /export-simple, soportan múltiples idiomas para encabezados y etiquetas:

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Pública de Live Chat - Documentación","slug":"api-publica-de-live-chat-documentacion"}],"owner":"14164916","collectionId":"6105cb3f-72aa-4d4e-836e-f50f96c9a933","publishedId":"UVRBnRta","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-12-21T14:02:14.000Z"},"item":[{"name":"SLA","id":"3c89730e-8d3b-4106-8b2b-3466c99901bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.agentbot.net/conversation/sla?from=2025-12-01 00:00:00&to=2025-12-07 23:59:59","description":"

Get SLA Feedback

\n

Returns the SLA (Service Level Agreement) metrics of conversations grouped by team/group.

\n

Endpoint

\n\n

Request Parameters

\n

Required Parameters

\n
ParameterTypeDescriptionfromstringStart date for the report period (format: ISO 8601 or yyyy-MM-dd)tostringEnd date for the report period (format: ISO 8601 or yyyy-MM-dd)\n\n

Optional Parameters

\n

Common optional parameters apply (refer to general API documentation).

\n

Response

\n

Success Response

\n

Code: 200 OK

\n

Response Structure:

\n

json

\n
{\n    \"groups\": [\n        {\n            \"averageTotalQueueTime\": \"00:00:53\",\n            \"averageWithSLA\": 100,\n            \"finalized\": 3,\n            \"groupId\": 3561,\n            \"groupName\": \"test tomi update1\",\n            \"sla\": \"00:01:01\",\n            \"slaAverage\": \"00:00:53\",\n            \"timeDiff\": \"00:00:53\",\n            \"totalQueueTime\": \"00:04:28\"\n        },\n        {\n            \"averageTotalQueueTime\": \"00:01:21\",\n            \"averageWithSLA\": 0,\n            \"finalized\": 1,\n            \"groupId\": 3818,\n            \"groupName\": \"Yury\",\n            \"sla\": \"00:00:00\",\n            \"slaAverage\": \"00:01:21\",\n            \"timeDiff\": \"00:01:21\",\n            \"totalQueueTime\": \"00:05:26\"\n        }\n    ]\n}\n\n

Response Fields

\n
FieldTypeDescriptiongroupsarrayArray containing SLA metrics for each groupgroupIdintegerUnique identifier of the group/teamgroupNamestringName of the group/teamfinalizedintegerNumber of conversations successfully finalized in the periodtotalQueueTimestring (HH:MM:SS)Total cumulative queue time for all conversationsslastring (HH:MM:SS)Configured SLA target time for the groupaverageTotalQueueTimestring (HH:MM:SS)Average queue time per conversationslaAveragestring (HH:MM:SS)Average time including SLA considerationtimeDiffstring (HH:MM:SS)Time difference between SLA target and actual performanceaverageWithSLAnumberPercentage of conversations meeting SLA target (0-100)\n\n

Notes

\n\n","urlObject":{"protocol":"https","path":["conversation","sla"],"host":["live-public-api","agentbot","net"],"query":[{"disabled":true,"key":"rows","value":"20"},{"disabled":true,"key":"limit","value":"1"},{"disabled":true,"key":"offset","value":"2"},{"disabled":true,"key":"","value":null},{"key":"from","value":"2025-12-01 00:00:00"},{"key":"to","value":"2025-12-07 23:59:59"}],"variable":[]}},"response":[],"_postman_id":"3c89730e-8d3b-4106-8b2b-3466c99901bb"},{"name":"Export Simple List","id":"f7b5a414-c6c0-442b-b0aa-2a41a46508ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.agentbot.net/export-simple?from=2025-11-12%2000:00:12&to=2025-11-18%2023:59:59&frequency=day&language=es","description":"

Exportar Reporte Simple

\n

Exporta datos de conversaciones en formato CSV con información detallada sobre cada conversación, incluyendo tiempos, participantes, resolución y feedback.

\n

Endpoint

\n\n

Parámetros de la Solicitud

\n

Parámetros Requeridos

\n
ParámetroTipoDescripciónfromstringFecha y hora de inicio del período de exportación (formato: yyyy-MM-dd HH:mm:ss, codificado en URL)tostringFecha y hora de fin del período de exportación (formato: yyyy-MM-dd HH:mm:ss, codificado en URL)frequencystringFrecuencia/granularidad de la exportación. Valores aceptados: day, week, monthlanguagestringIdioma para los encabezados de columnas y etiquetas. Parámetro obligatorio. Valores aceptados: es (Español), en (Inglés), pt (Portugués)\n\n

Parámetros Opcionales

\n

Se aplican los parámetros opcionales comunes (consultar la documentación general de la API).

\n

Respuesta

\n

Respuesta Exitosa

\n

Código: 200 OK

\n

Content-Type: text/csv; charset=utf-8

\n

Estructura de la Respuesta (formato CSV):

\n

La respuesta es un archivo CSV con las siguientes columnas:

\n
Nombre de ColumnaTipoDescripciónHora de derivacióndatetimeFecha y hora en que la conversación fue puesta en colaHora de iniciodatetimeFecha y hora en que la conversación comenzóHora de findatetimeFecha y hora en que la conversación finalizóTiempo de respuestatime (HH:MM:SS)Tiempo que tomó responder al usuarioTiempo de operacióntime (HH:MM:SS)Tiempo total de operación/manejoId de salastring (UUID)Identificador único de la sala de conversaciónClientestringNombre o identificador del clienteAgentestringNombre(s) del/los agente(s) que atendieron la conversación (múltiples agentes separados por \"-\")TemasstringTemas discutidos en la conversaciónCanalstringCanal de comunicación (ej: \"Web\", \"WhatsApp\")Tiempo de conversacióntime (HH:MM:SS)Duración neta de la conversaciónResoluciónstringCómo se cerró la conversación (ej: \"Agente\", \"Cliente\", \"Disparador\", \"Falla Conexión/Agente\")FeedbackstringEstado o valor del feedback del clienteGrupostringGrupo(s) que atendieron la conversación (múltiples grupos separados por \"-\")NotastringNotas agregadas a la conversaciónEtiquetasstringEtiquetas asociadas con la conversaciónSession IDstringIdentificador de sesiónTeléfonostringNúmero de teléfono del clienteRegiónstringRegión geográfica del cliente\n\n

Ejemplo CSV (Español):

\n

csv

\n
Hora de derivación,Hora de inicio,Hora de fin,Tiempo de respuesta,Tiempo de operación,Id de sala,Cliente,Agente,Temas,Canal,Tiempo de conversación,Resolución,Feedback,Grupo,Nota,Etiquetas,Session ID,Teléfono,Región\n2025-11-18 14:48:36,2025-11-18 14:48:39,2025-11-18 14:49:10,00:00:00,00:00:00,880f47f4-34c8-409a-aa6e-68ff9fabb0ec,Desconocido,yegor Test 2,,Web,00:00:00,Disparador,Sin feedback,Grupo de Pika,,,40429635,,\n2025-11-14 12:23:23,2025-11-14 12:23:28,2025-11-14 12:50:53,00:03:44,00:27:30,c80e1e52-9320-4517-97d8-bfea27292b60,Brian :alegría:,Yury SupAgente-yegor Test 2,,WhatsApp,00:23:23,Agente,Sin feedback,Async Flow-Grupo de Pika,,,40235329,50245948049,\n\n

Notas sobre los Datos de Respuesta

\n
    \n

  • Campos vacíos: Los valores de cadena vacía indican que no hay datos disponibles para ese campo

    \n
    • \n

  • Valores múltiples: Cuando una conversación involucra múltiples agentes o grupos, los nombres se separan por \"-\" (guión)

    \n
    • \n

  • Formato de tiempo: Todos los campos de tiempo usan el formato HH:MM:SS

    \n
    • \n

  • Formato de fecha/hora: Todos los campos de fecha/hora usan el formato yyyy-MM-dd HH:mm:ss

    \n
    • \n

  • Tiempos negativos: En casos raros, el Tiempo de respuesta puede mostrar valores negativos (ej: -1:-40:-19) indicando anomalías en el cálculo de tiempos

    \n
    • \n

  • Tipos de resolución: Los valores comunes incluyen:

    \n
      \n

    • Agente - Cerrado por el agente

      \n
      • \n

    • Cliente - Cerrado por el cliente

      \n
      • \n

    • Disparador - Cerrado por disparador/automatización

      \n
      • \n

    • Falla Conexión/Agente - Falla de conexión/agente

      \n
      • \n
    \n
    • \n

  • Valores de feedback: Los valores comunes incluyen:

    \n
      \n

    • Sin feedback - No se proporcionó feedback

      \n
      • \n

    • Valores numéricos (ej: 5) - Calificación con estrellas

      \n
      • \n

    • Otros tipos de feedback según configuración

      \n

      Soporte de Idiomas

      \n

      El parámetro language controla el idioma de los encabezados del CSV:

      \n
      \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
      Código de IdiomaIdiomaEjemplo de Encabezado
      esEspañolHora de derivación, Cliente, Agente
      enInglésQueue Time, Customer, Agent
      ptPortugués(Traducciones al portugués)
      \n
      • \n
    \n
    • \n
\n

Importante: El parámetro language es obligatorio y debe especificarse en cada solicitud.

\n

Ejemplo de Solicitud

\n
GET /live/public/export-simple?from=2025-11-12 00:00:12&to=2025-11-18 23:59:59&frequency=day&language=es\n\n

Casos de Uso

\n

Este endpoint es útil para:

\n
    \n

  • Exportar datos de conversaciones para análisis externo

    \n
    • \n

  • Crear reportes personalizados en aplicaciones de hojas de cálculo

    \n
    • \n

  • Respaldo y archivo de datos

    \n
    • \n

  • Integración con herramientas de inteligencia de negocios

    \n
    • \n

  • Generar reportes de cumplimiento

    \n
    • \n

  • Analizar patrones y tendencias de conversaciones

    \n
    • \n
\n

Manejo de Descarga

\n

La respuesta generará una descarga de archivo en la mayoría de los navegadores debido al tipo de contenido text/csv. El nombre del archivo típicamente es generado automáticamente por la API o puede ser especificado por la aplicación cliente.

\n","urlObject":{"protocol":"https","path":["export-simple"],"host":["live-public-api","agentbot","net"],"query":[{"key":"from","value":"2025-11-12%2000:00:12"},{"key":"to","value":"2025-11-18%2023:59:59"},{"key":"frequency","value":"day"},{"key":"language","value":"es"},{"disabled":true,"key":"limit","value":"1"}],"variable":[]}},"response":[],"_postman_id":"f7b5a414-c6c0-442b-b0aa-2a41a46508ad"},{"name":"ConversationList","id":"a6d2d25a-475b-4fe8-8c5f-e12c6e52bcc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"TURSaU16SmxOekU0WWpNNU1Ea3daVFExT1RFNE9ESmtNVGc0TTJJMk5HUT0=","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.stage.agentbot.net/conversation?rows=20&limit=1&offset=2&from=2022-01-01 00:00:00&to=2022-01-07 23:59:59","description":"

Get Chat Report

\n

Returns a detailed history of all conversations agents have had with users, including conversation metadata, participant information, and session details.

\n

Endpoint

\n\n

Important Notes

\n

⚠️ This endpoint accepts a maximum of 1 week (7 days) difference between from and to parameters.

\n

Request Parameters

\n

Required Parameters

\n
ParameterTypeDescriptionfromstringStart date for the report period (format: ISO 8601 or yyyy-MM-dd)tostringEnd date for the report period (format: ISO 8601 or yyyy-MM-dd)\n\n

Constraint: Maximum difference between from and to is 7 days.

\n

Optional Parameters

\n

Common optional parameters apply (refer to general API documentation).

\n

Response

\n

Success Response

\n

Code: 200 OK

\n

Response Structure:

\n

json

\n
[\n    {\n        \"conversation_id\": \"DMyHL1unAku1DYHd3JV3\",\n        \"queueddatetime\": \"2022-01-06 12:13:27\",\n        \"startdatetime\": \"2022-01-06 12:13:27\",\n        \"enddatetime\": \"2022-01-06 12:13:38\",\n        \"session_time\": \"00:00:00\",\n        \"wait_time\": \"\",\n        \"protocol\": {\n            \"protocol_id\": 3,\n            \"name\": \"Web\"\n        },\n        \"browser\": {\n            \"name\": \"Chrome\",\n            \"version\": \"96.0.4664.110\"\n        },\n        \"platform\": {\n            \"name\": \"Windows\",\n            \"version\": \"10.0\"\n        },\n        \"closed_by\": {\n            \"name\": \"agent\"\n        },\n        \"reason\": {\n            \"description\": \"transfer by message\",\n            \"type\": \"group\"\n        },\n        \"user\": {\n            \"firstname\": \"\",\n            \"lastname\": \"\",\n            \"email\": \"\",\n            \"phone\": \"\",\n            \"extra\": \"\",\n            \"hash\": \"9d620e11dd2db91238208ac0d12834ed\",\n            \"created\": \"\"\n        },\n        \"groups\": [\n            {\n                \"group_id\": 200,\n                \"name\": \"Async Flow\"\n            }\n        ],\n        \"agents\": [\n            {\n                \"agent_id\": \"5fc7cef742843a006e2a0d9f\",\n                \"name\": \"Melisa\",\n                \"email\": \"\"\n            }\n        ],\n        \"feedback\": {\n            \"name\": \"\",\n            \"value\": 5\n        },\n        \"tags_live\": null,\n        \"user_connections\": null,\n        \"topic\": [],\n        \"notes\": null\n    }\n]\n\n

Response Fields

\n
FieldTypeDescriptionconversation_idstringUnique identifier of the conversationqueueddatetimestring (datetime)Date and time when the conversation was queued (format: yyyy-MM-dd HH:mm:ss)startdatetimestring (datetime)Date and time when the conversation startedenddatetimestring (datetime)Date and time when the conversation endedsession_timestring (HH:MM:SS)Total duration of the conversationwait_timestring (HH:MM:SS)Duration the user waited before being attendedprotocolobjectCommunication protocol informationprotocol.protocol_idintegerUnique identifier of the protocolprotocol.namestringName of the protocol (e.g., \"Web\", \"Mobile\")browserobjectBrowser informationbrowser.namestringBrowser namebrowser.versionstringBrowser versionplatformobjectOperating system informationplatform.namestringPlatform/OS nameplatform.versionstringPlatform/OS versionclosed_byobjectInformation about who/what closed the conversationclosed_by.namestringEntity that closed the conversation (e.g., \"agent\", \"user\", \"trigger\")reasonobjectReason for conversation closure or transferreason.descriptionstringDetailed description of the reasonreason.typestringType of reason (e.g., \"group\")userobjectEnd user informationuser.firstnamestringUser's first nameuser.lastnamestringUser's last nameuser.emailstringUser's email addressuser.phonestringUser's phone numberuser.extrastringAdditional user informationuser.hashstringUnique hash identifier for the useruser.createdstring (datetime)Date when user was createdgroupsarrayList of groups involved in the conversationgroups[].group_idintegerGroup unique identifiergroups[].namestringGroup nameagentsarrayList of agents who participated in the conversationagents[].agent_idstringAgent unique identifieragents[].namestringAgent nameagents[].emailstringAgent email addressfeedbackobjectCustomer feedback informationfeedback.namestringFeedback category namefeedback.valueinteger/nullFeedback rating value (typically 1-5 scale)tags_livearray/nullTags associated with the live conversationuser_connectionsarray/nullUser connection informationtopicarrayTopics discussed in the conversationnotesstring/nullNotes added to the conversation\n\n

Notes

\n
    \n

  • The response returns an array of conversation objects

    \n
    • \n

  • Empty strings (\"\") indicate fields with no data

    \n
    • \n

  • null values indicate optional fields that were not set

    \n
    • \n

  • All datetime fields use the format: yyyy-MM-dd HH:mm:ss

    \n
    • \n

  • Time duration fields use the format: HH:MM:SS

    \n
    • \n
\n","urlObject":{"protocol":"https","path":["conversation"],"host":["live-public-api","stage","agentbot","net"],"query":[{"key":"rows","value":"20"},{"key":"limit","value":"1"},{"key":"offset","value":"2"},{"disabled":true,"key":"","value":null},{"key":"from","value":"2022-01-01 00:00:00"},{"key":"to","value":"2022-01-07 23:59:59"}],"variable":[]}},"response":[],"_postman_id":"a6d2d25a-475b-4fe8-8c5f-e12c6e52bcc5"},{"name":"Stats","id":"f7f1bc69-c099-4bd9-84e7-abbf88931c23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.agentbot.net/conversation/stats?from=2025-12-01 00:00:00&to=2025-12-07 23:59:59","description":"

Get Conversation Stats

\n

Returns statistical metrics and performance indicators for conversations within a specified time period.

\n

Endpoint

\n\n

Important Notes

\n

⚠️ This endpoint accepts a maximum of 1 week (7 days) difference between from and to parameters.

\n

Request Parameters

\n

Required Parameters

\n
ParameterTypeDescriptionfromstringStart date for the report period (format: ISO 8601 or yyyy-MM-dd)tostringEnd date for the report period (format: ISO 8601 or yyyy-MM-dd)\n\n

Constraint: Maximum difference between from and to is 7 days.

\n

Optional Parameters

\n

Common optional parameters apply (refer to general API documentation).

\n

Response

\n

Success Response

\n

Code: 200 OK

\n

Response Structure:

\n

json

\n
{\n    \"conversation\": 19,\n    \"finalized\": 5,\n    \"transferred\": 1,\n    \"transferlost\": 0,\n    \"lost\": 8,\n    \"totaltime\": \"01:53:06\",\n    \"averageTotalTime\": \"00:22:37\",\n    \"totalResponseTime\": \"00:04:45\",\n    \"averageResponseTime\": \"00:02:22\",\n    \"totalQueueTime\": \"00:00:45\",\n    \"averageQueueTime\": \"00:00:09\",\n    \"greatestTotalTime\": \"00:51:09\",\n    \"lowestTotalTime\": \"00:01:26\",\n    \"greatestResponseTime\": \"00:04:21\",\n    \"lowestResponseTime\": \"00:00:24\",\n    \"greatestQueueTime\": \"00:00:19\",\n    \"lowestQueueTime\": \"00:00:05\"\n}\n\n

Response Fields

\n

Conversation Counts

\n
FieldTypeDescriptionconversationintegerTotal number of conversations in the periodfinalizedintegerNumber of conversations successfully finalized/completedtransferredintegerNumber of conversations transferred to another agent or grouptransferlostintegerNumber of conversations that were transferred but subsequently lostlostintegerNumber of conversations lost (abandoned or not attended)\n\n

Total Time Metrics

\n
FieldTypeDescriptiontotaltimestring (HH:MM:SS)Total cumulative duration of all conversationstotalResponseTimestring (HH:MM:SS)Total cumulative response time across all conversationstotalQueueTimestring (HH:MM:SS)Total cumulative queue time across all conversations\n\n

Average Time Metrics

\n
FieldTypeDescriptionaverageTotalTimestring (HH:MM:SS)Average duration per conversationaverageResponseTimestring (HH:MM:SS)Average response time per conversationaverageQueueTimestring (HH:MM:SS)Average queue time per conversation\n\n

Peak Time Metrics (Maximum)

\n
FieldTypeDescriptiongreatestTotalTimestring (HH:MM:SS)Longest conversation duration in the periodgreatestResponseTimestring (HH:MM:SS)Longest response time in the periodgreatestQueueTimestring (HH:MM:SS)Longest queue wait time in the period\n\n

Minimum Time Metrics

\n
FieldTypeDescriptionlowestTotalTimestring (HH:MM:SS)Shortest conversation duration in the periodlowestResponseTimestring (HH:MM:SS)Shortest response time in the periodlowestQueueTimestring (HH:MM:SS)Shortest queue wait time in the period\n\n

Notes

\n
    \n

  • All time values are formatted as HH:MM:SS

    \n
    • \n

  • Response time refers to the time taken by agents to respond to user messages

    \n
    • \n

  • Queue time refers to the time users wait before being attended by an agent

    \n
    • \n

  • Total time encompasses the entire conversation duration from start to finish

    \n
    • \n

  • The sum of finalized, transferred, and lost conversations may not equal the total conversation count due to conversations still in progress

    \n
    • \n
\n

Use Cases

\n

This endpoint is useful for:

\n
    \n

  • Monitoring agent performance and response times

    \n
    • \n

  • Analyzing conversation abandonment rates

    \n
    • \n

  • Identifying peak load times and bottlenecks

    \n
    • \n

  • Generating performance reports and KPIs

    \n
    • \n

  • Capacity planning and staffing decisions

    \n
    • \n
\n","urlObject":{"protocol":"https","path":["conversation","stats"],"host":["live-public-api","agentbot","net"],"query":[{"disabled":true,"key":"","value":""},{"key":"from","value":"2025-12-01 00:00:00"},{"key":"to","value":"2025-12-07 23:59:59"}],"variable":[]}},"response":[],"_postman_id":"f7f1bc69-c099-4bd9-84e7-abbf88931c23"},{"name":"Feedback","id":"97d620b8-4e12-435e-b8e3-8abff6677f35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.agentbot.net/conversation/feedback?from=2025-12-01 00:00:00&to=2025-12-07 23:59:59","description":"

Get amount of feedbacks.

\n
    \n

  • URL

    \n

    https://live-public-api.agentbot.net/conversation/feedback

    \n
    • \n

  • Method:

    \n

    GET

    \n
    • \n

  • URL Params

    \n
      \n

    • Required parameters:

      \n

      from: [string]
      to: [string]
      Diference between from and to: 1 week (7 days).

      \n
      • \n

    • Optional parameters:

      \n

      Common parameters optional

      \n
      • \n
    \n
    • \n

  • Success Response:

    \n
      \n

    • [ { \"feedbackType\": \"1\", \"feedbackName\": \"Binary\", \"positive\": \"34\", \"negative\": \"17\", \"conversations\": \"51\", \"positivePercent\": 66.67, \"negativePercent\": 33.33 }]

      \n
      • \n

    • The response contains an array of these elements

      \n
        \n

      • feedbackType: The id of Feedback Type

        \n
        • \n

      • feedbackName: The name of Feedback Type

        \n
        • \n

      • positive: the amount of positive feedback

        \n
        • \n

      • negative: the amount of negative feedback

        \n
        • \n

      • conversations: the total of conversations

        \n
        • \n

      • positivePercent: the percentage of positive feedback regarding total conversations

        \n
        • \n

      • negativePercent: the percentage of negative feedback regarding total conversations

        \n
        • \n
      \n
      • \n
    \n
    • \n
\n","urlObject":{"protocol":"https","path":["conversation","feedback"],"host":["live-public-api","agentbot","net"],"query":[{"disabled":true,"key":"","value":""},{"key":"from","value":"2025-12-01 00:00:00"},{"key":"to","value":"2025-12-07 23:59:59"}],"variable":[]}},"response":[],"_postman_id":"97d620b8-4e12-435e-b8e3-8abff6677f35"},{"name":"Histogram","id":"ba48ade5-49ab-4de0-86b4-c3cab7817c5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.agentbot.net/histogram?from=2025-12-01 00:00:00&to=2025-12-07 23:59:59&frequency=day","description":"

Obtener Histograma de Conversaciones

\n

Retorna datos agregados de conversaciones agrupados por intervalos de tiempo, mostrando métricas como total de conversaciones, conversaciones cerradas, pérdidas, transferencias y cantidad de agentes activos.

\n

Endpoint

\n\n

Notas Importantes

\n

⚠️ Este endpoint tiene límites de consulta según la frecuencia seleccionada:

\n
FrecuenciaRango Máximo PermitidoHALF-HOUR7 díasHOUR7 díasDAYSin límite específicoWEEK1 mes (31 días)MONTH1 año\n\n

Parámetros de la Solicitud

\n

Parámetros Requeridos

\n
ParámetroTipoDescripciónfromstringFecha y hora de inicio del período (formato: yyyy-MM-dd HH:mm:ss, codificado en URL)tostringFecha y hora de fin del período (formato: yyyy-MM-dd HH:mm:ss, codificado en URL)frequencystringFrecuencia de agrupación de datos. Valores aceptados: HALF-HOUR, HOUR, DAY, WEEK, MONTH\n\n

Parámetros Opcionales

\n

Se aplican los parámetros opcionales comunes (consultar la documentación general de la API).

\n

Respuesta

\n

Respuesta Exitosa

\n

Código: 200 OK

\n

Estructura de la Respuesta:

\n

json

\n
{\n    \"data\": [\n        {\n            \"date\": \"2025-12-01 00:00:00\",\n            \"total\": 3,\n            \"closed\": 2,\n            \"losses\": 1,\n            \"transferred\": 1,\n            \"agents\": 1\n        },\n        {\n            \"date\": \"2025-12-02 00:00:00\",\n            \"total\": 5,\n            \"closed\": 4,\n            \"losses\": 0,\n            \"transferred\": 2,\n            \"agents\": 2\n        }\n    ]\n}\n\n

Campos de Respuesta

\n
CampoTipoDescripcióndataarrayArray de objetos conteniendo métricas agrupadas por período de tiempo\n\n

Objetos dentro de data:

\n
CampoTipoDescripcióndatestring (datetime)Fecha y hora del inicio del período (formato: yyyy-MM-dd HH:mm:ss)totalintegerNúmero total de conversaciones en el períodoclosedintegerNúmero de conversaciones cerradas exitosamentelossesintegerNúmero de conversaciones perdidas (abandonadas o no atendidas)transferredintegerNúmero de conversaciones transferidas a otro agente o grupoagentsintegerNúmero de agentes activos durante el período\n\n

Notas

\n
    \n

  • Los datos se agrupan según la frecuencia especificada

    \n
    • \n

  • Cada objeto en el array data representa un intervalo de tiempo según la frequency seleccionada

    \n
    • \n

  • El campo date marca el inicio de cada intervalo

    \n
    • \n

  • La suma de closed, losses y conversaciones en progreso puede no ser igual a total dependiendo del estado de las conversaciones al final del período

    \n
    • \n
\n

Ejemplos de Agrupación por Frecuencia

\n

HALF-HOUR (Media Hora)

\n

json

\n
{\n    \"data\": [\n        {\"date\": \"2025-12-01 00:00:00\", \"total\": 5, ...},\n        {\"date\": \"2025-12-01 00:30:00\", \"total\": 3, ...},\n        {\"date\": \"2025-12-01 01:00:00\", \"total\": 7, ...}\n    ]\n}\n\n

HOUR (Hora)

\n

json

\n
{\n    \"data\": [\n        {\"date\": \"2025-12-01 00:00:00\", \"total\": 8, ...},\n        {\"date\": \"2025-12-01 01:00:00\", \"total\": 12, ...},\n        {\"date\": \"2025-12-01 02:00:00\", \"total\": 6, ...}\n    ]\n}\n\n

DAY (Día)

\n

json

\n
{\n    \"data\": [\n        {\"date\": \"2025-12-01 00:00:00\", \"total\": 145, ...},\n        {\"date\": \"2025-12-02 00:00:00\", \"total\": 167, ...},\n        {\"date\": \"2025-12-03 00:00:00\", \"total\": 152, ...}\n    ]\n}\n\n

WEEK (Semana)

\n

json

\n
{\n    \"data\": [\n        {\"date\": \"2025-12-01 00:00:00\", \"total\": 980, ...},\n        {\"date\": \"2025-12-08 00:00:00\", \"total\": 1045, ...}\n    ]\n}\n\n

MONTH (Mes)

\n

json

\n
{\n    \"data\": [\n        {\"date\": \"2025-11-01 00:00:00\", \"total\": 4234, ...},\n        {\"date\": \"2025-12-01 00:00:00\", \"total\": 4567, ...}\n    ]\n}\n\n

Ejemplo de Solicitud

\n
GET /live/public/histogram?from=2025-12-01 00:00:00&to=2025-12-07 23:59:59&frequency=DAY\n\n

Validación de Rangos

\n

Si se exceden los límites máximos, la API retornará un error. Ejemplo:
Solicitud inválida:

\n
GET /live/public/histogram?from=2025-11-01 00:00:00&to=2025-11-15 23:59:59&frequency=HALF-HOUR\n\n

(15 días excede el límite de 7 días para HALF-HOUR)

\n

Casos de Uso

\n

Este endpoint es útil para:

\n
    \n

  • Visualizar tendencias de conversaciones a lo largo del tiempo

    \n
    • \n

  • Crear gráficos y dashboards de actividad

    \n
    • \n

  • Identificar horas pico de tráfico

    \n
    • \n

  • Analizar patrones de abandono de conversaciones

    \n
    • \n

  • Monitorear la carga de trabajo de los agentes

    \n
    • \n

  • Generar reportes de desempeño por período

    \n
    • \n

  • Planificar la asignación de recursos según demanda histórica

    \n
    • \n
\n","urlObject":{"protocol":"https","path":["histogram"],"host":["live-public-api","agentbot","net"],"query":[{"key":"from","value":"2025-12-01 00:00:00"},{"key":"to","value":"2025-12-07 23:59:59"},{"key":"frequency","value":"day"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"ba48ade5-49ab-4de0-86b4-c3cab7817c5c"},{"name":"Summary","id":"9e636d08-9cbf-43c2-bbea-720e7ff68b6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.agentbot.net/summary?from=2025-12-01 00:00:00&to=2025-12-07 23:59:59&frequency=day","description":"

Obtener Resumen de Conversaciones

\n

Retorna 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.

\n

Endpoint

\n\n

Notas Importantes

\n

⚠️ Este endpoint tiene límites de consulta según la frecuencia seleccionada:

\n
FrecuenciaRango Máximo PermitidoHALF-HOUR7 díasHOUR7 díasDAYSin límite específicoWEEK1 mes (31 días)MONTH1 año\n\n

Parámetros de la Solicitud

\n

Parámetros Requeridos

\n
ParámetroTipoDescripciónfromstringFecha y hora de inicio del período (formato: yyyy-MM-dd HH:mm:ss, codificado en URL)tostringFecha y hora de fin del período (formato: yyyy-MM-dd HH:mm:ss, codificado en URL)frequencystringFrecuencia de agrupación de datos. Valores aceptados: HALF-HOUR, HOUR, DAY, WEEK, MONTH\n\n

Parámetros Opcionales

\n

Se aplican los parámetros opcionales comunes (consultar la documentación general de la API).

\n

Respuesta

\n

Respuesta Exitosa

\n

Código: 200 OK

\n

Estructura de la Respuesta:

\n

json

\n
{\n    \"data\": [\n        {\n            \"date\": \"2025-12-01 00:00:00\",\n            \"frequency\": \"day\",\n            \"group_name\": \"Yury\",\n            \"protocol\": \"Web\",\n            \"total\": 2,\n            \"attended\": 1,\n            \"closed\": 1,\n            \"losses\": 1,\n            \"transferred\": 1,\n            \"abandoned_after_threshold\": 0,\n            \"finalized_agent\": 0,\n            \"finalized_client\": 1,\n            \"finalized_disconnect\": 0,\n            \"finalized_system\": 0,\n            \"finalized_percent\": 50,\n            \"lost_percent\": 50,\n            \"transfered_percent\": 50,\n            \"transfered_attended\": 50,\n            \"total_agents\": 1,\n            \"total_users\": 1,\n            \"total_unique_users\": 0,\n            \"total_recurrent_users\": 1,\n            \"percent_unique_users\": 0,\n            \"percent_recurrent_users\": 100,\n            \"count_messages\": 0,\n            \"total_time\": 2402,\n            \"average_total_time\": 2402,\n            \"greatest_total_time\": 611,\n            \"lowest_total_time\": 611,\n            \"total_response_time\": 738,\n            \"average_response_time\": 738,\n            \"greatest_response_time\": 0,\n            \"lowest_response_time\": 0,\n            \"total_queue_time\": 17,\n            \"avg_queue_time\": 8,\n            \"greatest_queue_time\": 11,\n            \"lowest_queue_time\": 11,\n            \"with_sla\": 0,\n            \"without_sla\": 2,\n            \"sla_percent\": 0,\n            \"sla_average\": 0,\n            \"general_sla_percent\": 0,\n            \"feedback\": {\n                \"nps\": {\n                    \"total\": 0,\n                    \"value\": 0,\n                    \"positives\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    },\n                    \"negatives\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    },\n                    \"neutrals\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    }\n                },\n                \"binary\": {\n                    \"total\": 0,\n                    \"positives\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    },\n                    \"negatives\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    }\n                },\n                \"stars\": {\n                    \"total\": 0,\n                    \"avg\": 0,\n                    \"sum\": 0,\n                    \"one\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    },\n                    \"two\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    },\n                    \"three\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    },\n                    \"four\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    },\n                    \"five\": {\n                        \"total\": 0,\n                        \"avg\": 0\n                    }\n                }\n            }\n        }\n    ]\n}\n\n

Campos de Respuesta

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CampoTipoDescripción
dataarrayArray de objetos conteniendo métricas detalladas agrupadas por período, grupo y protocolo
#### Campos de Identificación y Agrupación
CampoTipoDescripción
--------------------------
datestring (datetime)Fecha y hora del inicio del período (formato: yyyy-MM-dd HH:mm:ss)
frequencystringFrecuencia de agrupación utilizada (HALF-HOUR, HOUR, DAY, WEEK, MONTH)
group_namestringNombre del grupo de agentes
protocolstringProtocolo de comunicación (ej: \"Web\", \"WhatsApp\", \"Facebook\")
#### Métricas de Conversaciones
CampoTipoDescripción
--------------------------
totalintegerNúmero total de conversaciones en el período
attendedintegerNúmero de conversaciones atendidas
closedintegerNúmero de conversaciones cerradas
lossesintegerNúmero de conversaciones perdidas
transferredintegerNúmero de conversaciones transferidas
abandoned_after_thresholdintegerConversaciones abandonadas después de exceder el umbral de tiempo
#### Métricas de Finalización
CampoTipoDescripción
--------------------------
finalized_agentintegerConversaciones finalizadas por el agente
finalized_clientintegerConversaciones finalizadas por el cliente
finalized_disconnectintegerConversaciones finalizadas por desconexión
finalized_systemintegerConversaciones finalizadas por el sistema
finalized_percentintegerPorcentaje de conversaciones finalizadas
lost_percentintegerPorcentaje de conversaciones perdidas
transfered_percentintegerPorcentaje de conversaciones transferidas
transfered_attendedintegerPorcentaje de conversaciones transferidas que fueron atendidas
#### Métricas de Usuarios y Agentes
CampoTipoDescripción
--------------------------
total_agentsintegerNúmero total de agentes activos
total_usersintegerNúmero total de usuarios
total_unique_usersintegerNúmero de usuarios únicos (nuevos)
total_recurrent_usersintegerNúmero de usuarios recurrentes
percent_unique_usersintegerPorcentaje de usuarios únicos
percent_recurrent_usersintegerPorcentaje de usuarios recurrentes
count_messagesintegerCantidad total de mensajes intercambiados
#### Métricas de Tiempo Total
CampoTipoDescripción
--------------------------
total_timeintegerTiempo total acumulado de todas las conversaciones (en segundos)
average_total_timeintegerTiempo promedio de conversación (en segundos)
greatest_total_timeintegerMayor tiempo de conversación (en segundos)
lowest_total_timeintegerMenor tiempo de conversación (en segundos)
#### Métricas de Tiempo de Respuesta
CampoTipoDescripción
--------------------------
total_response_timeintegerTiempo total acumulado de respuesta (en segundos)
average_response_timeintegerTiempo promedio de respuesta (en segundos)
greatest_response_timeintegerMayor tiempo de respuesta (en segundos)
lowest_response_timeintegerMenor tiempo de respuesta (en segundos)
#### Métricas de Tiempo de Cola
CampoTipoDescripción
--------------------------
total_queue_timeintegerTiempo total acumulado en cola (en segundos)
avg_queue_timeintegerTiempo promedio en cola (en segundos)
greatest_queue_timeintegerMayor tiempo en cola (en segundos)
lowest_queue_timeintegerMenor tiempo en cola (en segundos)
#### Métricas de SLA
CampoTipoDescripción
--------------------------
with_slaintegerNúmero de conversaciones con SLA configurado
without_slaintegerNúmero de conversaciones sin SLA configurado
sla_percentintegerPorcentaje de conversaciones que cumplieron el SLA
sla_averageintegerPromedio de cumplimiento de SLA
general_sla_percentintegerPorcentaje general de cumplimiento de SLA
#### Métricas de Feedback
##### NPS (Net Promoter Score)
CampoTipoDescripción
--------------------------
feedback.nps.totalintegerTotal de respuestas NPS
feedback.nps.valuenumberValor del NPS (-100 a 100)
feedback.nps.positives.totalintegerNúmero de promotores (9-10)
feedback.nps.positives.avgnumberPromedio de promotores
feedback.nps.negatives.totalintegerNúmero de detractores (0-6)
feedback.nps.negatives.avgnumberPromedio de detractores
feedback.nps.neutrals.totalintegerNúmero de pasivos (7-8)
feedback.nps.neutrals.avgnumberPromedio de pasivos
##### Feedback Binario
CampoTipoDescripción
--------------------------
feedback.binary.totalintegerTotal de feedback binario
feedback.binary.positives.totalintegerNúmero de respuestas positivas
feedback.binary.positives.avgnumberPromedio de respuestas positivas
feedback.binary.negatives.totalintegerNúmero de respuestas negativas
feedback.binary.negatives.avgnumberPromedio de respuestas negativas
##### Feedback de Estrellas
CampoTipoDescripción
--------------------------
feedback.stars.totalintegerTotal de calificaciones con estrellas
feedback.stars.avgnumberPromedio de calificación (0-5)
feedback.stars.sumintegerSuma total de todas las calificaciones
feedback.stars.one.totalintegerNúmero de calificaciones de 1 estrella
feedback.stars.one.avgnumberPromedio para 1 estrella
feedback.stars.two.totalintegerNúmero de calificaciones de 2 estrellas
feedback.stars.two.avgnumberPromedio para 2 estrellas
feedback.stars.three.totalintegerNúmero de calificaciones de 3 estrellas
feedback.stars.three.avgnumberPromedio para 3 estrellas
feedback.stars.four.totalintegerNúmero de calificaciones de 4 estrellas
feedback.stars.four.avgnumberPromedio para 4 estrellas
feedback.stars.five.totalintegerNúmero de calificaciones de 5 estrellas
feedback.stars.five.avgnumberPromedio para 5 estrellas
### Notas
- Los tiempos se devuelven en segundos como valores enteros
- Los porcentajes se devuelven como valores enteros (0-100)
- Cada objeto en el array data representa una combinación única de período, grupo y protocolo
- Los valores de 0 en las métricas de feedback indican que no se recibió feedback durante el período
### Ejemplo de Solicitud
```
GET /live/public/summary?from=2025-12-01 00:00:00&to=2025-12-07 23:59:59&frequency=DAY
```
### Validación de Rangos
Si se exceden los límites máximos, la API retornará un error. Ejemplo:
Solicitud inválida:
```
GET /live/public/summary?from=2025-11-01 00:00:00&to=2025-11-15 23:59:59&frequency=HOUR
\n

```

\n

(15 días excede el límite de 7 días para HOUR)

\n

Casos de Uso

\n

Este endpoint es útil para:

\n
    \n

  • Análisis detallado de desempeño por grupo y canal

    \n
    • \n

  • Generación de reportes ejecutivos con métricas completas

    \n
    • \n

  • Monitoreo de cumplimiento de SLA por período

    \n
    • \n

  • Análisis de satisfacción del cliente por grupo

    \n
    • \n

  • Comparación de desempeño entre diferentes protocolos

    \n
    • \n

  • Identificación de tendencias en tiempo de respuesta y atención

    \n
    • \n

  • Evaluación de la eficiencia operativa por grupo

    \n
    • \n

  • Planificación de recursos basada en patrones históricos

    \n
    • \n
\n","urlObject":{"protocol":"https","path":["summary"],"host":["live-public-api","agentbot","net"],"query":[{"key":"from","value":"2025-12-01 00:00:00"},{"key":"to","value":"2025-12-07 23:59:59"},{"key":"frequency","value":"day"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"9e636d08-9cbf-43c2-bbea-720e7ff68b6a"},{"name":"Agent Stats","id":"c7dab44b-cf55-48a3-a217-11038195449d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.agentbot.net/agent/stats?from=2021-12-01 00:00:00&to=2021-12-07 23:59:59","description":"

Get Agent Performance Report

\n

Returns detailed performance metrics and statistics for agents, including conversation handling, response times, feedback scores, and productivity indicators.

\n

Endpoint

\n\n

Request Parameters

\n

Required Parameters

\n
ParameterTypeDescriptionfromstringStart date for the report period (format: ISO 8601 or yyyy-MM-dd)tostringEnd date for the report period (format: ISO 8601 or yyyy-MM-dd)\n\n

Optional Parameters

\n

Common optional parameters apply (refer to general API documentation).

\n

Response

\n

Success Response

\n

Code: 200 OK

\n

Response Structure:

\n

json

\n
[\n    {\n        \"agent\": {\n            \"agent_id\": \"5fa16ad0b7e89a0070b7f302\",\n            \"name\": \"juan bautista\",\n            \"email\": \"\"\n        },\n        \"attended\": 12,\n        \"transfered\": 4,\n        \"close\": 10,\n        \"conversedTime\": \"49:08:44\",\n        \"tmc\": \"04:05:43\",\n        \"avg_response\": \"00:00:00\",\n        \"session_time\": \"155:04:15\",\n        \"pause_time\": \"00:06:03\",\n        \"conected_time\": \"154:58:12\",\n        \"net_time\": \"49:01:50\",\n        \"productivity\": \"31.62%\",\n        \"attended_average\": \"0.08\",\n        \"abandoned_after_threshold\": 0,\n        \"closed_percentages\": \"83.33%\",\n        \"transferred_percentages\": \"33.33%\",\n        \"feedback\": {\n            \"nps\": {\n                \"total\": 0,\n                \"value\": 0,\n                \"positives\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                },\n                \"negatives\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                },\n                \"neutrals\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                }\n            },\n            \"binary\": {\n                \"total\": 0,\n                \"positives\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                },\n                \"negatives\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                }\n            },\n            \"stars\": {\n                \"total\": 0,\n                \"avg\": 0,\n                \"sum\": 0,\n                \"one\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                },\n                \"two\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                },\n                \"three\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                },\n                \"four\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                },\n                \"five\": {\n                    \"total\": 0,\n                    \"avg\": 0\n                }\n            }\n        }\n    }\n]\n\n

Response Fields

\n

Agent Information

\n
FieldTypeDescriptionagentobjectAgent identification and contact informationagent.agent_idstringUnique identifier of the agentagent.namestringFull name of the agentagent.emailstringEmail address of the agent\n\n

Conversation Metrics

\n
FieldTypeDescriptionattendedintegerTotal number of conversations attended by the agenttransferedintegerNumber of conversations transferred to other agents/groupscloseintegerNumber of conversations closed by the agentabandoned_after_thresholdintegerNumber of conversations abandoned after exceeding threshold time\n\n

Time Metrics

\n
FieldTypeDescriptionconversedTimestring (HH:MM:SS)Total time spent in active conversation with userstmcstring (HH:MM:SS)Average conversation handling time (Tiempo Medio de Conversación)avg_responsestring (HH:MM:SS)Average response time to user messagessession_timestring (HH:MM:SS)Total session time (logged in time)pause_timestring (HH:MM:SS)Total time spent in pause/break statusconected_timestring (HH:MM:SS)Total time connected and available (session_time - pause_time)net_timestring (HH:MM:SS)Net productive time in conversations\n\n

Performance Indicators

\n
FieldTypeDescriptionproductivitystringProductivity percentage (net_time / conected_time * 100)attended_averagestringAverage conversations attended per unit of timeclosed_percentagesstringPercentage of attended conversations that were closedtransferred_percentagesstringPercentage of attended conversations that were transferred\n\n

Feedback Metrics

\n
NPS (Net Promoter Score)
\n
FieldTypeDescriptionfeedback.nps.totalintegerTotal number of NPS feedback responsesfeedback.nps.valuenumberOverall NPS score (-100 to 100)feedback.nps.positives.totalintegerNumber of promoters (score 9-10)feedback.nps.positives.avgnumberAverage score of promotersfeedback.nps.negatives.totalintegerNumber of detractors (score 0-6)feedback.nps.negatives.avgnumberAverage score of detractorsfeedback.nps.neutrals.totalintegerNumber of passives (score 7-8)feedback.nps.neutrals.avgnumberAverage score of passives\n\n
Binary Feedback (Thumbs Up/Down)
\n
FieldTypeDescriptionfeedback.binary.totalintegerTotal number of binary feedback responsesfeedback.binary.positives.totalintegerNumber of positive (thumbs up) responsesfeedback.binary.positives.avgnumberAverage positive feedback valuefeedback.binary.negatives.totalintegerNumber of negative (thumbs down) responsesfeedback.binary.negatives.avgnumberAverage negative feedback value\n\n
Star Rating Feedback
\n
FieldTypeDescriptionfeedback.stars.totalintegerTotal number of star rating feedbacksfeedback.stars.avgnumberAverage star rating (0-5)feedback.stars.sumintegerSum of all star ratingsfeedback.stars.one.totalintegerNumber of 1-star ratingsfeedback.stars.one.avgnumberAverage for 1-star categoryfeedback.stars.two.totalintegerNumber of 2-star ratingsfeedback.stars.two.avgnumberAverage for 2-star categoryfeedback.stars.three.totalintegerNumber of 3-star ratingsfeedback.stars.three.avgnumberAverage for 3-star categoryfeedback.stars.four.totalintegerNumber of 4-star ratingsfeedback.stars.four.avgnumberAverage for 4-star categoryfeedback.stars.five.totalintegerNumber of 5-star ratingsfeedback.stars.five.avgnumberAverage for 5-star category\n\n

Notes

\n
    \n

  • The response returns an array of agent performance objects

    \n
    • \n

  • All time values are formatted as HH:MM:SS

    \n
    • \n

  • Percentages are returned as strings with the \"%\" symbol

    \n
    • \n

  • Feedback sections will show 0 values if no feedback was collected during the period

    \n
    • \n

  • tmc (Tiempo Medio de Conversación) represents the average time per conversation

    \n
    • \n

  • Productivity is calculated as: (net_time / conected_time) × 100

    \n
    • \n
\n

Use Cases

\n

This endpoint is useful for:

\n
    \n

  • Evaluating individual agent performance

    \n
    • \n

  • Identifying top performers and training opportunities

    \n
    • \n

  • Analyzing customer satisfaction by agent

    \n
    • \n

  • Monitoring agent workload and capacity

    \n
    • \n

  • Generating performance review reports

    \n
    • \n

  • Optimizing agent schedules and assignments

    \n
    • \n
\n","urlObject":{"protocol":"https","path":["agent","stats"],"host":["live-public-api","agentbot","net"],"query":[{"disabled":true,"key":"","value":""},{"key":"from","value":"2021-12-01 00:00:00"},{"key":"to","value":"2021-12-07 23:59:59"}],"variable":[]}},"response":[],"_postman_id":"c7dab44b-cf55-48a3-a217-11038195449d"},{"name":"ConversationList Detail","id":"c675a1d0-3f1e-4d62-8e5d-c25ee3c23198","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-Token","value":"","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im9TbC1DYkRMamRFWWV0WVU1VTlhaCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6W10sIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDY0NGFiOTVmMjA1MzFhYWQxMjhhZWQ3MyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzk0YmRhMDFhNWI5MTY3OGUwNTNhNGMwY2ZhZmJhNTU0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGbWEucG5nIiwidXBkYXRlZF9hdCI6IjIwMjUtMTItMTBUMTY6MTc6MDguMDk0WiIsImVtYWlsIjoibXNvbGFub0BhaXZvLmNvIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWl2b3Rlc3QuYXV0aDAuY29tLyIsImF1ZCI6Ik10SWlwbEVLak4xVUNxV2l5RjhFbG1pc1hKZ0NOWU1tIiwic3ViIjoiYXV0aDB8NjQ0YWI5NWYyMDUzMWFhZDEyOGFlZDczIiwiaWF0IjoxNzY1MzgzNDMwLCJleHAiOjE3NjU0MTk0MzB9.0b7ru8TL5rnNmsf65fWbukdiJQL41dIR1_sh1MM9zehOs0jbPu-ehFQXoNjWPRc4Zm2CvgbD7drcZVJYJiuUK2slWXNMtbP4NsV-nGvjzvmySgOkHDHW26lF1r8wWxrhXsDBmitSIXWfFDp3jzRakdeWAUfLnhib8a0raZgwwg71ABfp1ax4SUWKcHZZdlLGdVFKwmLRL_5dX3tVzgPi4NvBA-5qjFNULJa5Qm0fqeFXfWf-53kgXtxqP9o7yEbambN6aw4ti2iRjTUA6xNgqdSB06hxd0iFtfIT_D-PNhFAOJ-iGgXYJKVm3RWYrTKmgrLSZLRZOocpYeJBjeUPQg","type":"text"}],"url":"https://live-public-api.agentbot.net/conversation/get/6fa85c39-3cc6-407a-9f1f-c15bfb88f2a1","description":"

Offers the details of the conversation according to the ID of the conversation. From there, you can access all of the queries entered by the user during the course of the conversation, with the respective responses obtained from Live.

\n
    \n

  • URL

    \n

    https://live-public-api.agentbot.net/conversation/get/

    \n
    • \n

  • Method:

    \n

    GET

    \n
    • \n

  • URL Params

    \n
      \n

    • Required parameters:

      \n
        \n
      • id=[integer]: conversation id.
        • \n
      \n
      • \n

    • Optional parameters:

      \n

      Common parameters optional

      \n
      • \n
    \n
    • \n

  • Success Response:

    \n
      \n

    • { \"messages\": [ { \"userId\": \"0\", \"type\": 3, \"timestamp\": \"2019-10-01 12:06:13\", \"message\": \"Bienvenido al Centro de Atención al Cliente online. Mi nombre es Baz ¿Con quién tengo el gusto?\", \"agentId\": 111112 }, { \"userId\": \"7773331\", \"type\": 1, \"timestamp\": \"2019-10-01 12:06:33\", \"message\": \"Mi nombre es Foo\", \"agentId\": 0 }, ]}

      \n
      • \n

    • The response contains an array of these elements

      \n
        \n

      • userId: The ID of the user, if the message was sended by an agent, it will be zero

        \n
        • \n

      • type: The type of the user

        \n
        • \n

      • timestamp: The timestamp of message

        \n
        • \n

      • message: The raw message

        \n
        • \n

      • agentId: The ID of the agent who have sended the message, if the message was sended by a normal user it will be zero

        \n
        • \n
      \n
      • \n
    \n
    • \n
\n","urlObject":{"protocol":"https","path":["conversation","get","6fa85c39-3cc6-407a-9f1f-c15bfb88f2a1"],"host":["live-public-api","agentbot","net"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"c675a1d0-3f1e-4d62-8e5d-c25ee3c23198"}]}