Nachrichtenstatistiken

messages:list

Zeigt die Liste der gesendeten Nachrichten an.

POST https://api.pushwoosh.com/api/v2/messages:list

Name	Erforderlich	Beschreibung
`Authorization`	Ja	Server-API-Token. Muss im folgenden Format bereitgestellt werden: `Authorization: Api <Server Key>`.

Parameter des Anfrage-Hauptteils

Name	Erforderlich	Typ	Beschreibung
`platforms`	Nein	Array	Nachrichtenplattformen. Mögliche Werte: `"IOS"`, `"ANDROID"`, `"OSX"`, `"WINDOWS"`, `"AMAZON"`, `"SAFARI"`, `"CHROME"`, `"FIREFOX"`, `"IE"`, `"EMAIL"`, `"HUAWEI_ANDROID"`, `"SMS"`.
`date_range`	Nein	Object	Berichtszeitraum, gefiltert nach dem Erstellungsdatum der Nachricht. `date_from` und `date_to` müssen dem Format `YYYY-MM-DD` folgen (z. B. `"2000-01-01"`); beide Tage sind vollständig enthalten, sodass `date_from` und `date_to` auf dasselbe Datum gesetzt den gesamten Tag zurückgeben. Die Daten werden in UTC interpretiert, nicht in der Zeitzone Ihres Kontos.
`campaign`	Nein	String	Kampagnencode
`filters`	Ja	Object	Nachrichtenfilter.
`source`	Nein	String	Nachrichtenquelle. Zum Beispiel: `AB_TEST`, `API`, `AUTO_PUSH`, `CP`, `CSV`, `CUSTOMER_JOURNEY`, `EMAIL_API`, `EMAIL_CP`, `GEO_ZONE`, `PUSH_ON_EVENT`, `RSS`.
`messages_codes`	Nein	Array	Nachrichtencodes, die aus `/createMessage` API-Antworten erhalten wurden.
`messages_ids`	Nein	Array	Nachrichten-IDs aus dem Nachrichtenverlauf
`params`	Nein	Object	Geben Sie an, ob Nachrichtendetails und Metriken angezeigt werden sollen. Setzen Sie `with_details: true`, um das `"details"`-Objekt einzuschließen, und `with_metrics: true`, um das `"metrics"`-Objekt in die Antwort einzuschließen.
`application`	Ja	String	Pushwoosh-Anwendungscode.
`per_page`	Nein	Integer	Anzahl der Ergebnisse pro Seite, `1` bis `499`. Lassen Sie den Parameter weg, um die Standardseitengröße von 500 Ergebnissen zu erhalten; die explizite Angabe von `500` oder mehr wird mit `400` abgelehnt.
`page`	Nein	Integer	Nullbasierte Seitennummer für die Paginierung. Siehe das Limit für die tiefe Paginierung unten.

Beispielanfrage

{
    "filters": {
      "platforms": [],                  // IOS, ANDROID, OSX, WINDOWS, AMAZON, SAFARI, CHROME, FIREFOX, IE, EMAIL, HUAWEI_ANDROID, SMS
      "date_range": {
        "date_from": "string",          // Erforderliches Format: 2000-01-01
        "date_to": "string"             // Erforderliches Format: 2000-01-01
      },
      "source": "API",                  // AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS
      "campaign": "string",             // Kampagnencode
      "messages_ids": [],               // Nachrichten-IDs
      "messages_codes": [],             // Nachrichtencodes
      "application": "string"           // Pushwoosh-Anwendungscode
    },
    "params": {
      "with_details": true,             // Nachrichtendetails zur Antwort hinzufügen ("details"-Objekt)
      "with_metrics": true              // Nachrichtenmetriken zur Antwort hinzufügen ("metrics"-Objekt)
    },
    "per_page": 20,                     // <= 499
    "page": 0
}

Antwortcodes und Beispiele

