API-Zugriffsstatistiken (PRINT PPS)

Funktionalitäten der API-Zugriffsstatistiken

• Auswertung der API Zugriffe eines Clients

• Darstellung der Ergebnisse auf einer Zeitleiste

Inhaltsverzeichnis

Allgemeine Beschreibung

Die API-Zugriffsstatistiken sind über die Statistik in der Verwaltung mit der allgemeinen Berechtigung “Zugriff auf API-Statistik” zugreifbar. Hier hat der API-Manager ein Cockpit für jeden freigeschalteten Zugang.

Außerdem kann eine CSV-Datei von den API-Zugriffsstatistiken inkl. eingestellten Filtern heruntergeladen werden.

Open

Cockpit der API-Zugriffsstatistiken

In der Gesamt-Übersicht wird jeweils der kumulierte Wert an API-Zugriffen für jeden freigeschalteten Zugang aufgeführt. Die Farben der Statistik entsprechen jeweils:

• GET-Zugriffe

• POST-Zugriffe

• PUT-Zugriffe

• DELETE-Zugriffe

 Die Filter geben die Möglichkeit, die Requests nach einem definierten Zeitraum zu filtern. Dadurch ist es möglich

• die letzten 24 Stunden,

• die letzten 30 Tage,

• oder die Requests in einem individuell definierten Zeitraum (max. 90 Tage)

zu betrachten.

Detailansicht: 2-Klick Google Charts - Zugriffsstatistiken pro Zugang

Open

2-Klick-Zustimmung vor dem Laden von Google Charts

Die Zugriffsstatistiken werden von Google Charts eingebettet. Benutzer:innen haben die Option, einmalig zuzustimmen und den Inhalt zu laden. Das Zustimmen muss für jeden Aufruf wiederholt werden. Mit einem Setzen eines Cookies durch das Häkchen, werden die “Google Charts immer geladen”, solange der gesetzte Cookie (user-confirmed-google-charts) nicht entfernt wurde oder abgelaufen ist.

Dabei gelten die Datenschutzbestimmen von Google.

Auswertung der Requests

Zur Auswertung werden Requests mit folgendem HTTP-Statuscode getrackt:

• 200, 201, 202, 203, 2xx (erfolgreiche Requests)

• 404 (erfolgreich, aber not found)

• 4xx (Fehler bei der Verwendung der API, insb. 400)

Requests, die aus irgendeinem Grund scheitern, werden nicht zur Auswertung herangezogen, z. B.

• 500 (interner Fehler, keine Auswertung möglich), 5xx

Tracking der Daten

Es erfolgt eine quantitative Auswertung der Requests. Folgende Daten werden beim Erfassen des Requests getrackt:

• Client-ID

• Timestamp des Requests

• API-Endpunkt

• HTTP-Methode

• HTTP-Status-Code

Die generierten Daten werden standardmäßig nach 13 Monaten gelöscht.

Verwandte Seiten

^{Nur für PEIQ-Mitarbeiter:innen}
https://peiq.atlassian.net/wiki/x/NwBsR