WhatsApp Analytics

Les analyses WhatsApp vous permettent de récupérer des indicateurs détaillés pour les numéros de téléphone professionnels et les modèles associés à votre WABA. Il s'agit par exemple du nombre et du type de messages envoyés, du nombre de fois où un modèle donné a été lu et du nombre de fois où un bouton d'un modèle a été cliqué.

Analyse de la messagerie

Les analyses de messagerie fournissent le nombre et le type de messages envoyés et délivrés par les numéros de téléphone associés à un WABA spécifique.

Exemple de demande

Pour récupérer les analyses de messagerie, envoyez une requête

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

Les données sont renvoyées avec une granularité demi-horaire, quotidienne ou mensuelle dans le fuseau horaire UTC, avec un recul pouvant aller jusqu'à 90 jours. Vous devez inclure les paramètres de début, de fin et de granularité dans votre demande, et il existe des paramètres optionnels que vous pouvez utiliser pour filtrer davantage les données :

Exemple de réponse

{
   "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"
   }
}

Analyse des modèles

Les analyses de modèles décrivent le nombre de fois qu'un modèle a été envoyé, livré et lu, et le nombre de fois que les boutons URL ou les boutons de réponse rapide du modèle ont été cliqués ; les analyses de clics sur les boutons ne sont disponibles que pour les modèles classés dans les catégories suivantes MARKETING ou UTILITY.

Les données sont renvoyées avec une granularité quotidienne dans le fuseau horaire UTC, avec un recul pouvant aller jusqu'à 90 jours.

Activation de l'analyse des modèles

Avant de pouvoir récupérer des analyses de modèles pour votre WhatsApp Business Account (WABA), vous devez activer la collecte d'insights au niveau du WABA. Les informations sont des données analytiques relatives aux messages, à la tarification ou aux modèles, y compris le suivi des clics sur les boutons ou les liens des modèles. Il s'agit d'une étape de configuration unique effectuée pour chaque WABA.

Enabling insights permet à Meta de :

• Collecte de données de chat anonymes à partir de votre WABA
• Générer des analyses de modèles montrant les mesures de livraison, de lecture et de clics.
• Fournir ces données par l'intermédiaire de l'API Template Analytics

Permettre à votre WABA de mieux comprendre

Critère d'évaluation :

Utilisez la même méthode d'authentification que les autres points d'extrémité du Channel Manager. La clé API doit être liée à l'identifiant WABA.

Codes de réponse :

Une fois les informations activées, attendez quelques minutes pour que le paramètre se propage. Vous pouvez alors commencer à récupérer les données d'analyse des modèles.

Exemple de demande

Pour récupérer les analyses de modèles, envoyez une requête

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

Les paramètres de requête détaillés ci-dessous peuvent être utilisés pour filtrer les résultats :

Exemple de réponse

{
   "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"
      }
   }
}

Analyse des prix

L'analyse de la tarification vous permet d'obtenir des informations sur la tarification et l'échelonnement des prix pour tout message délivré dans un intervalle de temps donné.

Exemple de demande

Pour récupérer les analyses de tarification, envoyez une requête

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

Les paramètres de requête détaillés ci-dessous peuvent être utilisés pour filtrer les résultats :

Exemple de réponse

{
   "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"
   }
}

Pour en savoir plus

• Spécification de l'API du gestionnaire de canaux
• Récupérer les données analytiques de la messagerie