{
  "total": 0,
  "items": [{
    "id": 0,
    "code": "string",
    "created_date": "string",
    "send_date": "string",
    "status": "string",
    "platforms": [],
    "source": "string",
    "push_info": {
      "details": {
        "title": "string",
        "filter_name": "string",
        "filter_code": "string",
        "content": {
          "key": "value"
        },
        "platform_parameters": {
          "android_header": "string",
          "android_root_params": {
            "key": "value"
          },
          "ios_title": "string",
          "ios_subtitle": "string",
          "ios_root_params": {
            "key": "value"
          },
          "chrome_header": "string",
          "chrome_root_params": {
            "key": "value"
          },
          "firefox_header": "string",
          "firefox_root_params": {
            "key": "value"
          },
          "conditions": [               // Tag-Bedingungen (siehe /developer/api-reference/messages-api/#tag-conditions)
            TAG_CONDITION1,
            TAG_CONDITION2,
            ...,
            TAG_CONDITIONN
          ],
          "conditions_operator": "AND", // logischer Operator für Bedingungs-Arrays; mögliche Werte: AND, OR
          "data": {
            "key": "value"
          }
        },
        "follow_user_timezone": true
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "inbox_opens": 0,
        "unshowable_sends": 0,
        "errors": 0,
        "platform": 0
      }]
    },
    "email_info": {
      "details": {
        "template": "string",
        "filter_name": "string",
        "filter_code": "string",
        "subject": {
          "key": "value"
        },
        "from_name": "string",
        "from_email": "string",
        "reply_name": "string",
        "reply_email": "string",
        "follow_user_timezone": true,
        "conditions": [              // Tag-Bedingungen (siehe Messages-api - tag-conditions)
          TAG_CONDITION1,
          TAG_CONDITION2,
          ...,
          TAG_CONDITIONN
        ],
        "conditions_operator": "AND" // logischer Operator für Bedingungs-Arrays; mögliche Werte: AND, OR
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "hard_bounces": 0,
        "soft_bounces": 0,
        "rejects": 0,
        "confirmed_sends": 0,
        "unsubs": 0,
        "complaints": 0,
        "errors": 0
      }]
    }
  }]
}

date_range überspannt mehr als 30 Tage:

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

page × per_page überschreitet das Limit für die tiefe Paginierung:

{
  "error": "requested result window is too large, narrow the date range"
}

{
  "error": "account not found"
}

totalsByIntervals

Gibt Metriken und Konversionsdaten basierend auf dem Nachrichtencode zurück, aggregiert nach Stunde.

POST https://api.pushwoosh.com/api/v2/statistics/messages/totalsByIntervals

Autorisierung

Die Autorisierung erfolgt über den API Access Token im Anfrage-Header.

Parameter des Anfrage-Hauptteils

Parametername	Typ	Beschreibung	Erforderlich
`message_code`	string	Nachrichtencode, der aus `/createMessage` API-Antworten erhalten wurde.	Ja
`platforms`	[int]	Plattformen	Nein

Beispielanfrage

{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // erforderlich. Eindeutiger Nachrichtenidentifikator
  "platforms": [1, 3, 7, 10, 11, 12]          // optional. Liste der Plattformcodes
}

Antwortfelder

Name	Typ	Beschreibung
`metrics`	array	Enthält ein Array von Nachrichtenmetriken
`timestamp`	string	Die Zeit der Metrik.
`platform`	int	Der Plattformcode (z. B. iOS, Android).
`sends`	string	Die Anzahl der gesendeten Nachrichten.
`opens`	string	Die Anzahl der geöffneten Nachrichten.
`deliveries`	string	Die Anzahl der zugestellten Nachrichten.
`inbox_opens`	string	Die Anzahl der Posteingangsöffnungen.
`unshowable_sends`	string	Die Anzahl der Nachrichten, die für Geräte akzeptiert wurden, bei denen Benachrichtigungen in den Betriebssystemeinstellungen deaktiviert sind. Es wird kein Banner angezeigt, aber die Nachricht erreicht dennoch die App und erscheint im Nachrichten-Posteingang, wenn für den Versand Nachricht im Posteingang speichern aktiviert ist. Zählt als erfolgreicher Versand, nicht als Fehler.
`errors`	string	Die Anzahl der Fehler.
`conversion`	object	Enthält Konversionsdaten
`sends`	string	Die Gesamtzahl der gesendeten Nachrichten.
`opens`	string	Die Gesamtzahl der geöffneten Nachrichten.
`events`	array	Ein Array von Ereignissen mit ihren Statistiken
`name`	string	Der Name des Ereignisses (z. B. zum Warenkorb hinzufügen).
`hits`	string	Die Anzahl der Treffer.
`conversion`	float	Die Konversionsrate im Verhältnis zu den Öffnungen.
`revenue`	float	Der Umsatz (nur für Ereignisse mit `__amount`- und `__currency`-Attributen).

Beispielantwort

