Erfasst Analysen für eine API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 1 Minute Lesedauer

    • Wählen Sie aus, für welche APIs Analysen erfasst werden sollen, und legen Sie fest, ob Informationen zur anfordernden Person für jede API erfasst werden sollen.

    Vorbereitungen

    Hinweis:
    API-Analysen sind für bestimmte APIs, die für interne Plattformfunktionen verwendet werden, nicht verfügbar, z. B. die UI- und Mobile-App-APIs.
    Erforderliche Rolle: api_analytics_read oder admin

    Warum und wann dieser Vorgang ausgeführt wird

    Wenn eine neue API hinzugefügt wird, wird automatisch ein Aufnahmelistendatensatz erstellt. Sie können Datensätze für Aufnahmelisten ändern oder neue erstellen, um manuell zu konfigurieren, welche APIs und Anfordererinformationen protokolliert werden.

    Prozedur

    Navigieren zu Alle > System-Webservices > Aufnahmeliste und erstellen Sie einen neuen Datensatz.
    Tabelle : 1. API-Transaktionsstatistik-Einschlusslistenfelder
    Feld Beschreibung
    API-Name Geben Sie für REST-APIs den API-Namen ein. Dieser Name sollte nur den Namespace und die ID der API enthalten. Fügen Sie keine Anforderungsparameter in den API-Namen ein.

    Zum Beispiel sind für die Table-API-Endpunkte api/now/table/incident und api/now/table/problem der Namespace und die ID now/table.

    SOAP-APIs unterstützen keine separaten Protokollierungskonfigurationen für verschiedene APIs. Sie können die Protokollierung für alle SOAP-APIs konfigurieren, indem Sie den Aufnahmelistendatensatz der SOAP-APIs ändern.
    API-Statistiken sammeln Aktivieren Sie diese Checkbox, um die Analyse der angegebenen API zu verfolgen.
    API-Statistiken der anfordernden Person sammeln Aktivieren Sie dieses Checkbox, um zu verfolgen, welche Benutzer Anforderungen an diese API stellen. Diese Option ist nur verfügbar, wenn API-Statistiken sammeln ausgewählt ist.