Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourRed
titlein bearbeitung

Infoinfo

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

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

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:

  • Status
    colourBlue
    titleGET
    -Zugriffe

  • Status
    colourGreen
    titlePOST
    -Zugriffe

  • Status
    colourYellow
    titlePUT
    -Zugriffe

  • Status
    colourRed
    titleDELETE
    -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

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "api" and space = "PPSD"

...