L’API Analytics, disponible pour les clients Analytics+, vous permet d’extraire les métriques d’appels et d’utilisateurs directement dans vos propres outils de reporting, sans exporter manuellement les données depuis le tableau de bord Aircall. Vous pouvez automatiser des extractions récurrentes sur une cadence quotidienne, hebdomadaire ou mensuelle et utiliser les données pour créer des rapports personnalisés adaptés à votre activité.
Cet article explique ce que l’API Analytics propose, comment elle fonctionne et les points à garder à l’esprit lors de la mise en place d’exportations automatisées.
Important: L’API Analytics est disponible exclusivement pour les clients disposant du module complémentaire A+. Si vous ne savez pas si votre forfait inclut A+, contactez l’équipe customer success.
Ce que vous pouvez exporter
L’API vous donne accès à trois catégories de données :
- Historique d'appels : Enregistrements détaillés des appels entrants et sortants.
- User Status History+ : Un journal du statut de disponibilité des agents au fil du temps.
- Activité utilisateurs : Un ensemble de métriques de performance par utilisateur, y compris les volumes d’appels, le temps en appel, le temps de traitement post-appel, les tentatives de sonnerie et le temps passé dans chaque statut.
Chaque catégorie correspond aux rapports disponibles dans votre tableau de bord Aircall. Pour la liste complète des rapports exportables et leurs valeurs de paramètres API correspondantes, consultez la documentation de l’API Analytics.
Filtres et paramètres
Chaque requête API nécessite les paramètres suivants :
- Type de rapport : Le rapport spécifique que vous souhaitez exporter. Consultez la liste complète dans la documentation de l’API Analytics.
- Plage de dates : La période que l’exportation doit couvrir.
- Fuseau horaire : Le fuseau horaire appliqué aux données. Par défaut, UTC est utilisé s’il n’est pas spécifié.
Vous pouvez également transmettre des filtres facultatifs pour affiner les résultats, correspondant aux filtres disponibles pour chaque rapport dans le tableau de bord Aircall. Les filtres facultatifs disponibles varient selon le type de rapport. Consultez la documentation de l’API Analytics pour la liste complète par rapport.
Important: Les requêtes auxquelles il manque un paramètre obligatoire échoueront. Testez chaque type de rapport avec tous les paramètres requis avant de planifier des exportations automatisées.
Fonctionnement de l’API
L’API suit un flux simple de requête et de téléchargement :
Étapes :
- Authentifiez votre requête à l’aide de vos identifiants API. Vous pouvez les trouver dans votre tableau de bord Aircall, sous Intégrations & API.
- Appelez le point de terminaison unique en transmettant le type de rapport choisi, une plage de dates obligatoire et un fuseau horaire comme paramètres.
- Recevez une réponse contenant un lien pré-signé vers un fichier CSV.
- Téléchargez le CSV depuis ce lien. Le lien expire 1 heure après sa génération, alors concevez votre processus pour télécharger immédiatement après chaque réponse réussie.
La planification n’est pas intégrée à l’API. Si vous souhaitez des exportations quotidiennes, hebdomadaires ou mensuelles, vous devez mettre en place cette automatisation de votre côté à l’aide de votre propre infrastructure ou d’un outil de planification tiers.
Pour l’authentification, les détails du point de terminaison et la référence complète des paramètres, consultez la documentation de l’API Analytics.
Conservation des données
Les données disponibles via l’API suivent les mêmes limites de conservation que le tableau de bord Aircall :
| Catégorie de données | Période de conservation |
|---|---|
| Historique d'appels | 6 mois |
| User Status History+ | 7 jours |
| Activité utilisateurs | Illimitée |
Bonnes pratiques
Les recommandations suivantes s’appliquent aussi bien si vous exécutez des exportations ponctuelles que si vous construisez un pipeline entièrement automatisé.
Planifiez les exportations en dehors des heures de travail
Lorsque c’est possible, déclenchez les exportations automatisées en dehors des heures de travail. Cela réduit le risque de retards pendant les périodes de forte charge de l’API et aide à garantir une disponibilité cohérente des données.
Téléchargez immédiatement après chaque requête
Le lien de téléchargement expire après 1 heure. Concevez votre automatisation pour télécharger le fichier dès que la réponse API est reçue, plutôt que de stocker le lien pour une récupération ultérieure.
Vérifiez les limites de lignes de votre système de destination
L’API n’impose pas de limite de lignes sur les exportations. Cependant, certains outils d’importation et tableurs limitent le nombre de lignes qu’ils peuvent traiter. Vérifiez les limites de votre système de destination avant d’exécuter de grandes exportations en production.
Testez avant d’automatiser
Exécutez manuellement chaque type de rapport avant de planifier des exportations récurrentes. Cela vous aide à détecter rapidement les paramètres manquants ou incorrects, avant qu’ils ne provoquent des échecs silencieux dans un processus automatisé.
FAQ
L’API inclut-elle un planificateur intégré ?
Non. L’API renvoie les données sur demande. Vous êtes responsable de la mise en place de toute automatisation récurrente (quotidienne, hebdomadaire, mensuelle) de votre côté.
Pourquoi le lien de téléchargement expire-t-il après 1 heure ?
La courte durée d’expiration est une mesure de sécurité destinée à protéger vos données. Assurez-vous que votre processus télécharge le fichier immédiatement après une réponse API réussie.
Puis-je utiliser l’API Analytics sans le module complémentaire A+ ?
Non. A+ est requis. Contactez notre équipe customer success pour discuter de vos options. Vous pouvez également demander un essai pour découvrir le module complémentaire.
Les données dont j’ai besoin n’apparaissent pas dans mon exportation. Que dois-je vérifier ?
Tout d’abord, confirmez que le module complémentaire concerné (User Status History+ ou Activité utilisateurs) est actif sur votre compte. Vérifiez ensuite votre plage de dates, votre fuseau horaire et tous les filtres facultatifs par rapport à la documentation de l’API Analytics.