PORTAL und PPS Knowledge Base

API- und Feed-Zugriffsstatistiken

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

Die API- und Feed-Zugriffsstatistiken zeigen eine Übersicht der Anzahl der Zugriffe über die Clients aller API- und JSON-Feed-Zugänge an. Die Übersicht ist nach Zeiträumen filterbar. Ein Absprung auf die API-Zugriffsstatistiken ist für eine detailliertere Ansicht möglich.

Funktionalitäten der API- und Feed-Zugriffsstatistiken

  • Überblick über alle API- und JSON-Feed Zugriffe

  • Vergleich der Zugriffe über die Clients aller API- und JSON-Feed-Zugänge

Inhaltsverzeichnis

Allgemeine Beschreibung

Die API- und Feed-Zugriffsstatistiken bieten eine filterbare Ansicht aller API- und JSON-Feed Zugriffe. Benutzer:innen mit der entsprechenden Berechtigung können sie über die Administration & Moderation aufrufen (siehe Anwendungsstatistiken | Zugriff auf Anwendungsstatistiken). Die Berechtigung für die API- und Feed-Zugriffsstatistiken ist unabhängig von der Berechtigung ‘API-Zugang’, da hier zwar ebenfalls sensible Daten eingesehen, aber nicht verändert werden können.

In den API- und Feed-Zugriffsstatistiken kann über ein Drop-Down-Menü der anzuzeigende Zeitraum ausgewählt werden. Hierbei stehen folgende Optionen zur Verfügung:

  • letzte 24 Stunden

  • letzte 30 Tage

  • benutzerdefinierter Zeitraum (Definition einer frei wählbaren Zeitspanne von minimal 1 Minute und maximal 90 Tagen)

Nach dem Klick auf das Such-Icon erscheinen die Zugriffe.

Zeitraumfilter der API- und Feed-Zugriffsstatistiken – benutzerdefinierter Zeitraum

Die API- und Feed-Zugriffsstatistiken werden durch zwei Reiter unterteilt: Die API-Zugänge und die JSON-Feed Zugänge. Die Auflistung der Ergebnisse ist von den höchsten Zugriffszahlen absteigend. An erster Stelle der Tabelle findet sich die Bezeichnung der Zugänge, die aus der Verwaltung der API Zugänge übernommen wird. Über das Statistik-Icon kann – für eine detaillierte Analyse der einzelnen Zugänge – auf die API-Zugriffsstatistiken abgesprungen werden.
Die Zahl innerhalb der Tabelle zeigt die Gesamtzahl des zugehörigen Zugangs an. Das bedeutet, dass hier Get, Post, Put und Delete -Requests zusammengezählt werden. Um einen schnellen Überblick zu erhalten, werden die einzelnen Requests in einem Balkendiagramm angezeigt und farblich unterschieden. Die dazu gehörende Farb-Legende befindet sich direkt über der Tabelle.

Ansicht: API- und Feed-Zugriffsstatistiken

Beim Hovern über die farbigen Bereiche des Balkendiagrams werden die Teilzahlen angezeigt.

Teilzahl der Get-Zugriffe auf die API

Am Ende der Tabelle wird die Gesamtzahl aller Zugriffe durch das Addieren der Zugriffe aller Zugänge angezeigt.

Darunter befindet sich der Button für den CSV-Download. Er bezieht sich auf den, in der Ansicht dargestellten, ausgewählten Zeitraum. Der Download ist für alle Benutzer:innen mit der Berechtigung für die API- und Feed-Zugriffsstatistiken verfügbar.

Der Aufbau der JSON-Feed-Zugänge in den API- und Feed-Zugriffsstatistiken entspricht dem der API-Zugänge – mit dem einzigen Unterschiede, dass hier nur Get-Requests dargestellt werden.

Ansicht: JSON-Feed-Zugänge in den API- und Feed-Zugriffsstatistiken

Sollte ein Zugang gelöscht werden, wird dies explizit in der Tabelle vermerkt und die ID des Zugangs hinterlegt. Gelöschte Zugänge sind, wie bei allen Tracking-Daten, noch 13 Monate nach der Löschung in den API- und Feed-Zugriffsstatistiken einsehbar.

Zugänge, die in dem ausgewählten Zeitraum keine Zugriffe verzeichnet haben, werden in der Ansicht nicht angezeigt.

Verwandte Seiten

 

Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/DYTNIg

Impressum