La API de Analytics, disponible para los clientes de Analytics+, te permite extraer métricas de llamadas y usuarios directamente en tus propias herramientas de informes, sin exportar manualmente los datos desde el Panel de control de Aircall. Puedes automatizar extracciones recurrentes con una frecuencia diaria, semanal o mensual, y usar los datos para crear informes personalizados adaptados a tu empresa.
Este artículo explica qué ofrece la API de Analytics, cómo funciona y qué debes tener en cuenta al configurar exportaciones automatizadas.
IMPORTANTE: La API de Analytics está disponible exclusivamente para los clientes que tienen el complemento Analytics+. Si no sabes con certeza si tu plan incluye Analytics+, ponte en contacto con el equipo de éxito del cliente.
Qué puedes exportar
La API te permite acceder a tres categorías de datos:
- Historial de llamadas: Registros detallados de llamadas entrantes y llamadas 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 los volúmenes de llamadas, el tiempo en llamada, el tiempo de trabajo posllamada, los intentos de llamada y el tiempo dedicado a cada estado.
Cada categoría se corresponde con los informes disponibles en tu Panel de control de Aircall. Para consultar la lista completa de informes exportables y los valores de parámetros de API correspondientes, consulta la documentación de la API de Analytics.
Primeros pasos: generar una clave API
Para usar la API de Analytics, necesitas una clave API. Esta clave identifica tu cuenta y autoriza tus solicitudes. Puedes crear y gestionar claves API directamente en el Panel de control de Aircall.
IMPORTANTE: Tu token secreto de API solo se muestra una vez, inmediatamente después de crearlo. Cópialo y guárdalo de forma segura antes de salir de la página, ya que no podrás recuperarlo más adelante.
Pasos:
- Ve a Panel de control de Aircall > Integraciones > Claves API.
- Haz clic en Generar una clave API debajo de la tabla Claves API.
- Asigna a tu clave un nombre reconocible (por ejemplo, el nombre de la herramienta o el script que la utilizará).
- Copia el token secreto de API y guárdalo en una ubicación segura.
Tu clave aparecerá entonces en la lista Claves API. Incluye el token secreto en el encabezado de autorización de tus solicitudes de API. Para obtener todos los detalles técnicos, consulta la documentación de la API de Analytics.
Cómo funciona una exportación
Las exportaciones de 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.
- Solicita la exportación. Especifica el informe que quieres y el intervalo de fechas. La API devuelve un ID de exportación único.
- Comprueba cuándo está lista. Usa el ID de exportación para comprobar el estado de tu solicitud. Cuando el estado figure como completado, el archivo estará listo.
- Descarga el CSV. Obtén el enlace de descarga de la respuesta de estado y descarga tu archivo.
Todo el proceso suele tardar entre unos segundos y unos minutos, en función del intervalo de fechas y el volumen de datos.
IMPORTANTE: El enlace de descarga caduca 1 hora después de generarse. Descarga tu archivo en cuanto esté listo.
Filtros e intervalos de fechas
Cada solicitud de API requiere los siguientes parámetros:
- Tipo de informe: El informe específico que quieres exportar. Consulta la lista completa en la documentación de la API de Analytics.
- Intervalo de fechas: El periodo que debe abarcar la exportación.
- Zona horaria: La zona horaria aplicada a los datos. El valor predeterminado es UTC si no se especifica.
También puedes incluir 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. Consulta la documentación de la API de Analytics para ver la lista completa de cada informe.
IMPORTANTE: Las solicitudes a las que les falte un parámetro obligatorio fallarán. Prueba cada tipo de informe con todos los parámetros obligatorios antes de programar exportaciones automatizadas.
Retención de datos
Los datos exportados abarcan el mismo periodo que los datos visibles en el Panel de control de Aircall:
| Área del informe | Periodo de retención |
|---|---|
| Historial de llamadas | 6 meses |
| User Status History+ | 7 días |
| Actividad de usuario | Ilimitado |
Prácticas recomendadas
Las siguientes recomendaciones se aplican tanto si realizas exportaciones puntuales como si creas un proceso completamente automatizado.
Configura la programación en tu sistema
La API no programa exportaciones automáticamente. Si quieres que las exportaciones se ejecuten con una frecuencia diaria, semanal o mensual, tendrás que configurarlo en tu propio sistema o herramienta de Automatización.
Programa las exportaciones fuera de las horas punta
Siempre que sea posible, inicia las exportaciones automatizadas fuera del horario de atención. Esto reduce el riesgo de retrasos durante los periodos de alta carga de la API y ayuda a garantizar una disponibilidad de datos constante.
Descarga inmediatamente después de cada solicitud
El enlace de descarga caduca después de 1 hora. Configura tu Automatización para que descargue el archivo en cuanto se reciba la respuesta de la API, en lugar de guardar el enlace para recuperarlo más adelante.
Comprueba los límites de filas de tu sistema de destino
La API no impone ningún límite de filas en las exportaciones. Sin embargo, algunas herramientas de importación y aplicaciones de hojas de cálculo limitan el número de filas que pueden procesar. Comprueba los límites de tu sistema de destino antes de ejecutar exportaciones grandes en producción.
Haz pruebas antes de automatizar
Ejecuta manualmente cada tipo de informe antes de programar exportaciones recurrentes. Esto te ayuda a detectar pronto parámetros incorrectos o que faltan, antes de que provoquen fallos silenciosos en un flujo de trabajo automatizado.
Preguntas frecuentes
¿La API incluye un programador integrado?
No. La API devuelve los datos previa solicitud. Tú eres responsable de configurar cualquier Automatización recurrente (diaria, semanal o mensual) en tu sistema.
¿Por qué caduca el enlace de descarga después de 1 hora?
El breve periodo de validez es una medida de seguridad para proteger tus datos. Asegúrate de que tu flujo de trabajo descargue el archivo inmediatamente después de recibir una respuesta correcta de la API.
¿En qué formato 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+. Ponte en contacto con nuestro equipo de éxito del cliente para conocer tus opciones. También puedes solicitar una prueba para explorar el complemento.
Los datos que necesito no aparecen en mi exportación. ¿Qué debo comprobar?
Primero, confirma que el complemento Analytics+ esté activo en tu cuenta. A continuación, comprueba el intervalo de fechas, la zona horaria y los filtros opcionales en 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. Consulta la documentación de la API de Analytics para conocer los parámetros disponibles para cada informe.
¿Hay un límite de filas en las exportaciones?
La API no impone ningún límite de filas. Ten en cuenta que la herramienta de destino puede tener sus propios límites de importación.