WhatsApp-Analytik

Mit der WhatsApp-Analyse können Sie detaillierte Metriken für geschäftliche Telefonnummern und Vorlagen abrufen, die mit Ihrer WABA verbunden sind. Beispiele sind die Anzahl und der Typ der gesendeten Nachrichten, die Anzahl, wie oft eine bestimmte Vorlage gelesen wurde, und die Anzahl, wie oft eine Schaltfläche in einer Vorlage angeklickt wurde.

Messaging-Analytik

Die Nachrichtenanalyse gibt Aufschluss über die Anzahl und Art der Nachrichten, die von den mit einer bestimmten WABA verbundenen Telefonnummern gesendet und zugestellt wurden.

Beispiel-Anfrage

Um Messaging-Analysen abzurufen, senden Sie eine

GET
-Anfrage an den folgenden Endpunkt und ersetzen Sie dabei waba_id mit der ID des WhatsApp Business Accounts, für den Sie Messaging-Analysedaten abrufen möchten:

https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/messaging-analytics

Die Daten werden mit einer halbstündlichen, täglichen oder monatlichen Granularität in der UTC-Zeitzone zurückgegeben, mit einem Rückblick von bis zu 90 Tagen. Sie müssen die Parameter für Beginn, Ende und Granularität in Ihre Anfrage aufnehmen, und es gibt einige optionale Parameter, die Sie verwenden können, um die Daten weiter zu filtern:

Name Typ Erforderlich Anmerkungen
start string(Zeitstempel) Ja Das Format des Startdatums und der Startzeit für die Analysedaten, die abgerufen werden sollen, im Format YYYY-MM-DD.
end string(Zeitstempel) Ja Das Enddatum und das Zeitformat für die Analysedaten, die abgerufen werden sollen, im Format YYYY-MM-DD.
granularity String Ja Die Granularität der abzurufenden Analysedaten. Unterstützt werden: HALBE_STUNDE, TÄGLICH, MONATLICH
phone_number Array Nein Telefonnummern, für die Sie Analysen abrufen möchten. Wenn leer, werden alle WABA-assoziierten Telefonnummern einbezogen.
product_types Array Nein Ein Array mit den Nachrichtentypen, für die Analysen abgerufen werden sollen. Mögliche Werte sind 0 für Benachrichtigungsmeldungen und/oder 2 für Kundensupport-Nachrichten. Wird nichts angegeben, werden Analysen für alle Nachrichtentypen zurückgegeben.
country_codes Array Nein Zweibuchstabige Ländercodes für die Länder, für die Sie die Analysen abrufen möchten. Wenn keine Angaben gemacht werden, werden die Analysen für alle Länder zurückgegeben.

Ein vollständiges Codebeispiel finden Sie in der Abrufen von Messaging-Analysen Codeschnipsel.

Beispiel Antwort

{
   "id": "345688589250625",
   "granularity": "HALF_HOUR",
   "phone_numbers": [
      "16505550111"
   ],
   "country_codes": [
      "US"
   ],
   "_embedded": {
      "messaging_analytics": [
         {
            "start": "1543543200",
            "end": "1543629600",
            "sent": 100,
            "delivered": 90
         }
      ]
   },
   "paging": {
      "cursors": {
         "before": "MAZDZD",
         "after": "MjQZD"
      },
      "next": "https://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?after=MAZDZD",
      "previous": "https://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?before=MjQZD"
   }
}

Vorlage Analytik

Die Vorlagenanalyse beschreibt, wie oft eine Vorlage gesendet, zugestellt und gelesen wurde und wie oft URL-Schaltflächen oder Schnellantwort-Schaltflächen in der Vorlage angeklickt wurden; die Schaltflächenklickanalyse ist nur für Vorlagen verfügbar, die als MARKETING oder UTILITY.

Die Daten werden mit einer täglichen Granularität in der UTC-Zeitzone mit einem Rückblick von bis zu 90 Tagen zurückgegeben.

Bitte beachten Sie: Sie müssen die Vorlagenanalyse in Ihrem Business Account bestätigen, bevor Sie die Vorlagenanalyse abrufen können. Siehe die WhatsApp-Dokumentation für weitere Informationen.

Beispiel-Anfrage

Um Vorlagenanalysen abzurufen, senden Sie eine

GET
-Anfrage an den folgenden Endpunkt und ersetzen Sie dabei waba_id mit der ID des WhatsApp Business Accounts, für den Sie die Template Analytics-Daten abrufen möchten:

https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/template-analytics

Die unten aufgeführten Abfrageparameter können zum Filtern der Ergebnisse verwendet werden:

