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 Dashboard zur API-Nutzung
Um Ihr Dashboard zur API-Nutzung 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 des letzten Tages (24 Stunden). Je nach Anwendungsfall können Sie die Steuerelemente des Dashboards anpassen, um den Traffic zu filtern oder zu gruppieren, und außerdem den Zeitraum des Dashboards konfigurieren.
Verfügbare Metriken
Das Dashboard zur API-Nutzung enthält die folgenden Statistiken:
| Metrik | Beschreibung |
|---|---|
| Anfragen insgesamt | Die Gesamtzahl der Anfragen, die für Ihren aktuellen Workspace an Braze gesendet wurden, unter Berücksichtigung der auf das Dashboard angewendeten Filter und Steuerelemente. |
| Erfolgsrate | Der Prozentsatz aller Anfragen, bei denen Braze eine 2XX-Erfolgsantwort zurückgegeben hat. |
| Fehlerrate | Der Prozentsatz aller Anfragen, bei denen Braze eine 4XX- oder 5XX-Fehlerantwort zurückgegeben hat. |
Verwendung des Dashboards
Filter
Wählen Sie Filter aus, um die Ansicht des REST-API-Traffics für Ihren Workspace einzugrenzen. Dazu gehören:
- API-Schlüssel
- Endpunkt
- Antwortcode
Daten gruppieren
Sie können Daten in verschiedene Datenreihen gruppieren, um unterschiedliche Muster in Ihrer Nutzung zu untersuchen. Dazu gehören:
- Antwortcodes (Standard)
- API-Endpunkt
- API-Schlüssel
- Nur Erfolg und Fehler
Datum
Passen Sie den Datumsfilter an, um je nach Bedarf einen kleineren oder größeren Zeitraum anzuzeigen. Dazu gehören:
- Heute (Standard)
- Angepasst
- 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
Bei den Optionen Letzte 3 Stunden und Letzte 6 Stunden wird der Traffic minutengenau angezeigt. Bei größeren Zeiträumen wird der Traffic in Intervallen von fünf Minuten, einer Stunde oder einem Tag angezeigt.
Anfrage-Logs anzeigen
Um die einzelnen Anfragen hinter einem Punkt im Chart zu sehen, wählen Sie einen Datenpunkt aus und anschließend Anfrage-Logs anzeigen. Das API-Anfrage-Log wird mit dem Zeitintervall dieses Datenpunkts geöffnet, wobei die auf das Chart angewendeten Filter für Endpunkt, Antwortcode und API-Schlüssel übernommen werden.
Anfrage-Logs sind nur für REST-API-Traffic der letzten 14 Tage verfügbar.
Hinweise
Das API-Nutzungs-Dashboard enthält alle REST API-Anfragen, die Braze empfangen und mit einer 2XX-, 4XX- oder 5XX-Antwort beantwortet hat. Dazu gehören auch Ausgaben der Datentransformation und Synchronisierungen über Cloud Data Ingestion. SDK-Traffic und „User Update“-Schritte sind in diesem Dashboard nicht enthalten.
Bei den im Dashboard angezeigten Daten kann es zu einer kurzen Verzögerung kommen, bis aktueller Traffic angezeigt wird. In Zeiten hoher Auslastung 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 Anfragetext
Wenn API-Schlüssel im Anfragetext statt im Anfrage-Header gesendet werden, erscheinen manche Anfragen möglicherweise nicht im API-Nutzungs-Dashboard. Das kann zu unvollständigen Daten im Dashboard führen und die genaue Überwachung der API-Nutzung erschweren.
Für möglichst genaue Berichte im API-Nutzungs-Dashboard sollten Sie API-Schlüssel im Anfrage-Header angeben statt im Anfragetext.