{
  "metrics": [{
    "timestamp": "2024-08-03 15:00:00",  // Zeitstempel der Metriken im Format "YYYY-MM-DD HH:MM:SS"
    "platform": 3,                       // Plattformcode
    "sends": "55902",                    // Anzahl der gesendeten Nachrichten
    "opens": "382",                      // Anzahl der geöffneten Nachrichten
    "deliveries": "22931",               // Anzahl der zugestellten Nachrichten
    "inbox_opens": "0",                  // Anzahl der im Posteingang geöffneten Nachrichten
    "unshowable_sends": "2",             // An Geräte mit deaktivierten Benachrichtigungen gesendet, kein Banner angezeigt
    "errors": "0"                        // Anzahl der aufgetretenen Fehler
  }],
  "conversion": {
    "sends": "55902",                    // Gesamtzahl der gesendeten Nachrichten
    "opens": "772",                      // Gesamtzahl der geöffneten Nachrichten
    "events": [{
      "name": "cart_add",                // Name des Ereignisses
      "hits": "96",                      // Anzahl der Treffer für das Ereignis
      "conversion": 0.12,                // Konversionsrate im Verhältnis zu den Öffnungen
      "revenue": 0                       // Durch das Ereignis generierter Umsatz (nur für Ereignisse mit Betrags-/Währungsattributen)
    }]
  }
}

getMessageLog

Zeigt detaillierte Informationen über die gesendeten Nachrichten an.

POST https://api.pushwoosh.com/api/v2/statistics/getMessageLog

Header

Name	Erforderlich	Beschreibung
`Authorization`	Erforderlich	API-Zugriffstoken aus dem Pushwoosh Control Panel.

Parameter des Anfrage-Hauptteils

Name	Erforderlich	Typ	Beschreibung
`message_id`	Nein	Integer	Wählt Nachrichtenereignisse nach der aus dem Nachrichtenverlauf erhaltenen Nachrichten-ID aus. Beispiel: `12345678900`.
`message_code`	Nein	String	Wählt Nachrichtenereignisse nach dem Nachrichtencode aus, der aus `/createMessage` API-Antworten erhalten wurde. Beispiel: `"A444-AAABBBCC-00112233"`.
`campaign_code`	Nein	String	Wählt Nachrichtenereignisse nach dem Kampagnencode aus, der in Ihrer Nachrichtennutzlast angegeben ist. Beispiel: `"AAAAA-XXXXX"`.
`hwid`	Nein	String oder Array	Wählt Nachrichtenereignisse nach HWID (Hardware-ID) oder einem Array von HWIDs aus.
`date_from`	Erforderlich, wenn `message_id`, `message_code` oder `campaign_code` nicht angegeben sind	Datetime	Startdatum zum Filtern von Nachrichten. Format: `"YYYY-MM-DD HH:MM:SS"`. Beispiel: `"2000-01-25 00:00:00"`.
`date_to`	Erforderlich, wenn `message_id`, `message_code` oder `campaign_code` nicht angegeben sind	Datetime	Enddatum zum Filtern von Nachrichten. Format: `"YYYY-MM-DD HH:MM:SS"`. Beispiel: `"2000-01-26 00:00:00"`.
`limit`	Nein	Integer	Maximale Anzahl von Nachrichtenereignissen, die in einer einzigen Antwort zurückgegeben werden. Maximalwert: `100000`.
`pagination_token`	Nein	String	Paginierungstoken, das aus einer vorherigen `/getMessageLog`-Antwort erhalten wurde. Verwenden Sie es, um zusätzliche Ergebnisse abzurufen.
`user_id`	Nein	String	Wählt Nachrichtenereignisse nach einer benutzerdefinierten Benutzer-ID aus. Siehe `/registerUser` für weitere Details.
`application_code`	Ja	String	Wählt Nachrichtenereignisse nach dem Pushwoosh-Anwendungscode aus.
`actions`	Nein	Array	Filtert Ergebnisse nach bestimmten Nachrichtenaktionen. Mögliche Werte: `"sent"`, `"delivered"`, `"opened"`, `"reject"`, `"create"`, `"inbox_delivered"`, `"inbox_read"`, `"inbox_opened"`, `"inbox_deleted"`. `"create"`-Ereignisse sind standardmäßig von der Antwort ausgeschlossen. Fügen Sie `"create"` zu diesem Array hinzu, um sie zu sehen. `"delivered"`-Ereignisse erfordern zusätzlich, dass die Zustellungsstatistiken im Konto aktiviert sind.
`platforms`	Nein	Array	Array von Zielplattformen zum Filtern der Ergebnisse. Mögliche Werte: `"unknown"`, `"ios"`, `"blackberry"`, `"android"`, `"windows phone"`, `"osx"`, `"windows"`, `"amazon"`, `"safari"`, `"chrome"`, `"firefox"`, `"ie"`, `"email"`, `"fb messenger"`, `"baidu android"`, `"huawei android"`, `"sms"`, `"xiaomi"`, `"web"`, `"whatsapp"`, `"line"`, `"kakao"`, `"telegram"`, `"apple wallet"`, `"google wallet"`, `"viber"`.
`message_type`	Nein	String	Filtert Ergebnisse nach Nachrichtenfluss. `"all"` (Standard, wenn weggelassen) gibt alles zurück, `"broadcast"` gibt nur Massennachrichten zurück (`message_id != 0`), `"transactional"` gibt nur Nachrichten mit `message_id = 0` zurück, einschließlich derer, die von Customer Journey gesendet wurden.

