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
Disclaimer
Für die vorliegende Systemübersicht/Publikation behalten wir uns alle Rechte vor. Nachdruck, Vervielfältigung und Verbreitung (auch auszugsweise) ist nur mit schriftlicher Genehmigung der PEIQ Publishing GmbH & Co. KG erlaubt. Wir behalten uns vor, die Systemübersicht/Publikation jederzeit ohne vorherige Ankündigung zu ändern und/oder zu erweitern. Die vorliegenden Angaben dienen lediglich Informationszwecken. Die PEIQ Publishing GmbH & Co. KG übernimmt keinerlei Haftung und/oder Garantie für Fehler und/oder unvollständige Angaben in der Systemübersicht/Publikation, mit Ausnahme von vorsätzlich falschen oder arglistig verschwiegenen Angaben. Da unsere Software laufend weiter entwickelt wird, handelt es sich bei den vorliegenden nur um allgemeine Angaben. Es handelt sich weder um eine Zusicherung von Mindestvertragsinhalten, noch um Beschaffenheitsgarantien im Sinne des § 443 BGB.