Rapport historique d'Utilisation de l'API

Le rapport historique sur l'Utilisation de l'API aide les responsables et les administrateurs à comprendre l'utilisation de l'API au fil du temps. Les tendances d'utilisation de haut niveau sont combinées à des données détaillées sur les terminaux afin que vous puissiez suivre les modèles, examiner les changements inattendus et planifier la capacité. Utilisez ce rapport pour :

  • Surveillez les Appels API fréquents au level de l'application cliente.

  • Explorez des points de terminaison spécifiques pour comprendre les modèles d'utilisation.

  • Comprendre les modifications de l'utilisation de l'API au quotidien ou dans le temps.

Le rapport de tendance des indicateurs Analytics est basé sur les données de deux gadgets logiciels :

  • Widget Résumé de l'Utilisation de l'API

  • Widget Détail de l'Utilisation de l'API

Clarissa Dalloway gère les intégrations avec plusieurs systèmes internes qui s'appuient sur des API. Elle est chargée de maintenir ces intégrations stables, sécurisées et prévisibles. Elle souhaite comprendre comment les différentes applications clientes et les points de terminaison utilisent les API au fil du temps afin de pouvoir surveiller la consommation, examiner les modèles inhabituels et planifier la croissance future.

Clarissa ouvre le rapport Historique de l'Utilisation de l'API. Elle consulte le widget Résumé de l'Utilisation de l'API pour examiner le volume d'Appels API par application cliente au cours des 30 derniers jours. Elle recherche des augmentations ou des diminutions qui correspondent à des versions prévues, à des modifications de configuration ou à de nouvelles intégrations mises en ligne. Cela l'aide à confirmer si l'utilisation reste dans les limites prévues ou s'il y a des pics soudains susceptibles de provoquer des problèmes de performance ou de capacité.

Clarissa remarque une augmentation du volume des Appels API qui ne correspond à aucun événement attendu. Ensuite, elle utilise le widget API Usage Detail pour examiner les nombres d'invocations, les points de terminaison, les codes de retour et les ID d'application client le jour de l'augmentation.

Clarissa remarque qu'une application cliente affiche une forte augmentation du nombre d'invocations pour un terminal particulier. Elle utilise les rangées détaillées du widget Détail de l'Utilisation de l'API pour voir quelles méthodes, quels chemins et quelles heures sont responsables du pic, exporte les données pour une analyse plus approfondie, et les partage avec son équipe de développement afin qu'elle puisse ajuster son intégration et gérer la consommation de l'API à l'avenir.

Vous devez disposer des autorisations suivantes :

  • Dashboard > Dashboard Templates > API Usage Historical : Activé

  • Dashboard > Tableaux de bord : afficher

  • Dashboard > Tableaux de bord: Modifier (en option)

Si vous ne pouvez pas accéder aux modèles de rapport ou à Dashboard, ou si les données du widget restent bloquées sur « Chargement en cours », contactez votre administrateur. L'administrateur peut vérifier les autorisations de rapport, de tableau de bord et de widget de votre rôle en accédant à Admin > Réglages de sécurité > Rôles et Autorisations.

Widget Résumé d'Utilisation de l'API

Le widget Résumé de l'Utilisation de l'API fournit un résumé quotidien des volumes d'Appels API par application cliente pour la plage horaire sélectionnée.

À partir de ce widget, vous pouvez :

  • Affichez un résumé du volume d'Appels API pour une ou plusieurs applications clientes au fil du temps.

  • Valider si les modèles de consommation de l'API correspondent au comportement d'intégration attendu.

Ce widget est configuré comme suit :

  • Période par défaut : 30 derniers jours

  • Maximum période : fenêtre de 95 jours

  • Sélecteur de métriques : Aucun

Les filtres supplémentaires pour ce widget comprennent les éléments suivants :

  • Aucun

Le tableau ci-dessous décrit les colonnes de ce widget :

Nom de colonne

Description

Date

Date du calendrier à laquelle les Appels API ont eu lieu.

Id de l'application cliente

Identifiant unique de l'application cliente ayant effectué l'Appel API.

Nom de l’application client

Nom d'affichage de l'application cliente ayant effectué l'Appel API.

Nombre d’appels API

Total du nombre d'Appels API effectués par l'application client à la date indiquée.

Widget Détail de l'Utilisation de l'API

Le widget Détail de l'Utilisation de l'API fournit des informations détaillées sur l'utilisation de l'API pour chaque application cliente, date, heure, méthode HTTP et terminal.

À partir de ce widget, vous pouvez :

  • Concentrez-vous sur des applications ou méthodes client spécifiques pour comprendre leurs modèles d'utilisation détaillés.

  • Exportez les données au format CSV ou Excel pour une analyse plus approfondie ou pour les partager avec d'autres équipes.

Ce widget est configuré comme suit :

  • **période par défaut** : Aujourd’hui

  • Maximum période : fenêtre de 95 jours

  • Sélecteur de métriques : Aucun

Les filtres supplémentaires pour ce widget sont les suivants :

  • Méthode

Le tableau ci-dessous décrit les colonnes de ce widget :

Nom de colonne

Description

Date

Date du calendrier de l'utilisation de l'API.

Heure

Estampille temporelle de l'utilisation de l'API.

ID d'application cliente

Identifiant unique de l'application cliente ayant déclenché l'Appel API.

Nom de l’application client

Nom d'affichage de l'application client associée à l'utilisation de l'API.

Méthode

Méthode HTTP utilisée dans la demande API.

Chemin d’accès API

Chemin du terminal de l'API qui a été appelé.

Return Code

Code de retour HTTP de la réponse de l'API.

Nombre d'invocations des clients

Nombre de fois où le terminal a été invoqué pour la date, l'heure, l'application cliente, la méthode et le code de retour donnés.