Beispielanfrage

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/getMessageLog' \
--header 'Authorization: Key API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "pagination_token": "PAGINATION_TOKEN_FROM_PREVIOUS_RESPONSE",  // optional, Token für die Paginierung
   "limit": 1000,                                  // optional, die maximale Anzahl von Einträgen für eine einzelne Antwort
   "application_code": "XXXXX-XXXXX",              // Pushwoosh-App-Code
   "message_code": "A444-AAABBBCC-00112233",       // optional, Nachrichtencode aus der /createMessaage-Anfrage
   "message_id": 1234567890,                       // optional, Nachrichten-ID aus dem Pushwoosh Control Panel
   "campaign_code": "AAAAA-XXXXX",                 // optional, Code einer Kampagne, für die das Protokoll abgerufen werden soll
   "hwid": "aaazzzqqqqxxx",                        // optional, Hardware-ID eines bestimmten Geräts, das mit einer Nachricht angesprochen wurde
   "user_id": "user_123",                          // optional, ID eines Benutzers, der mit der Nachricht angesprochen wurde
   "date_from": "2000-01-25 00:00:00",             // optional, Beginn des Statistikzeitraums
   "date_to": "2000-02-10 23:59:59",               // optional, Ende des Statistikzeitraums
   "actions": ["opened", "inbox_opened"],          // optional, zur Filterung der Ergebnisse verwendet. Mögliche Werte: "sent", "delivered", "opened", "reject", "create", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". Die Antwort enthält alle Nachrichten mit der/den angegebenen Aktion(en).
   "platforms": ["ios", "chrome"],                 // optional, zur Filterung der Ergebnisse verwendet, nur Kleinbuchstaben. Mögliche Werte: "unknown", "ios", "blackberry", "android", "windows phone", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "fb messenger", "baidu android", "huawei android", "sms", "xiaomi", "web", "whatsapp", "line", "kakao", "telegram", "apple wallet", "google wallet", "viber"
   "message_type": "broadcast"                     // optional, "all" (Standard), "broadcast" (message_id != 0) oder "transactional" (message_id = 0, einschließlich Customer Journey-Sendungen)
}'

Antwortcodes und Beispiele

