Collecter des analyses pour une API

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 1 minute de lecture

    • Sélectionnez les API pour lesquelles collecter des analyses et indiquez si des informations sur le demandeur doivent être collectées pour chaque API.

    Avant de commencer

    Remarque :
    L’analyse des API n’est pas disponible pour certaines API utilisées pour les fonctionnalités internes de la plateforme, telles que les API de l’interface utilisateur et de l’application mobile.
    Rôle requis : api_analytics_read ou admin

    Pourquoi et quand exécuter cette tâche

    Lorsqu’une nouvelle API est ajoutée, un enregistrement de liste d’inclusion est créé automatiquement. Vous pouvez modifier ou créer des enregistrements de liste d’inclusion pour configurer manuellement les API et les informations du demandeur qui sont journalisées.

    Procédure

    Accédez à la Tout > Services web du système > Liste d'inclusions et créez un nouvel enregistrement.
    Tableau 1. Champs Liste d’inclusion des statistiques de transactions de l’API
    Champ Description
    Nom d'API Pour API REST, saisissez le nom de l’API. Ce nom doit contenir uniquement l’espace de noms et l’ID de l’API. N’incluez aucun paramètre de demande dans le nom de l’API.

    Par exemple, pour les points de terminaison d’API de table api/now/table/incident et api/now/table/problem, l’espace de noms et l’ID sont now/table.

    Les API SOAP ne prennent pas en charge des configurations de journalisation distinctes pour différentes API. Vous pouvez configurer la journalisation de toutes les API SOAP en modifiant l’enregistrement de la liste d’inclusion des API SOAP.
    Collecter les statistiques de l’API Cochez cette case pour suivre l’analyse de l’API spécifiée.
    Collecter les statistiques des demandeurs d’API Cochez cette case pour savoir quels utilisateurs envoient des demandes à cette API. Cette option n’est disponible que si l’option Collecter les statistiques de l’API est sélectionnée.