Zum Inhalt springen

Diese Seite wurde automatisch übersetzt und kann Ungenauigkeiten enthalten. Um einen Übersetzungsfehler zu melden, nutzen Sie das Feedback unten im Inhaltsverzeichnis rechts auf der Seite.

API-Nutzungswarnungen

API-Nutzungswarnungen bieten wichtige Einblicke in Ihre API-Nutzung und ermöglichen es Ihnen, unerwarteten Datenverkehr proaktiv zu erkennen. Durch die Einrichtung dieser Warnungen zum Tracking wichtiger API-Anfragevolumina können Sie Realtime-Benachrichtigungen erhalten und Probleme beheben, bevor sie sich auf Ihre Marketing-Kampagnen auswirken.

Informationen zu API-Nutzungswarnungen

Sie können API-Nutzungswarnungen verwenden, um Anfragevolumen für die folgenden Kategorien zu überwachen:

API-Kategorie	Details
REST API-Endpunkte	Verfolgt die Nutzung aller REST API-Aufrufe an das Braze-Backend, wie z. B. das Senden von Nachrichten, das Erstellen von Campaigns oder das Exportieren von Nutzer:innen.
SDK-API-Anfragen	Verfolgt API-Anfragen, die von Braze SDKs in Client-Apps gestellt werden, wie z. B. das Triggern von In-App-Nachrichten oder das Synchronisieren von Nutzerdaten. *Nur für Kund:innen verfügbar, die „Monthly Active Users – CY 24-25“ erworben haben.

Erstellen einer API-Nutzungswarnung

So erstellen Sie eine API-Nutzungswarnung:

Navigieren Sie zu Einstellungen > APIs und Bezeichner > API-Nutzungswarnungen und erstellen Sie dann eine neue Warnung.
Geben Sie einen Namen für Ihre Warnung ein und wählen Sie die REST API-Endpunkte und API-Schlüssel aus, für die Sie benachrichtigt werden möchten.
Definieren Sie Ihre Warnungskriterien, indem Sie einen oder mehrere Antwortcodes auswählen und die Warnungsschwellenwerte festlegen.
Wenn Sie fertig sind, schalten Sie Alert enabled um.

Schwellenwerte für Warnungen

Wenn Sie Ihre Warnungskriterien definieren, können Sie die folgenden Schwellenwerte anpassen:

Schwellenwerte für Warnungen
Feld	Beschreibung
Schwellenwertbedingung	Definiert die Bedingungen, die zum Schwellenwertvolumen führen, bei dem Sie benachrichtigt werden möchten. Folgende Optionen werden unterstützt: Increased by oder Decreased by: Vergleicht Anfragen mit dem vorherigen Zeitfenster. Increased by percentage oder Decreased by percentage: Vergleicht die prozentuale Änderung der Anfragen mit dem vorherigen Zeitfenster. Greater than or equal oder less than or equal: Zählt Anfragen in einem Zeitfenster.
Schwellenwertvolumen	Wird in Verbindung mit der Schwellenwertbedingung verwendet.
Innerhalb	Das Zeitfenster für die Auswertung der Warnung.

Benachrichtigungen für Warnmeldungen einrichten

Sie können eine E-Mail-Benachrichtigung, eine Webhook-Benachrichtigung oder beides einrichten. Webhook-Benachrichtigungen können für Anwendungsfälle wie das Senden einer Warnmeldung an externe Plattformen, z. B. einen Slack-Kanal, sehr nützlich sein. Ein Beispiel finden Sie in unserer Dokumentation zur Integration von Warnmeldungen mit Slack für unsere Benachrichtigungseinstellungen.

Eine E-Mail wird an die ausgewählte E-Mail-Adresse gesendet, wenn die Kriterien für die Warnmeldung erreicht sind.

Beispiel-Payload

Das Folgende ist ein Beispiel-Payload für den Body eines API-Nutzungswarnungs-Webhooks.

{
  "text": "Your My First API Usage Alert alert has triggered. Please note that this alert is reset every 8 hours, and only one notification will be sent per reset period. You can view your alert and usage here: <link>.",
  "data": {
    "alert_name": "My First API Usage Alert",
    "alert_type": "API Usage Alert",
    "app_group_name": "My Workspace",
    "alert_criteria": {
      "response_codes": "201, 202 and 203",
      "threshold_condition": "increase by",
      "threshold_volume": "50%",
      "within": "1 hour"
    },
    "timeframe_start": "2025-03-20 15:35:00",
    "timeframe_end": "2025-03-20 16:35:00",
    "volume": 1500,
    "previous_timeframe_start": "2025-03-20 14:35:00",
    "previous_timeframe_end": "2025-03-20 15:35:00",
    "previous_volume": 1000
  }
}

Hinweis

Die Felder previous_timeframe_start, previous_timeframe_end und previous_volume sind optional und erscheinen nur, wenn die Warnmeldung eine vergleichende Schwellenwertbedingung (increase by, decrease by) verwendet. Bei Warnmeldungen mit greater than or equal oder less than or equal werden diese Felder weggelassen.

