PORTAL und PPS Knowledge Base

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

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 Clients

  • Darstellung der Ergebnisse auf einer Zeitleiste

Inhaltsverzeichnis

 Inhaltsverzeichnis anzeigen

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.

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

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

Kann ein Request keinem Client zugeordnet werden, wird der Request unter “unbekannt“ in der Statistik getrackt.

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

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.

  • No labels