Abfrage hart gebouncter E-Mails

Verwenden Sie diesen Endpunkt, um eine Liste der E-Mail-Adressen abzurufen, die Ihre E-Mail-Nachrichten innerhalb eines bestimmten Zeitraums „hart gebounct“ haben.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung email.hard_bounces.

Rate-Limit

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfrageparameter

Wichtig

Sie müssen ein end_date und entweder eine email oder ein start_date angeben. Wenn Sie alle drei angeben – start_date, end_date und email – werden die angegebenen E-Mails priorisiert und der Datumsbereich ignoriert.

Wenn Ihr Datumsbereich mehr als die limit-Anzahl von Hard Bounces aufweist, müssen Sie mehrere API-Aufrufe tätigen und dabei jedes Mal den offset erhöhen, bis ein Aufruf entweder weniger als limit oder null Ergebnisse liefert. Die Verwendung der Parameter offset und limit zusammen mit email kann zu einer leeren Antwort führen.

Beispielanfrage

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Antwort

Einträge werden in absteigender Reihenfolge aufgeführt.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "emails": [
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    }
  ],
  "message": "success"
}