Exports planifiés via l'API Analytics

L’API Analytics, disponible pour les clients Analytics+, vous permet d’extraire directement les métriques d’appels et d’utilisateurs 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 base 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 ce qu’il faut garder à l’esprit lors de la configuration des exports automatisés.

Important: L’API Analytics est disponible exclusivement pour les clients ayant l’option Analytics+. Si vous ne savez pas si votre forfait inclut Analytics+, 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 de leurs 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 n’est affiché qu’une seule fois, immédiatement après sa création. Copiez-le et stockez-le en lieu sûr avant de quitter la page, car il ne pourra pas être récupéré plus tard.

Étapes :

1. Accédez à Tableau de bord Aircall > Intégrations & API > Clés API.
2. Cliquez sur Generate an API key sous le tableau des clés API.
3. Donnez à votre clé un nom reconnaissable (par exemple, le nom de l’outil ou du script qui l’utilisera).
4. Copiez le jeton secret API et stockez-le dans un endroit 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 tous les détails techniques, consultez la documentation de l’API Analytics.

Fonctionnement d’un export

Les exports 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’export. Indiquez le rapport souhaité et la plage de dates. L’API renvoie un identifiant d’export unique.
2. Vérifiez quand il est prêt. Utilisez l’identifiant d’export pour vérifier le statut de votre requête. Une fois le statut indiqué comme terminé, votre fichier est prêt.
3. Téléchargez le CSV. Récupérez le lien de téléchargement depuis la réponse de statut et 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’export doit couvrir.
• Fuseau horaire : Le fuseau horaire appliqué aux données. UTC est utilisé par défaut s’il n’est pas précisé.

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 exports automatisés.

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, que vous exécutiez des exports ponctuels ou que vous mettiez en place un pipeline entièrement automatisé.

Configurez la planification de votre côté

L’API ne planifie pas automatiquement les exports. Si vous souhaitez que les exports s’exécutent sur une base quotidienne, hebdomadaire ou mensuelle, vous devrez le configurer dans votre propre système ou outil d’automatisation.

Planifiez les exports en dehors des heures de travail

Dans la mesure du possible, déclenchez les exports automatisés en dehors des heures de travail. Cela réduit le risque de retard pendant les périodes de forte charge API et contribue à 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 réception de la réponse API, plutôt que de stocker le lien pour le récupérer plus tard.

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

L’API n’impose pas de limite de lignes sur les exports. 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 gros exports en production.

Testez avant d’automatiser

Exécutez manuellement chaque type de rapport avant de planifier des exports récurrents. Cela vous aide à détecter tôt les paramètres manquants ou incorrects, avant qu’ils ne provoquent des échecs silencieux dans un flux de travail automatisé.

FAQ

L’API inclut-elle un planificateur intégré ?

Non. L’API renvoie les données sur demande. Il vous incombe de configurer 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 ?

Cette courte durée d’expiration est une mesure de sécurité destinée à protéger vos données. Assurez-vous que votre flux de travail télécharge le fichier immédiatement après une réponse API réussie.

Dans quel format de fichier les exports sont-ils fournis ?

Tous les exports sont fournis au format CSV.

Puis-je utiliser l’API Analytics sans l’option Analytics+ ?

Non. Analytics+ est requis. Contactez notre équipe customer success pour discuter des options disponibles. Vous pouvez également demander un essai pour découvrir l’option.

Les données dont j’ai besoin n’apparaissent pas dans mon export. Que dois-je vérifier ?

Commencez par confirmer que l’option Analytics+ est active 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.

Puis-je filtrer les exports 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.

Y a-t-il une limite de lignes sur les exports ?

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