PORTAL und PPS Knowledge Base

API-Zugriffsstatistiken

Owned by Franziska Franz, created
Last updated: 2024-10-25 by Ilker Oygün
2 min read

Die API-Zugriffsstatistiken geben einen Überblick darüber, wie intensiv der jeweilige Client die für ihn freigeschalteten APIs nutzt.

Funktionalitäten der API-Zugriffsstatistiken

  • Auswertung der API-Zugriffe eines Client

  • Darstellung der Ergebnisse auf einer Zeitleiste

  • Zugreifbar über die Verwaltung für API-Zugänge

Inhaltsverzeichnis

Allgemeine Beschreibung

Die API-Zugriffstatistiken sind über die Verwaltung für API-Zugänge zugreifbar. Pro angelegten Zugang gibt es ein Cockpit, in dem anhand einer Zeitleiste die Zugriffe des Client dargestellt werden.

Verwaltung API-Zugänge: Der Cockpit-Button öffnet die API-Zugriffstatistiken

Mithilfe der Filter können die Requests nach einem definierten Zeitraum gefiltert werden. Dadurch ist es möglich

  • die letzten 24 Stunden

  • die letzten 30 Tage

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

zu betrachten. Die Ergebnisse werden auf eine Zeitleiste dargestellt.

Wie intensiv wurden von einem bestimmten Client die für ihn freigeschalteten APIs im gewählten Zeitraum genutzt?

Auswertung der Requests

Zur Auswertung werden nur Requests mit einem validen HTTP-Statuscode getrackt. Das sind folgende:

  • 200, 201, 202, 203, 2xx

  • 300, 301, 302, 303, 3xx

  • 404, 4xx

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

  • 500, 5xx

Anders als bei den anderen Cockpits im PORTAL, werden die Daten asynchron via Cron-Job (alle 60 Sekunden) abgeholt, um die Performance der API nicht zu beeinträchtigen. Das hat zur Folge, dass die Daten in diesem Cockpit nicht live sind, sondern mit einer Verzögerung von einer Minute im Cockpit dargestellt werden.

Tracking der Daten

Das Feature befindet sich derzeit in einem MVP Status, in dem zunächst nur eine quantitative Auswertung der Requests erfolgt. Daneben werden bereits andere Daten getrackt, um diese in weiteren Ausbaustufen des Features verwenden zu können. 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/AQCGGw

Impressum