La API de Analytics, disponible para los clientes de Analytics+, le permite extraer métricas de llamadas y de usuarios directamente a sus propias herramientas de informes, sin exportar datos manualmente desde el Panel de control de Aircall. Puede automatizar extracciones recurrentes con una frecuencia diaria, semanal o mensual y usar los datos para crear informes personalizados adaptados a su empresa.
Este artículo explica qué ofrece la API de Analytics, cómo funciona y qué debe tener en cuenta al configurar exportaciones automatizadas.
Importante: La API de Analytics está disponible exclusivamente para clientes con el complemento Analytics+. Si no está seguro de si su plan incluye Analytics+, contacte con el equipo de customer success.
Qué puede exportar
La API le da acceso a tres categorías de datos:
- Historial de llamadas: Registros detallados de llamadas entrantes y salientes.
- User Status History+: Un registro del estado de disponibilidad de los agentes a lo largo del tiempo.
- Actividad de usuario: Un conjunto de métricas de rendimiento por usuario, incluidos volúmenes de llamadas, tiempo en llamada, tiempo de trabajo posllamada, intentos de timbrado y tiempo dedicado en cada estado.
Cada categoría corresponde a los informes disponibles en su Panel de control de Aircall. Para consultar la lista completa de informes exportables y sus valores de parámetros API correspondientes, consulte la documentación de la API de Analytics.
Primeros pasos: generar una clave API
Para usar la API de Analytics, necesita una clave API. Esta clave identifica su cuenta y autoriza sus solicitudes. Puede crear y administrar claves API directamente en el Panel de control de Aircall.
Importante: Su token secreto de API se muestra solo una vez, inmediatamente después de crearlo. Cópielo y guárdelo de forma segura antes de salir de la página, ya que no podrá recuperarse más tarde.
Pasos:
- Vaya a Panel de control de Aircall > Integraciones & API > Claves API.
- Haga clic en Generar una clave API debajo de la tabla de Claves API.
- Asigne a su clave un nombre reconocible (por ejemplo, el nombre de la herramienta o script que la usará).
- Copie el token secreto de API y guárdelo en un lugar seguro.
Su clave aparecerá entonces en la lista de Claves API. Pase el token secreto en el encabezado de autorización de sus solicitudes API. Para conocer todos los detalles técnicos, consulte la documentación de la API de Analytics.
Cómo funciona una exportación
Las exportaciones desde la API de Analytics siguen un sencillo proceso de tres pasos. Los datos se preparan de forma asíncrona, lo que significa que el archivo se genera en segundo plano en lugar de devolverse al instante.
- Solicite la exportación. Especifique qué informe quiere y el intervalo de fechas. La API devuelve un ID de exportación único.
- Compruebe cuándo está lista. Use el ID de exportación para comprobar el estado de su solicitud. Una vez que el estado aparezca como completado, su archivo estará listo.
- Descargue el CSV. Recupere el enlace de descarga desde la respuesta de estado y descargue su archivo.
Por lo general, todo el proceso tarda de unos segundos a unos minutos, según el intervalo de fechas y el volumen de datos.
Importante: El enlace de descarga vence 1 hora después de generarse. Descargue su archivo en cuanto esté listo.
Filtros e intervalos de fechas
Todas las solicitudes API requieren los siguientes parámetros:
- Tipo de informe: El informe específico que desea exportar. Consulte la lista completa en la documentación de la API de Analytics.
- Intervalo de fechas: El período de tiempo que debe cubrir la exportación.
- Zona horaria: La zona horaria aplicada a los datos. De forma predeterminada, es UTC si no se especifica.
También puede pasar filtros opcionales para limitar los resultados, que coinciden con los filtros disponibles para cada informe en el Panel de control de Aircall. Los filtros opcionales disponibles varían según el tipo de informe. Consulte la documentación de la API de Analytics para ver la lista completa por informe.
Importante: Las solicitudes a las que les falte un parámetro obligatorio fallarán. Pruebe cada tipo de informe con todos los parámetros requeridos antes de programar exportaciones automatizadas.
Retención de datos
Los datos exportados cubren el mismo período que el visible en el Panel de control de Aircall:
| Área del informe | Período de retención |
|---|---|
| Historial de llamadas | 6 meses |
| User Status History+ | 7 días |
| Actividad de usuario | Ilimitado |
Buenas prácticas
Las siguientes recomendaciones se aplican tanto si ejecuta exportaciones puntuales como si crea un flujo totalmente automatizado.
Configure la programación de su lado
La API no programa exportaciones automáticamente. Si desea que las exportaciones se ejecuten con una frecuencia diaria, semanal o mensual, tendrá que configurarlo en su propio sistema o herramienta de automatización.
Programe las exportaciones fuera del horario de atención
Cuando sea posible, active las exportaciones automatizadas fuera del horario de atención. Esto reduce el riesgo de retrasos durante períodos de alta carga de API y ayuda a garantizar una disponibilidad de datos constante.
Descargue inmediatamente después de cada solicitud
El enlace de descarga vence después de 1 hora. Diseñe su automatización para descargar el archivo en cuanto se reciba la respuesta de la API, en lugar de guardar el enlace para recuperarlo más tarde.
Compruebe los límites de filas de su sistema de destino
La API no impone un límite de filas en las exportaciones. Sin embargo, algunas herramientas de importación y aplicaciones de hojas de cálculo limitan la cantidad de filas que pueden procesar. Verifique los límites de su sistema de destino antes de ejecutar exportaciones grandes en producción.
Pruebe antes de automatizar
Ejecute manualmente cada tipo de informe antes de programar exportaciones recurrentes. Esto le ayuda a detectar pronto parámetros faltantes o incorrectos, antes de que causen fallos silenciosos en un flujo de trabajo automatizado.
Preguntas frecuentes
¿La API incluye un programador integrado?
No. La API devuelve datos a petición. Usted es responsable de configurar cualquier automatización recurrente (diaria, semanal, mensual) de su lado.
¿Por qué el enlace de descarga vence después de 1 hora?
La corta caducidad es una medida de seguridad para proteger sus datos. Asegúrese de que su flujo de trabajo descargue el archivo inmediatamente después de una respuesta correcta de la API.
¿En qué formato de archivo se entregan las exportaciones?
Todas las exportaciones se entregan como archivos CSV.
¿Puedo usar la API de Analytics sin el complemento Analytics+?
No. Se requiere Analytics+. Póngase en contacto con nuestro equipo de customer success para analizar sus opciones. También puede solicitar una prueba para explorar el complemento.
Los datos que necesito no aparecen en mi exportación. ¿Qué debo comprobar?
Primero, confirme que el complemento Analytics+ esté activo en su cuenta. Luego verifique su intervalo de fechas, zona horaria y cualquier filtro opcional con la documentación de la API de Analytics.
¿Puedo filtrar las exportaciones por usuario o equipo?
La mayoría de los informes admiten filtros opcionales. Consulte la documentación de la API de Analytics para ver los parámetros disponibles para cada informe.
¿Existe un límite de filas en las exportaciones?
La propia API no impone un límite de filas. Tenga en cuenta que su herramienta de destino puede tener sus propios límites de importación.
Estado de Aircall
Ayuda para iniciar sesión