{
  "pagination_token": "PAGINATION_TOKEN_FOR_NEXT_REQUEST",
  "data": [{
    "timestamp": "2000-01-25T11:18:47Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "sent",
    "status": "success",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:18:49Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "delivered",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:23Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "opened",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:30Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "reject",
    "status": "failed",
    "error_reason": "invalid device token",
    "payload": "SOME_PAYLOAD_STRING"
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

Jeder Eintrag in data enthält auch error_reason (String, gefüllt mit dem Fehlergrund, wenn status "failed" ist) und eine optionale payload (String).

Eine Antwortseite kann kürzer als das angeforderte limit ausfallen. Das allein bedeutet nicht, dass der Export abgeschlossen ist.

E-Mail-Statistiken

linksInteractions

Zeigt Statistiken zu Link-Klicks in E-Mails an

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions

Header

Name	Erforderlich	Beschreibung
`Authorization`	Ja	API-Zugriffstoken aus dem Pushwoosh Control Panel.

Parameter des Anfrage-Hauptteils

Name	Erforderlich	Typ	Beschreibung
`date_range`	Nein	Object	Definiert den Berichtszeitraum. Enthält `date_from` und `date_to`.
`filters`	Ja	Object	E-Mail-Filter.
`application`	Ja	String	Pushwoosh-Anwendungscode (alternativ `campaign`, `messages_ids` oder `message_codes` angeben).
`messages_codes`	Ja	Array	Nachrichtencodes (alternativ `application`, `campaign` oder `messages_ids` angeben).
`campaign`	Ja	String	Kampagnencode (alternativ `application`, `messages_ids` oder `message_codes` angeben).
`messages_ids`	Ja	Array	Nachrichten-IDs (alternativ `application`, `campaign` oder `message_codes` angeben).
`link_template`	Erforderlich, wenn `application` oder `campaign` angegeben ist.	String	Filtert E-Mail-Link-Interaktionen nach Schlüsselwort. Nur Links, die den angegebenen Text in ihrer URL enthalten, werden in der API-Antwort zurückgegeben. Wenn Ihre E-Mail beispielsweise Links wie `https://example.com/news` und `https://example.com/shop` enthält, gibt die Einstellung `"link_template": "shop"` nur Interaktionen für `https://example.com/shop` zurück.
`email_content_code`	Nein	String	Eindeutiger Identifikator für den E-Mail-Inhalt.
`params`	Nein	Object	Definiert zusätzliche Antwortoptionen. Enthält `with_full_links`, das eine Liste vollständiger Links mit Statistiken hinzufügt.

Beispielanfrage

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",           // Erforderliches Format: 2000-01-01
         "date_to": "string"              // Erforderliches Format: 2000-01-01
      },
      "campaign": "string",               // Kampagnencode (Sie können stattdessen application, messages_ids oder message_codes angeben)
      "application": "string",            // Anwendungscode (Sie können stattdessen campaign, messages_ids oder message_codes angeben)
      "messages_ids": [],                 // Nachrichten-IDs (Sie können stattdessen application, campaign oder message_codes angeben)
      "messages_codes": [],               // Nachrichtencodes (Sie können stattdessen application, campaign oder message_ids angeben)
      "link_template": "string",          // Link-Vorlage (erforderlich, wenn application oder campaign angegeben ist)
      "email_content_code": "string"      // Eindeutiger Identifikator für den E-Mail-Inhalt.
   },
   "params": {
      "with_full_links": true             // Geben Sie an, ob detaillierte Statistiken angezeigt werden sollen. Eine Liste vollständiger Links mit Statistiken wird im full_links-Array übergeben.
   }
}'

Antwortcodes und Beispiele

{
  "items": [{
    "template": "string",
    "link": "string",
    "title": "string",
    "clicks": 0,
    "full_links": [{
      "full_link": "string",
      "clicks": 0
    }]
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

linksInteractionsDevices

Zeigt Benutzer an, die auf Links in E-Mails geklickt haben

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices

Header

Name	Erforderlich	Beschreibung
`Authorization`	Ja	API-Zugriffstoken aus dem Pushwoosh Control Panel.

Parameter des Anfrage-Hauptteils

Name	Erforderlich	Typ	Beschreibung
`date_range`	Nein	Object	Definiert den Berichtszeitraum. Enthält `date_from` und `date_to`.
`filters`	Ja	Object	E-Mail-Filter.
`application`	Ja	String	Pushwoosh-Anwendungscode (alternativ `campaign`, `messages_ids` oder `message_codes` angeben).
`messages_codes`	Ja	Array	Nachrichtencodes (alternativ `application`, `campaign` oder `messages_ids` angeben).
`campaign`	Ja	String	Kampagnencode (alternativ `application`, `messages_ids` oder `message_codes` angeben).
`messages_ids`	Ja	Array	Nachrichten-IDs (alternativ `application`, `campaign` oder `message_codes` angeben).
`link_template`	Erforderlich, wenn `application` oder `campaign` angegeben ist.	String	Filtert E-Mail-Link-Interaktionen nach Schlüsselwort. Nur Links, die den angegebenen Text in ihrer URL enthalten, werden in der API-Antwort zurückgegeben. Wenn Ihre E-Mail beispielsweise Links wie `https://example.com/news` und `https://example.com/shop` enthält, gibt die Einstellung `"link_template": "shop"` nur Interaktionen für `https://example.com/shop` zurück.
`email_content_code`	Nein	String	Eindeutiger Identifikator für den E-Mail-Inhalt.
`page`	Nein	Integer	Seitennummer für die Paginierung.
`per_page`	Nein	Integer	Anzahl der Ergebnisse pro Seite (≤ 1000).

Beispielanfrage

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",         // Erforderliches Format: 2000-01-01
         "date_to": "string"            // Erforderliches Format: 2000-01-01
      },
      "campaign": "string",             // Kampagnencode (Sie können stattdessen application, messages_ids oder message_codes angeben)
      "application": "string",          // Anwendungscode (Sie können stattdessen campaign, messages_ids oder message_codes angeben)
      "messages_ids": [],               // Nachrichten-IDs (Sie können stattdessen application, campaign oder message_codes angeben)
      "messages_codes": [],             // Nachrichtencodes (Sie können stattdessen application, campaign oder message_ids angeben)
      "link_template": "string",        // Link-Vorlage (erforderlich, wenn application oder campaign angegeben ist)
      "email_content_code": "string"    // Eindeutiger Identifikator für den E-Mail-Inhalt.
   },
   "per_page": 100,
   "page": 0
}'

