Exports planifiés via l’API Analytics

L’API Analytics, disponible pour les clients Analytics+, vous permet d’importer 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 les extractions récurrentes à une fréquence quotidienne, hebdomadaire ou mensuelle et utiliser les données pour créer des rapports personnalisés adaptés à votre entreprise.

Cet article présente les fonctionnalités de l’API Analytics, son fonctionnement et les éléments à prendre en compte lors de la configuration d’exportations automatisées.

Important: L’API Analytics est exclusivement disponible pour les clients disposant du module complémentaire Analytics+. Si vous ne savez pas si votre forfait inclut Analytics+, contactez l’équipe Customer Success.

Données 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 des appels sortants.
• User Status History+ : journal du statut de disponibilité des agents au fil du temps.
• Activité utilisateurs : ensemble de métriques de performance par utilisateur, notamment le volume d’appels, le temps passé 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 obtenir la liste complète des rapports exportables et des valeurs de paramètres API correspondantes, consultez la documentation de l’API Analytics.

Premiers pas : générer une clé API

Pour utiliser l’API Analytics, vous avez besoin d’une clé API. Cette clé identifie votre compte et autorise vos requêtes. Vous créez et gérez les clés API directement dans le tableau de bord Aircall.

Important: Votre jeton secret API ne s’affiche qu’une seule fois, immédiatement après sa création. Copiez-le et conservez-le en lieu sûr avant de quitter la page, car vous ne pourrez pas le récupérer ultérieurement.

Étapes :

1. Accédez à Tableau de bord Aircall > Intégrations > clés API.
2. Cliquez sur Générer une clé API sous le tableau des clés API.
3. Donnez à votre clé un nom facilement reconnaissable (par exemple, celui de l’outil ou du script qui l’utilisera).
4. Copiez le jeton secret API et conservez-le dans un emplacement sécurisé.

Votre clé apparaîtra ensuite dans la liste des clés API. Transmettez le jeton secret dans l’en-tête d’autorisation de vos requêtes API. Pour obtenir tous les détails techniques, consultez la documentation de l’API Analytics.

Fonctionnement d’une exportation

Les exportations depuis l’API Analytics suivent un processus simple en trois étapes. Les données sont préparées de manière asynchrone, ce qui signifie que le fichier est généré en arrière-plan au lieu d’être renvoyé instantanément.

1. Demandez l’exportation. Indiquez le rapport souhaité et la plage de dates. L’API renvoie un identifiant d’exportation unique.
2. Vérifiez quand elle est prête. Utilisez l’identifiant d’exportation pour vérifier le statut de votre requête. Lorsque le statut indique qu’elle est terminée, votre fichier est prêt.
3. Téléchargez le fichier CSV. Récupérez le lien de téléchargement dans la réponse de statut, puis téléchargez votre fichier.

L’ensemble du processus prend généralement de quelques secondes à quelques minutes, selon la plage de dates et le volume de données.

Important: Le lien de téléchargement expire 1 heure après sa génération. Téléchargez votre fichier dès qu’il est prêt.

Filtres et plages de dates

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, conformément 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 obtenir 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.

Conservation des données

Les données exportées couvrent la même période que celle visible dans le tableau de bord Aircall :

Bonnes pratiques

Les recommandations suivantes s’appliquent aussi bien aux exportations ponctuelles qu’à la création d’un pipeline entièrement automatisé.

Configurez la planification de votre côté

L’API ne planifie pas automatiquement les exportations. Si vous souhaitez les exécuter à une fréquence quotidienne, hebdomadaire ou mensuelle, vous devez configurer cette planification dans votre propre système ou outil d’automatisation.

Planifiez les exportations pendant les heures creuses

Dans la mesure du 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 sollicitation de l’API et contribue à garantir une disponibilité constante des données.

Téléchargez immédiatement après chaque requête

Le lien de téléchargement expire après 1 heure. Configurez votre automatisation afin qu’elle télécharge le fichier dès la réception de la réponse de l’API, au lieu de conserver le lien pour le récupérer ultérieurement.

Vérifiez les limites de lignes de votre système de destination

L’API n’impose aucune limite de lignes aux 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 des exportations volumineuses en production.

Effectuez des tests 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 n’entraînent 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 configuration de toute automatisation récurrente (quotidienne, hebdomadaire ou 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é visant à protéger vos données. Assurez-vous que votre processus télécharge le fichier immédiatement après une réponse positive de l’API.

Dans quel format de fichier les exportations sont-elles fournies ?

Toutes les exportations sont fournies sous forme de fichiers CSV.

Puis-je utiliser l’API Analytics sans le module complémentaire Analytics+ ?

Non. Analytics+ est requis. Contactez notre équipe chargée de la réussite client pour discuter des options qui s’offrent à vous. Vous pouvez également demander un essai pour découvrir le module complémentaire.

Les données dont j’ai besoin ne figurent pas dans mon exportation. Que dois-je vérifier ?

Tout d’abord, vérifiez que le module complémentaire Analytics+ est actif sur votre compte. Vérifiez ensuite votre plage de dates, votre fuseau horaire et les éventuels filtres facultatifs en consultant la documentation de l’API Analytics.

Puis-je filtrer les exportations par utilisateur ou par équipe ?

La plupart des rapports prennent en charge des filtres facultatifs. Consultez la documentation de l’API Analytics pour connaître les paramètres disponibles pour chaque rapport.

Existe-t-il une limite de lignes pour les exportations ?

L’API elle-même n’impose aucune limite de lignes. Gardez à l’esprit que votre outil de destination peut avoir ses propres limites d’importation.