WhatsApp アナリティクス

WhatsAppアナリティクスでは、WABAに関連するビジネス電話番号やテンプレートの詳細なメトリックスを取得できます。例えば、送信されたメッセージの数や種類、テンプレートが読まれた回数、テンプレート内のボタンがクリックされた回数などです。

メッセージング分析

メッセージングアナリティクスは、特定のWABAに関連する電話番号で送受信されたメッセージの数と種類を提供します。

リクエスト例

メッセージング分析を取得するには、以下のエンドポイントに

GET
リクエストを送信する。 waba_id にはメッセージング分析データを取得したいWhatsAppビジネスアカウントのIDを入力してください：

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

データはUTCタイムゾーンで30分毎、日毎、月毎、最大90日間のルックバックで返される。リクエストには開始、終了、粒度のパラメータを含める必要があり、さらにデータを絞り込むために使用できるオプションのパラメータもあります：

名称 タイプ 必須 備考
start string(タイムスタンプ) はい アナリティクスデータを取得する開始日時のフォーマット。 YYYY-MM-DD.
end string(タイムスタンプ) はい アナリティクスデータを取得する終了日時のフォーマット。 YYYY-MM-DD.
granularity ストリング はい 取得する分析データの粒度。サポートされています：half_hour、daily、monthly
phone_number 配列 いいえ 分析結果を取得したい電話番号。空の場合、WABAに関連するすべての電話番号が含まれます。
product_types 配列 いいえ アナリティクスを取得するメッセージ・タイプの配列。指定できる値は次のとおりです。 0 通知メッセージおよび/または 2 をカスタマー・サポート・メッセージ用に指定します。指定しない場合は、すべてのメッセージタイプのアナリティクスが返されます。
country_codes 配列 いいえ アナリティクスを取得したい国の2文字の国コード。指定しない場合は、すべての国のアナリティクスが返されます。

完全なコード例は メッセージング分析の取得 コード・スニペット

回答例

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

テンプレート分析

テンプレート分析では、テンプレートが送信、配信、閲覧された回数、テンプレート内のURLボタンやクイック返信ボタンがクリックされた回数が表示されます。 MARKETING または UTILITY.

データはUTCタイムゾーンで1日単位、最大90日間のルックバックで返される。

注意：テンプレート解析を取得する前に、ビジネスアカウントでテンプレート解析を確認する必要があります。詳しくは WhatsApp ドキュメント をご覧ください。

リクエスト例

テンプレート解析を取得するには、以下のエンドポイントに

GET
リクエストを送信する。 waba_id にはテンプレート分析データを取得したいWhatsAppビジネスアカウントのIDを入力してください：

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

以下のクエリーパラメーターを使用して、結果を絞り込むことができます：

名称 タイプ 必須 備考
start string(タイムスタンプ) はい アナリティクスデータを取得する開始日時のフォーマット。 YYYY-MM-DD.
end string(タイムスタンプ) はい アナリティクスデータの取得終了日時。 YYYY-MM-DD.開始日と終了日の差は最大90日。
granularity ストリング はい 毎日でなければならない。
template_ids 配列 はい の配列。 template_ids アナリティクスを取得するテンプレートの数。最大10個。
metric_types 配列 いいえ アナリティクスを取得するメトリックタイプの配列。指定できる値は次のとおりです。 SENT, DELIVERED, READそして CLICKED.各タイプの意味についてはWhatsAppドキュメントをご参照ください。空の場合、全てのメトリックタイプのアナリティクスが返されます。

回答例

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

価格分析

価格分析では、指定した日付範囲内に配信されたメッセージの価格内訳とティアリング情報を取得できます。

リクエスト例

価格分析を取得するには、以下のエンドポイントに

GET
リクエストを送信します。 waba_id にはテンプレート分析データを取得したいWhatsAppビジネスアカウントのIDを入力してください：

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

以下のクエリーパラメーターを使用して、結果を絞り込むことができます：

名称 タイプ 必須 備考
start string(タイムスタンプ) いいえ アナリティクスデータを取得する開始日時。 YYYY-MM-DD.
end string(タイムスタンプ) いいえ アナリティクスデータの取得終了日時。 YYYY-MM-DD.
granularity ストリング いいえ のいずれかでなければならない。 HALF_HOUR, DAILYあるいは MONTHLY.
phone_numbers 配列 いいえ アナリティクスを取得したい電話番号。指定しない場合は、WABAに関連付けられているすべての電話番号のアナリティクスが返されます。例 [ "16505550111" ]
country_codes 配列 いいえ アナリティクスを取得したい国の2文字の国コード。指定しない場合は、すべての国のアナリティクスが返されます。例 [ "US" ]
dimensions 配列 いいえ メトリクスに適用したい内訳のリスト。空の場合は、ブレイクダウンなしですべての結果が返されます。以下の項目を含めることができます。 PRICING_CATEGORY, PRICING_TYPE, COUNTRY, PHONEそして TIER.
tier 配列 いいえ tier プロパティの値は、マーケットとカテゴリのペア（国と pricing_category）に固有の tier の下限値と上限値を連結したものです。例 [ "0:100000" ]

回答例

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

さらに読む