Dashboard für API-Nutzung
Das Dashboard für API-Nutzung ermöglicht es Ihnen, Ihren eingehenden REST API-Traffic in Braze zu überwachen, um Trends in Ihrer Nutzung unserer REST APIs zu verstehen und potenzielle Probleme zu beheben.
Über das API-Nutzungs-Dashboard
Um Ihr API-Nutzungs-Dashboard anzuzeigen, gehen Sie zu Einstellungen > APIs und Bezeichner und wählen Sie dann Dashboard aus.
Das Standard-Dashboard zeigt alle eingehenden REST-API-Anfragen für Ihren Workspace der letzten 24 Stunden an. Je nach Anwendungsfall können Sie die Dashboard-Steuerelemente anpassen, um den Datenverkehr zu filtern oder zu gruppieren, und auch den Zeitraum des Dashboards konfigurieren.
Verfügbare Metriken
Das API-Nutzungs-Dashboard enthält die folgenden Statistiken:
| Metrik | Beschreibung |
|---|---|
| Gesamtanzahl der Anfragen | Die Gesamtanzahl der Anfragen, die für Ihren aktuellen Workspace an Braze gesendet wurden, unter Berücksichtigung der auf das Dashboard angewendeten Filter und Steuerungen. |
| Erfolgsrate | Der Prozentsatz der Gesamtanfragen, bei denen Braze eine 2XX-Erfolgsantwort zurückgegeben hat. |
| Fehlerrate | Der Prozentsatz der Gesamtanfragen, bei denen Braze eine 4XX- oder 5XX-Fehlerantwort zurückgegeben hat. |
Das Dashboard verwenden
Filter
Wählen Sie Filter aus, um Filter anzuwenden und die Ansicht des REST-API-Traffics für Ihren Workspace einzugrenzen, darunter:
- API-Schlüssel
- Endpunkt
- Antwortcode
Daten gruppieren
Sie können Daten in verschiedene Datenreihen gruppieren, um unterschiedliche Muster in Ihrer Nutzung zu untersuchen, darunter:
- Antwortcodes (Standard)
- API-Endpunkt
- API-Schlüssel
- Nur Erfolg und Fehler
Datum
Passen Sie den Datumsfilter an, um bei Bedarf einen kleineren oder größeren Zeitraum anzuzeigen. Dazu gehören:
- Heute (Standard)
- Benutzerdefiniert
- Letzte 3 Stunden
- Letzte 6 Stunden
- Letzte 12 Stunden
- Letzte 24 Stunden
- Gestern
- Letzte 7 Tage
- Letzte 14 Tage
- Letzte 30 Tage
- Letzter Monat bis heute
Die Optionen Letzte 3 Stunden und Letzte 6 Stunden zeigen den Traffic minutenweise an. Größere Zeiträume zeigen den Traffic alle fünf Minuten, stündlich oder täglich an.
Überlegungen
Das Dashboard zur API-Nutzung umfasst alle REST-API-Anfragen, die Braze empfangen und mit einer 2XX-, 4XX- oder 5XX-Antwort beantwortet hat. Dies schließt Datentransformations-Ausgaben und Cloud-Datenaufnahme-Synchronisierungen ein. SDK-Traffic und Nutzer:innen-Update-Schritte sind in diesem Dashboard nicht enthalten.
Die im Dashboard angezeigten Daten können eine kurze Verzögerung bei der Darstellung des aktuellen Traffics aufweisen. In Zeiten hoher Nutzung können Sie das Dashboard bis zu 4 Mal pro Minute aktualisieren. Möglicherweise müssen Sie einige Minuten warten, bevor Sie das Dashboard erneut aktualisieren können.
API-Schlüssel im Anfrage-Body
Wenn API-Schlüssel im Anfrage-Body statt im Anfrage-Header gesendet werden, werden einige Anfragen möglicherweise nicht im Dashboard zur API-Nutzung angezeigt. Dies kann zu unvollständigen Daten im Dashboard führen und die genaue Überwachung der API-Nutzung erschweren.
Für eine möglichst genaue Berichterstattung im Dashboard zur API-Nutzung sollten Sie API-Schlüssel im Anfrage-Header angeben, anstatt sie im Anfrage-Body zu senden.