Details zu den Payload-Feldern

Feld	Typ	Beschreibung
`text`	String	Lesbare Warnmeldung.
`data.alert_name`	String	Name der Warnmeldung.
`data.alert_type`	String	Typ der Warnmeldung (immer `"API Usage Alert"`).
`data.app_group_name`	String	Workspace-Name.
`data.alert_criteria.response_codes`	String	Für die Warnmeldung ausgewählte Antwortcodes. Gibt `"all response codes"` zurück, wenn keiner ausgewählt ist, einen einzelnen Code wie `"201"` oder mehrere Codes wie `"201, 202 and 203"`.
`data.alert_criteria.threshold_condition`	String	Bedingungstyp: `"increase by"`, `"decrease by"`, `"greater than or equal"` oder `"less than or equal"`.
`data.alert_criteria.threshold_volume`	String oder Zahl	Schwellenwert. Wenn die Bedingung einen Prozentwert verwendet, ist dies ein String mit `%` am Ende (z. B. `"50%"`). Wenn die Bedingung einen numerischen Wert verwendet, ist dies eine Zahl (z. B. `50`).
`data.alert_criteria.within`	String	Zeitfenster für die Auswertung der Warnmeldung (z. B. `"1 day"`).
`data.timeframe_start`	String	Beginn des Warnmeldungszeitraums im UTC-Format `YYYY-MM-DD HH:MM:SS`.
`data.timeframe_end`	String	Ende des Warnmeldungszeitraums im UTC-Format `YYYY-MM-DD HH:MM:SS`.
`data.volume`	Zahl	Anfragevolumen während des Warnmeldungszeitraums.
`data.previous_timeframe_start`	String	(Optional) Beginn des vorherigen Zeitraums. Nur bei vergleichenden Schwellenwertbedingungen vorhanden.
`data.previous_timeframe_end`	String	(Optional) Ende des vorherigen Zeitraums. Nur bei vergleichenden Schwellenwertbedingungen vorhanden.
`data.previous_volume`	Zahl	(Optional) Anfragevolumen während des vorherigen Zeitraums. Nur bei vergleichenden Schwellenwertbedingungen vorhanden.

Beispielwarnmeldungen

Hier sind einige Möglichkeiten, wie Sie Ihre API-Nutzungswarnungskonfigurationen einrichten können, um in den folgenden Szenarien benachrichtigt zu werden.

Sie können Warnmeldungen einrichten, um den allgemeinen Zustand Ihrer API zu überwachen. Zum Beispiel können Sie diese Warnmeldungen einrichten, wenn API-Fehler drastisch ansteigen, z. B. um 20 % gegenüber der vorherigen Stunde.

Endpunkt	API-Schlüssel	Antwortcode	Schwellenwertbedingung	Schwellenwert	Innerhalb
Alle Endpunkte	Alle API-Schlüssel	`4XX` und `5XX`	Um 10 % gestiegen	10	1 Stunde

Lassen Sie sich benachrichtigen, wenn Ihr Workspace das Rate-Limit für den Endpunkt /users/track erreicht. Sie können diese Konfiguration auch auf andere Braze-Endpunkte anwenden.

Endpunkt	API-Schlüssel	Antwortcode	Schwellenwertbedingung	Schwellenwert	Innerhalb
`/users/track`	Alle API-Schlüssel	`429`	Größer als oder gleich	100	1 Stunde

Diese Warnmeldungskonfiguration benachrichtigt Sie, wenn Fehler bei API-getriggerten Campaigns und Canvases auftreten, von denen einige eine hohe Priorität haben können.

Endpunkt	API-Schlüssel	Antwortcode	Schwellenwertbedingung	Schwellenwert	Innerhalb
`/campaigns/trigger/send` `/canvas/trigger/send` `/messages/send`	Alle API-Schlüssel	`4XX` und `5XX`	Größer als oder gleich	1	1 Stunde

Verwenden Sie die folgende Warnmeldungskonfiguration, um benachrichtigt zu werden, wenn eine Partnerintegration aufhört, Daten an Braze zu senden.

Endpunkt	API-Schlüssel	Antwortcode	Schwellenwertbedingung	Schwellenwert	Innerhalb
Alle Endpunkte	Der für Ihre Partnerintegration verwendete API-Schlüssel	Alle Antwortcodes	Kleiner als oder gleich	0	1 Tag

Überlegungen

Jede aktive Warnung sendet nur alle 8 Stunden eine E-Mail- oder Webhook-Benachrichtigung. Dies soll verhindern, dass eine einzelne Warnung zu viele Benachrichtigungen auslöst. Wenn Ihre Warnung Sie zu früh benachrichtigt, sollten Sie die Warnungskriterien bearbeiten, um sie besser an Ihren Anwendungsfall anzupassen.
Sie können bis zu 10 Warnungen pro Workspace haben.

New Stuff!