Tableaux de bord d’analyse des API REST et SOAP

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 1 minute de lecture

    • Vous pouvez afficher l’analyse de l’API pour l’ensemble de l’instance ou pour des API spécifiques à l’aide des tableaux de bord inclus.

    L’analyse des API REST ET SOAP comprend des tableaux de bord qui présentent l’analyse globale, l’analyse par API et l’analyse par utilisateur demandeur.

    Pour accéder aux tableaux de bord API Analytics, accédez à System Web Services et sélectionnez Vue d’ensemble de l’utilisation, Utilisation par API ou Utilisation par demandeur. Les utilisateurs disposant des rôles api_analytics_read ou admin peuvent afficher ces tableaux de bord.
    Remarque :
    Le tableau de bord Utilisation par demandeur utilise la fonctionnalité Canevas réactif disponible avec Istanbul. Pour une expérience optimale sur les instances mises à niveau, vous devrez peut-être activer des tableaux de bord réactifs.
    Les tableaux de bord suivants sont disponibles :
    Tableau 1. Tableaux de bord d’analyse d’API disponibles
    Tableau de bord Description
    Vue d'ensemble de l'utilisation Fournit des statistiques générales d’utilisation pour toutes les API REST et SOAP.
    Utilisation par l'API Web Fournit des statistiques d’utilisation détaillées pour chaque API.
    Utilisation par demandeur Fournit des statistiques d’utilisation détaillées pour chaque utilisateur demandeur.

    Vous pouvez également filtrer par API pour afficher des statistiques détaillées pour une combinaison d’utilisateur et d’API spécifique. Si l’utilisateur sélectionné n’a pas effectué de demandes à l’API sélectionnée, aucune donnée n’est affichée pour cette combinaison.

    Remarque :
    Pour afficher les statistiques d’API pour tous les utilisateurs, ne désélectionnez pas la sélection de répartition des utilisateurs. Utilisez plutôt le tableau de bord Utilisation par l’API Web.

    Vous pouvez accéder à l’analyse d’API à partir de l’explorateur d’API REST. Lorsque vous explorez une API, cliquez sur l’icône du menu contextuel ( icône du menu contextuel), puis sélectionnez API Analytics pour afficher les analyses de cette API spécifique.

    Pour les services Web personnalisés, tels que les API REST scriptées ou les services Web SOAP scriptés, vous pouvez accéder à l’analyse de l’API en cliquant sur le lien connexe Analyse de l’API sur les formulaires Service REST scripté ou Service Web scripté.

    Lorsque vous accédez directement à l’analyse pour une API, s’il n’existe aucune analyse pour cette API spécifique, l’analyse de toutes les API s’affiche.