Rapport historique sur l'Utilisation des API

Le rapport historique sur l'Utilisation des API aide les gestionnaires et les administrateurs à comprendre l'utilisation des 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 tendances, examiner les changements inattendus et planifier la capacité. Utilisez ce rapport pour :

  • Surveiller les Appels API fréquents au niveau de l'application cliente.

  • Explorer des terminaux spécifiques pour comprendre les tendances d'utilisation.

  • Comprendre comment l'utilisation des API change d'un jour à l'autre ou au fil du temps.

Le rapport sur les tendances de la métrique Analytics est basé sur les données de deux gadgets logiciels :

  • Gadget logiciel Résumé de l'Utilisation des API

  • Gadget logiciel Détail de l'Utilisation des API

Clarissa Dalloway gère des intégrations avec plusieurs systèmes internes qui dépendent des API. Elle est responsable de maintenir ces intégrations stables, sécurisées et prévisibles. Elle veut comprendre comment différentes applications clientes et différents terminaux utilisent les API au fil du temps afin de pouvoir surveiller la consommation, examiner les tendances inhabituelles et planifier la croissance future.

Clarissa ouvre le rapport historique sur l'Utilisation des API. Elle consulte le gadget logiciel Résumé de l'Utilisation des API pour examiner le volume d'Appels API par application cliente au cours des 30 derniers jours. Elle cherche des augmentations ou des diminutions qui correspondent aux versions attendues, aux changements de configuration ou aux nouvelles intégrations mises en service. Cela l'aide à confirmer si l'utilisation se situe dans les limites attendues ou si des pics soudains pourraient 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 gadget logiciel Détail de l'Utilisation des API pour examiner les comptes d'invocation, les terminaux, les codes de retour et les identifiants d'applications clientes le jour de l'augmentation.

Clarissa remarque qu'une application cliente affiche une forte augmentation du compte d'invocation pour un terminal particulier. Elle utilise les rangées détaillées du gadget logiciel Détail de l'Utilisation des 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 d'API à l'avenir.

Vous devez disposer de ces autorisations :

  • Dashboard > Modèles de tableaux de bord > Rapport historique sur l'Utilisation des API : Activé

  • Dashboard > Tableaux de bord : Afficher

  • Dashboard > Tableaux de bord : Modifier (facultatif)

Si vous ne pouvez pas accéder aux modèles de rapports ou Dashboard, ou si les données du widget ne se chargent pas, communiquez avec votre administrateur. L'administrateur peut vérifier les autorisations de rapports, de tableau de bord et de widget de votre rôle en visitant 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.

Pour ce gadget logiciel, vous pouvez :

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

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

Ce widget est configuré comme suit :

  • période par défaut : Derniers 30 jours

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

  • Sélecteur de métriques : None (Aucun)

Les filtres supplémentaires pour ce widget comprennent :

  • None (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 d'application cliente

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

Nom de l’application cliente

Nom d’affichage de l’application cliente qui a effectué l’Appel API.

Nombre d’appels API

Nombre total d’Appels API effectués par l’application cliente à la date donnée.

Gadget logiciel Détail de l’Utilisation de l’API

Le gadget logiciel Détail de l’Utilisation de l’API fournit des renseignements détaillés sur l’utilisation de l’API pour chaque application cliente, date, heure, méthode HTTP et terminal.

Pour ce gadget logiciel, vous pouvez :

  • Se concentrer sur des applications clientes ou des méthodes spécifiques pour comprendre leurs habitudes d’utilisation détaillées.

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

Ce gadget logiciel est configuré comme suit :

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

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

  • Sélecteur de mesures : None (Aucun)

Les filtres additionnels de ce gadget logiciel comprennent :

  • Méthode

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

Nom de colonne

Description

Date

Date civile de l’utilisation de l’API.

Heure

Estampille temporelle de l'utilisation de l'API.

ID de l'application cliente

Identifiant unique de l'application cliente qui a lancé l'Appel API.

Nom de l’application cliente

Afficher le nom de l'application cliente 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 API qui a été appelé.

Code de retour

Code de retour HTTP de la réponse API.

Nombre d'invocations

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.