Antwortcodes und Beispiele

{
  "total": 0,
  "items": [{
    "timestamp": "string",
    "link": "string",
    "hwid": "string"
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

bouncedEmails

POST https://api.pushwoosh.com/api/v2/statistics/emails/bouncedEmails

Liefert Daten zu E-Mail-Beschwerden, Soft Bounces und Hard Bounces, einschließlich Datum, E-Mail-Adresse und Grund für jeden Bounce.

Autorisierung

Die Autorisierung erfolgt über den API Access Token im Anfrage-Header.

Parameter des Anfrage-Hauptteils

Parametername	Typ	Beschreibung	Erforderlich
`application`	string	Pushwoosh-Anwendungscode	Ja
`message_code`	string	Nachrichtencode.	Erforderlich, wenn `date range` oder `campaign` nicht angegeben ist
`campaign`	string	Kampagnencode.	Erforderlich, wenn `message_code` oder `date range` nicht angegeben ist
`date_from`	string	Das Startdatum für die Daten im Format `YYYY-MM-DDTHH:MM:SS.000Z` (ISO 8601-Standard).	Erforderlich, wenn `message_code` oder `campaign` nicht angegeben ist
`date_to`	string	Das Enddatum für die Daten im Format `YYYY-MM-DDTHH:MM:SS.000Z` (ISO 8601-Standard).	Erforderlich, wenn `message_code` oder `campaign` nicht angegeben ist
`per_page`	int	Die Anzahl der Zeilen pro Seite, maximal 5000.	Ja
`page`	int	Die Seitennummer, beginnend bei null.	Ja
`type`	string	Der Typ des Bounces: Complaint, Softbounce, Hardbounce.	Nein

Beispielanfrage

{
  "application": "XXXXX-XXXXX",               // erforderlich. Pushwoosh-App-Code
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // erforderlich, wenn Kampagne oder Datumsbereich nicht angegeben ist.
                                              //          Eindeutiger Nachrichtenidentifikator
  "campaign": "XXXXX-XXXXX",                  // erforderlich, wenn message_code oder Datumsbereich nicht angegeben ist.
                                              //          Kampagnencode
  "date_from": "2024-07-20T00:00:00.000Z",    // erforderlich, wenn message_code oder Kampagne nicht angegeben ist.
                                              //          Startdatum im ISO 8601-Format "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "date_to": "2024-07-20T00:00:00.000Z",      // erforderlich, wenn message_code oder Kampagne nicht angegeben ist.
                                              //          Enddatum im ISO 8601-Format "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "per_page": 1000,                           // erforderlich. Anzahl der Ergebnisse pro Seite, maximal 5000
  "page": 5,                                  // optional. Seitennummer, beginnend bei null
  "type": "Softbounce"                        // optional. Der Typ des Bounces: Complaint, Softbounce, Hardbounce
}

Antwortfelder

Feldname	Typ	Beschreibung
`total`	int	Die Gesamtzahl der Zeilen.
`bounced_emails`	array	Ein Array mit Details zu den gebouncten E-Mails.
├── `email`	string	Die E-Mail-Adresse, die gebounct wurde.
├── `date`	string	Das Datum des Bounces (Format: `YYYY-MM-DDTHH:MM:SS.000Z`).
├── `reason`	string	Der Grund für den Bounce.
└── `type`	string	Der Typ des Bounces: Complaint, Softbounce, Hardbounce.

Beispielantwort

{
  "total": 25,                             // Gesamtzahl der Zeilen.
  "bounced_emails": [{
    "email": "example@example.com",        // E-Mail-Adresse, die gebounct wurde
    "date": "2024-07-20T00:00:00.000Z",    // Bounce-Datum im ISO 8601-Format
    "reason": "Invalid recipient address", // Grund für den Bounce
    "type": "Hardbounce"                   // Typ des Bounces: Complaint, Softbounce, Hardbounce
  }]
}