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 aux données détaillées des 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 niveau de l'application cliente.
-
Explorez des points de terminaison spécifiques pour comprendre les modèles d'utilisation.
-
Comprenez comment les modifications de l'utilisation de l'API évoluent au jour le jour ou au fil du temps.
Le rapport de tendance des métriques 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 veiller à ce que ces intégrations restent stables, sécurisées et prévisibles. Elle souhaite comprendre comment les différentes applications clientes et les points de terminaison utilisent les API dans le 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 client au cours des 30 derniers jours. Elle recherche les augmentations ou diminutions qui correspondent à des versions attendues, à des modifications de configuration ou à de nouvelles intégrations mises en ligne. Cela l'aide à confirmer si l'utilisation se situe dans les limites attendues ou s'il y a des pics soudains susceptibles de causer des problèmes de performance ou de capacité.
Clarissa remarque une augmentation du volume d'Appels API qui ne correspond à aucun événement attendu. Ensuite, elle utilise le widget détails de l'Utilisation de l'API pour examiner le nombre 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 présente 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 déterminer 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 > Modèles de tableaux de bord > Historique de l'Utilisation de l'API : Activé
-
Dashboard > Tableaux de bord : Voir
-
Dashboard > Tableaux de bord : Modifier (en option)
Si vous ne pouvez pas accéder aux modèles de reporting ou Dashboard, ou si les données du widget restent en Chargement en cours, contactez votre administrateur. L'administrateur peut vérifier les autorisations de reporting, 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é de l'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 :
-
Voir un résumé du volume d'Appels API sur 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 incluent :
-
Aucun
Le tableau ci-dessous décrit les colonnes de ce widget :
|
Nom de colonne |
Description |
|---|---|
|
Date |
Calendrier de la date à laquelle les Appels API se sont produits. |
|
ID de l'application cliente |
Identifiant unique de l'application cliente qui a effectué l'Appel API. |
|
Nom de l’application client |
Nom d'affichage de l'application client qui a effectué l'Appel API. |
|
Nombre d’appels API |
Total du nombre d'Appels API effectués par l'application client à la date donné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 des 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 un partage 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 incluent :
-
Méthode
Le tableau ci-dessous décrit les colonnes de ce widget :
|
Nom de colonne |
Description |
|---|---|
|
Date |
Date de calendrier de l'utilisation de l'API. |
|
Heure |
Estampille temporelle de l'utilisation de l'API. |
|
ID de l'application client |
Identifiant unique de l'application cliente ayant initié l'Appel API. |
|
Nom de l’application cliente |
Nom d'affichage de l'application client associée à l'utilisation de l'API. |
|
Méthode |
Méthode HTTP utilisée dans la demande d'API. |
|
Chemin 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. |