Sammeln Sie Analytics für eine API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 1 Minute Lesedauer

    • Wählen Sie aus, für welche APIs Analytics erfasst werden sollen, und wählen Sie aus, ob Informationen der anfordernden Person für jede API erfasst werden sollen.

    Vorbereitungen

    Hinweis:
    API-Analytics ist für bestimmte APIs, die für interne Plattformfunktionen verwendet werden, wie die UI- und Mobile-App-APIs nicht verfügbar.
    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 Aufnahmelistendatensätze ändern oder neu erstellen, um manuell zu konfigurieren, welche APIs und Informationen der anfordernden Person protokolliert werden.

    Prozedur

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

    Beispiel: Für die Tabellen-API-Endpunkte api/now/table/Incident Und api/now/table/Problem , Der Namespace und die ID sind 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 Datensatz der SOAP-APIs-Aufnahmeliste ändern.
    Sammeln Sie API-Statistiken Aktivieren Sie dieses Kontrollkästchen, um Analytics für die angegebene API nachzuverfolgen.
    Sammeln Sie API-Anforderungsstatistiken Aktivieren Sie dieses Kontrollkästchen, um nachzuverfolgen, welche Anwender Anforderungen an diese API stellen. Diese Option ist nur verfügbar, wenn Sammeln Sie API-Statistiken Ist ausgewählt.