Name Typ Erforderlich Anmerkungen
start string(Zeitstempel) Ja Das Format des Startdatums und der Startzeit für die Analysedaten, die abgerufen werden sollen, im Format YYYY-MM-DD.
end string(Zeitstempel) Ja Das Enddatum und die Endzeit für die Analysedaten, die abgerufen werden sollen, im Format YYYY-MM-DD. Die maximale Differenz zwischen dem Anfangs- und dem Enddatum beträgt 90 Tage.
granularity String Ja Muss TÄGLICH sein.
template_ids Array Ja Ein Array der template_ids der Vorlage(n), für die Analysen abgerufen werden sollen. Maximal 10.
metric_types Array Nein Ein Array mit den Metrik-Typen, für die Analysen abgerufen werden sollen. Mögliche Werte sind SENT, DELIVERED, READund CLICKED. Was die einzelnen Typen bedeuten, können Sie in der WhatsApp-Dokumentation nachlesen. Wenn leer, werden die Analysen für alle Metrik-Typen zurückgegeben.

Beispiel Antwort

{
   "granularity": "DAILY",
   "product_type": "cloud_api",
   "page_size": 100,
   "_embedded": {
      "template_analytics": [
         {
            "template_id": "458951126288942",
            "start": "2024-11-11T00:00:00Z",
            "end": "2024-11-11T00:00:00Z",
            "sent": 100,
            "delivered": 90,
            "read": 80,
            "clicked": 70
         }
      ]
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/template-analytics?template_ids=[458951126288937]&start=2024-11-10&end=2024-11-14&page_size=100&cursor=c2VsZj1udWxs"
      }
   }
}

Preisanalytik

Mit der Preisanalyse können Sie Preisaufschlüsselungen und Tiering-Informationen für jede Nachricht abrufen, die innerhalb eines bestimmten Datumsbereichs zugestellt wurde.

Beispiel-Anfrage

Um Preisanalysen abzurufen, senden Sie eine

GET
-Anfrage an den folgenden Endpunkt und ersetzen Sie dabei waba_id mit der ID des WhatsApp Business Accounts, für den Sie die Template Analytics-Daten abrufen möchten:

https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/pricing-analytics

Die unten aufgeführten Abfrageparameter können zum Filtern der Ergebnisse verwendet werden:

Name Typ Erforderlich Anmerkungen
start string(Zeitstempel) Nein Das Startdatum und die Startzeit für die abzurufenden Analysedaten, im Format YYYY-MM-DD.
end string(Zeitstempel) Nein Das Enddatum und die Endzeit für die Analysedaten, die abgerufen werden sollen, im Format YYYY-MM-DD.
granularity String Nein Muss einer der folgenden sein HALF_HOUR, DAILY, oder MONTHLY.
phone_numbers Array Nein Telefonnummern, für die Sie Auswertungen abrufen möchten. Wenn nichts angegeben wird, werden die Analysen für alle mit der WABA verbundenen Telefonnummern zurückgegeben. Beispiel: [ "16505550111" ]
country_codes Array Nein Zweibuchstabige Ländercodes für die Länder, für die Sie die Analysen abrufen möchten. Wenn keine Angaben gemacht werden, werden die Analysen für alle Länder zurückgegeben. Beispiel: [ "US" ]
dimensions Array Nein Liste der Aufschlüsselungen, die Sie auf Ihre Metriken anwenden möchten. Wenn leer, werden alle Ergebnisse ohne Aufschlüsselung zurückgegeben. Kann enthalten PRICING_CATEGORY, PRICING_TYPE, COUNTRY, PHONEund TIER.
tier Array Nein Der Wert der Eigenschaft "Stufe" stellt eine Verkettung der Unter- und Obergrenzen für die Stufe dar, die für das Markt-Kategorie-Paar (Land und Preiskategorie) spezifisch ist. Beispiel: [ "0:100000" ]

Beispiel Antwort

{
   "granularity": "DAILY",
   "product_type": "cloud_api",
   "_embedded": {
      "pricing_analytics": [
         {
            "start": "2024-11-11T00:00:00Z",
            "end": "2024-11-11T00:00:00Z",
            "volume": 100,
            "phone_number": "14155552671",
            "country": "US",
            "tier": "75000:150000",
            "pricing_type": "REGULAR",
            "pricing_category": "AUTHENTICATION"
         }
      ]
   },
   "paging": {
      "cursors": {
         "before": "MjQZD",
         "after": "MAZDZD"
      },
      "previous": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MjQZD",
      "next": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MAZDZD"
   }
}

Weitere Lektüre