Collecter des analyses pour une API

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 1 minute de lecture

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

    Avant de commencer

    Remarque :
    L’analyse d’API n’est pas disponible pour certaines API utilisées pour les fonctionnalités internes de la plateforme, telles que les API d’interface utilisateur et d’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 de nouveaux enregistrements de liste d’inclusion pour configurer manuellement les API et les informations sur le 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 des listes d’inclusion des statistiques de transactions de l’API
    Champ Description
    Nom de l'API Pour les API REST, entrez 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 les configurations de journalisation distinctes pour différentes API. Vous pouvez configurer la journalisation pour toutes les API SOAP en modifiant l’enregistrement de la liste d’inclusion des API SOAP.
    Collecter les statistiques d’API Cochez cette case pour suivre les analyses pour l’API spécifiée.
    Collecter les statistiques des demandeurs d’API Cochez cette case pour suivre les utilisateurs qui adressent des demandes à cette API. Cette option n’est disponible que si l’option Collecter les statistiques d’API est sélectionnée.