使用可能なメトリクスとフィルターを理解する

メトリクスAPI は、コミュニケーションキャンペーンを分析するための包括的なツールを提供します。メトリクスとフィルターを組み合わせることで、パフォーマンス指標に関するより深いインサイトを得ることができ、特定の分析ニーズに合わせてクエリを調整できます。メトリクスは、配信成功率、トラフィック数やエンゲージメントレベルといった重要なパフォーマンス指標を計測するツールであるのに対し、フィルターは、チャネル、時間、トラフィックの種類や送信者ごとに計測データを絞り込めるようにするツールです。それらを適切に組み合わせることによって、詳細なレポートを作成したり、メッセージング戦略を最適化したりすることが可能になります。

フィルターを使用すると、クエリをカスタマイズし、エンゲージメントの時間枠やエラーコードなどの特定の特性に焦点を当てることができます。この柔軟性により、分析および意思決定プロセスに最も関連性の高いデータの取得が可能になります。

メトリクス

以下は、メトリクスAPIで取得できる API用のメトリクスです。例えば、トラフィックの総数、クリック率や配信成功率などを確認したい時には、そうした特定のパフォーマンス指標をフェッチするメトリクスを指定することができます。こうしたメトリクスからは、戦略を効果的に監視したり、最適化したりすることを可能にする貴重なインサイトが得られます。

VoiceとVideo関連のメトリクス

VoiceやVideoを使ったコミュニケーションのパフォーマンスを計測するメトリクスについては、使用可能なデータ、フィルターや集計ロジックの違いによって記述する内容が変わるため、別のページで詳細に説明します。応答率、正常接続率、通話結果などのVoice固有のパフォーマンス指標については、Voice とVideo関連メトリクスとフィルターと題したドキュメントをご参照ください。

配信

メトリクス名	API構文	説明
トラフィックの総数	`TOTAL_TRAFFIC_COUNT`	顧客に送信したメッセージまたはその一部 (アウトバウンド) と顧客から受信したメッセージ (インバウンド) の総数です。
受け入れられたトラフィックの総数	`TOTAL_ACCEPTED_TRAFFIC_COUNT`	顧客に送信して受け入れられたメッセージ (アウトバンド) の総数です。チャネル特性： Retrievable only for Email.
メッセージによるインタラクションの回数	`INTERACTION_COUNT`	個別のメッセージでやり取りしたインタラクションの回数です。 `TRAFFIC_TYPE`ディメンションと組み合わせると、インタラクションをWhatsApp、RCSやViber Business Messagesといった会話またはセッション別のカテゴリーに分類することで、特定のメッセージングトラフィックを分析しやすくなります。 WhatsAppに関する注意事項： 2025年7月1日以降、WhatsAppのトラフィックの種類は、会話ごとではなくメッセージごとに分類されます。メッセージレベルのトラフィック分類を使用すると、正確なレポートを作成できます。詳細については、下記の WhatsApp のトラフィックの種類に関する概要をご参照ください。
SMSメッセージの総数	`TOTAL_SMS_MESSAGES_COUNT`	顧客との間で送受信されたSMSメッセージ (インバウントとアウトバウンド) の総数です。長さの関係で複数のセグメントに分割されたメッセージは、1つの個別のメッセージとしてカウントされます。チャネル特性： SMSでのみ取得できます。
送信したメッセージの総数	`TOTAL_SENT_TRAFFIC_COUNT`	配信 (アウトバウンド) 用に送信されたメッセージの総数です。チャネル特性：メールサービスに関しては、これはプラットフォームからメールボックスプロバイダーに送信されたメールの総数を指します。
配信したメッセージの総数	`DELIVERED_TRAFFIC_COUNT`	受信者に配信されたメッセージの総数です。
配信率	`TRAFFIC_DELIVERY_RATE`	受信者に正常に配信されたメッセージの割合です。計算式：メールを除くすべてのチャネルの場合：総配信数 / (総送信数 - 総拒否数) メールの場合：総配信数 / 総送信数
5秒以内の配信率	`TRAFFIC_DELIVERED_IN_5_SEC_RATE`	5秒以内に配信されたメッセージの割合です。

インバウンド

メトリクス名	API構文	説明
受信トラフィック数	`TOTAL_RECEIVED_TRAFFIC_COUNT`	顧客から受信したメッセージ (インバウンド) の総数です。チャネル特性：このメトリクスは、インバウンドメッセージをサポートしていないメッセージングチャネル、またはインバウンドメッセージを受信するように構成されていないNTT CPaaS プラットフォームからのデータを提供しない可能性があります。
受信数と送信数の比率	`RECEIVED_TO_SENT_TRAFFIC_RATIO`	拒否されずに受信した (インバウンド) メッセージと送信した (アウトバウンド) メッセージの比率です。チャネル特性：このメトリクスは、インバウンドメッセージをサポートしていないメッセージングチャネル、またはインバウンドメッセージを受信するように構成されていないNTT CPaaS プラットフォームからのデータを提供しない可能性があります。

配信の失敗

メトリクス名	API構文	説明
配信できなかったメッセージの総数	`FAILED_TRAFFIC_COUNT`	受信者に送信したが、配信されなかった (インバウンド) メッセージの総数です。チャネル特性：メールでは取得できません。配信に失敗したメッセージの数を確認したい場合は、`TOTAL_DROPPED_COUNT`をご使用ください。
バウンスしたメールの総数	`TOTAL_BOUNCE_COUNT`	受信者に配信されなかったメールの総数で、これにはソフトバウンス (一時的な問題) またはハードバウンス (永続的な問題) が原因で配信できなかったメールも含まれます。チャネル特性：メールでのみ取得できます。
バウンス率	`TOTAL_BOUNCE_RATE`	受信者の受信トレイに配信されなかったメールの割合です。これにはソフトバウンスまたはハードバウンスが原因で配信できなかったメールも含まれます。この割合は、ソフトバウンスされたメッセージとハードバウンスされたメッセージの総数を、送信したメッセージの総数で割って算出します。チャネル特性：メールでのみ取得できます。
ドロップされたメールの総数	`TOTAL_DROPPED_COUNT`	受信者が登録を解除したため、アドレスがバウンスしたため、メッセージが迷惑メールとしてマークされたため、ドメインがブロックされていたか検証できなかったため、あるいは送信者側のエラー (例えば、テンプレートが期限切れであった、URLが多すぎるなどのコンテンツ関連の問題) が発生したためなど、様々な理由により配信前にドロップされた送信済みメールの総数です。チャネル特性：メールでのみ取得できます。
ドロップ率	`TOTAL_DROPPED_RATE`	ドロップされたメールの数を受け入れられたメールの数で割って計算された割合です。チャネル特性：メールでのみ取得できます。
抑制されたメールの総数	`TOTAL_SUPPRESSED_COUNT`	バウンスまたは受信者の否定的な反応 (メールを迷惑メールとしてマークしたこと) が原因で送信されなかったメールの総数です。チャネル特性：メールでのみ取得できます。
ソフトバウンス	`SOFT_BOUNCE_COUNT`	受信者に一時的に配信できなくなったメールの数です。これは、受信者の受信トレイが一杯になっているか、ドメインが一時的に使用できないか、メールボックスプロバイダーが正当性を疑っているか、受信者のオプトインがないなどの原因で発生する可能性があります。チャネル特性：メールでのみ取得できます。
ソフトバウンス率	`SOFT_BOUNCE_RATE`	受信者に一時的に配信できなかったメールの割合です。この割合は、ソフトバウンスされたメッセージの総数を送信したメッセージの総数で割って算出します。チャネル特性：メールでのみ取得できます。
ハードバウンス	`HARD_BOUNCE_COUNT`	特定の受信者にメールを配信しようとした時に、メールボックスプロバイダーから永続的なエラーを受信したメールの数です。チャネル特性：メールでのみ取得できます。
ハードバウンス率	`HARD_BOUNCE_RATE`	受信者に永続的に配信できないメールの割合です。この割合は、ハードバウンスされたメッセージの総数を送信したメッセージの総数で割って算出します。チャネル特性：メールでのみ取得できます。

既読／開封済み

メトリクス名	API構文	説明
既読数／一意の開封数	`SEEN_OPENED_TRAFFIC_COUNT`	一意の受信者が開封または閲覧したメッセージの数です。この場合、各受信者が同じメッセージを何回開封または閲覧したかに関わらず、それぞれが開封または閲覧したメッセージの数は１としてカウントされます。もしその中に、開封確認または既読通知をオフにしている受信者が含まれていると、既読のカウント数が実際の開封数より少なくなる可能性があることも考慮しておく必要があります。チャネル特性：このメトリクスは、コールバック機能をサポートしていないメッセージングチャネルのデータを提供しない場合があります。これはエンゲージメント関連の指標をキャプチャするように設計されているメトリクスで、WhatsApp、ViberやRCSなど、一定のプラットフォームでのみサポートされています。メールでは、一意の開封メッセージの数が返されます。
既読率／一意の開封率	`SEEN_OPENED_TRAFFIC_RATE`	一意の受信者が開封または閲覧したメッセージの割合です。もしその中に、開封確認または既読通知をオフにしている受信者が含まれていると、既読のカウント数が実際の開封数より少なくなる可能性があることも考慮しておく必要があります。チャネル特性：このメトリクスは、コールバック機能をサポートしていないメッセージングチャネルのデータを提供しない場合があります。これはエンゲージメント関連の指標をキャプチャするように設計されているメトリクスで、WhatsApp、ViberやRCSなど、一定のプラットフォームでのみサポートされています。メールでは、一意の開封メッセージの割合が返されます。
開封数	`VIEWED_TOTAL_COUNT`	1つのメールアドレスあたりの開封メッセージの数です。同じ受信者が複数回開封したメールもカウントされます。チャネル特性：メールでのみ取得できます。
開封率	`VIEWED_TOTAL_RATE`	キャンペーン用メールを開封した受信者の割合です。チャネル特性：メールでのみ取得できます。

クリック数／エンゲージメント

メトリクス名	API構文	説明
ユニーククリック数	`UNIQUE_CLICKS_COUNT`	メッセージ内のリンクをクリックした一意の受信者の数で、そのメッセージ内でクリックされたリンクの数に関係なく、各受信者は１としてカウントされます。チャネル特性：このメトリクスは、次の状況では値を返さない場合があります。データは、NTT CPaaSのSaaS製品・ツールまたはAPIを介してメッセージを送信する時に短縮機能とトラッキング機能が有効になっている場合にのみキャプチャされます。トラッキング機能は、Apple Messages for BusinessやMessengerなど、一部のチャネルでは利用できない場合があります。詳しくは、対応チャネルの全リストをご確認ください。メールについては、ユニーククリックのみが考慮されます。
ユニーククリックスルー率	`UNIQUE_CLICK_THROUGH_RATE`	配信されたメッセージの総数に対して、リンクをクリックした一意の受信者の割合です。1 つのメッセージ内でクリックされたリンクの数は関係なく、各受信者は 1 としてカウントされます。チャネル特性：このメトリクスは、次の状況では値を返さない場合があります。データは、NTT CPaaSのSaaS製品・ツールまたはAPIを介してメッセージを送信する時に短縮機能とトラッキング機能が有効になっている場合にのみキャプチャされます。トラッキング機能は、Apple Messages for BusinessやMessengerなど、一部のチャネルでは利用できない場合があります。詳しくは、対応チャネルの全リストをご確認ください。メールの場合、メールキャンペーン内のリンクをクリックした受信者の割合を返します。
ユニーククリックしたURL数	`UNIQUE_URL_CLICK_COUNT`	1つのメッセージでユニーククリックされたURLの数です。チャネル特性：このメトリクスは、次の状況では値を返さない場合があります：データは、NTT CPaaSのSaaS製品・ツールまたはAPIを介してメッセージを送信する時に短縮機能とトラッキング機能が有効になっている場合にのみキャプチャされます。トラッキング機能は、Apple Messages for BusinessやMessengerなど、一部のチャネルでは利用できない場合があります。詳しくは、対応チャネルの全リストをご確認ください。
クリック開封率 (CTOR)	`CLICK_TO_OPEN_RATE`	ユニーククリック数をユニーク開封数または既読数で割って算出した受信者の割合です。(受信したメッセージでクリックしたリンクの数に関係なく、各受信者は１としてカウントされます。)
合計クリック数	`TOTAL_CLICKS_COUNT`	1つのメッセージ内のすべてのURLがクリックされた回数 (同じリンクが複数回クリックされた回数も含む) の合計です。例えば、メッセージに3つのリンクがあり、各リンクが2回クリックされた場合、クリック数は合計6とカウントされます。チャネル特性：このメトリクスは、次の状況では値を返さない場合があります：データは、NTT CPaaSのSaaS製品・ツールまたはAPIを介してメッセージを送信する時に短縮機能とトラッキング機能が有効になっている場合にのみキャプチャされます。トラッキング機能は、Apple Messages for BusinessやMessengerなど、一部のチャネルでは利用できない場合があります。詳しくは、対応チャネルの全リストをご確認ください。メールの場合、メールごとのクリック数がカウントされます。登録解除リンクを除くすべてのURLのクリック数がカウントされます。
クリック率	`TOTAL_CLICK_RATE`	リンクをクリックした受信者の割合です。この割合は、メッセージ内のすべてのURLをクリックした回数の合計を配信したメッセージの総数で割って算出します。例えば、200件のSMSメッセージが送信され、クリック数が合計400回であった場合、`TOTAL_CLICK_RATE`は200%になります。

フィードバック

メトリクス名	API構文	説明
登録解除件数	`UNSUBSCRIBED_USER_COUNT`	送信用のアドレスから送信されるコミュニケーションを今後受け取らないように登録を解除 (オプトアウト) した受信者の数です。チャネル特性：メールでのみ取得できます。
登録解除率	`UNSUBSCRIBED_USER_RATE`	送信元アドレスから送信される今後のコミュニケーションの受け取りを停止 (オプトアウト) した受信者の割合です。チャネル特性：メールでのみ取得できます。
迷惑メールの苦情件数	`EMAIL_COMPLAINTS_COUNT`	受信者が迷惑メールとして報告したメールの数です。チャネル特性：メールでのみ取得できます。
迷惑メール苦情率	`EMAIL_COMPLAINTS_RATE`	受信者が迷惑メールとして報告したメールの割合です。チャネル特性：メールでのみ取得できます。

アグリゲーション／ディメンション

メトリクスは、有意義なグループに分けて表示することができます。例えば、送信者、ネットワークまたは国ごとにトラフィックの総数を表示すると、その影響度がより明確になります。

NTT CPaaSのAPIは、時間の間隔、メッセージのステータスやエラーのタイプに分けてグループ化することを含む、データアグリゲーション用のオプション (aggregateBy) を幅広く提供しています。このグループ化機能により、データ分析が簡素化され、大容量なデータセットから有意義な洞察を抽出することが容易になります。

ディメンション名	説明
`ACCOUNT_KEY`	応答内のアカウントキーごとに結果をグループ化し、対応するアカウントキーの値を表示します。
`HOUR`	結果を時間ごとにグループ化し、対応するタイムスタンプの値を表示します。
`DAY`	結果を日ごとにグループ化し、対応する日の値を表示します。
`WEEK_SATURDAY_START`	土曜日から始まる週ごとに結果をグループ化し、対応するタイムスタンプの値を表示します。
`WEEK_SUNDAY_START`	日曜日から始まる週ごとに結果をグループ化し、対応するタイムスタンプの値を表示します。
`WEEK_MONDAY_START`	月曜日から始まる週ごとに結果をグループ化し、対応するタイムスタンプの値を表示します。
`MONTH`	結果を月ごとにグループ化し、対応する月の値を表示します。
`QUARTER`	結果を四半期ごとにグループ化し、対応する四半期の値を表示します。
`YEAR`	結果を年ごとにグループ化し、対応する年の値を表示します。
`TIME_TO_DELIVER`	結果を「配信時間」として設定した期間ごとにグループ化し、対応する「配信時間」として設定した期間の値を表示します。
`TIME_TO_CLICK_FROM_SEEN`	メッセージのクリックと閲覧したイベントの間の時間差 (秒数) ごとに結果をグループ化し、計算値を表示します。
`TIME_TO_CLICK_FROM_DELIVERED`	メッセージのクリックと配信されたイベントの間の時間差 (秒数) ごとに結果をグループ化し、計算値を表示します。
`TIME_TO_SEEN_FROM_DELIVERED`	閲覧したメッセージと配信されたイベントの間の時間差 (秒数) ごとに結果をグループ化し、計算値を表示します。
`TIME_TO_OPEN_FROM_DELIVERED`	メッセージの開封イベントと配信イベントの間の時間 (秒) の差で結果をグループ化し、計算された値を表示します。
`CHANNEL_CODE`	結果をチャネルごとにグループ化し、対応するチャネルコードの値を表示します。
`CHANNEL_NAME`	結果をチャネル名ごとにグループ化し、対応するチャネル名の値を表示します。
`DIRECTION`	結果をトラフィック方向ごとにグループ化し、対応する方向の値 (クライアントに送信されたトラフィックの場合は`OUTBOUND`、クライアントから受信したトラフィックの場合は`INBOUND`)　を表示します。
`TRAFFIC_TYPE`	結果をトラフィックの種類ごとにグループ化し、対応するトラフィックの種類の値を表示します。
`SENDER`	結果を送信者ごとにグループ化し、対応する送信者の値を表示します。
`SENDER_TYPE`	結果を送信者のタイプごとにグループ化し、対応する送信者タイプの値を表示します。
`SENDER_DOMAIN`	結果を送信者のドメインごとにグループ化し、対応する送信者のドメインの値を表示します。
`RECIPIENT_DOMAIN`	結果を受信者のドメインごとにグループ化し、対応する受信者のドメインの値を表示します。
`URL`	結果をメッセージの最初のURLごとにグループ化し、対応する URLの値を表示します。非URL測定項目には、`aggregateBy` URLを使用できないことにご注意ください。`UNIQUE_URL_CLICK_COUNT` は有効ですが、`TOTAL_TRAFFIC_COUNT` は無効です。
`COMMUNICATION`	結果をコミュニケーションごとにグループ化し、対応する通信IDの値を表示します。
`CAMPAIGN_REFERENCE`	結果をキャンペーン参照ごとにグループ化し、対応するキャンペーン参照IDの値を表示します。
`NETWORK_ID`	結果をネットワークごとにグループ化し、対応するネットワークIDの値を表示します。
`NETWORK_NAME`	結果をネットワークごとにグループ化し、対応するネットワーク名の値を表示します。
`COUNTRY_ID`	結果を国ごとにグループ化し、対応する国IDの値を表示します。
`COUNTRY_NAME`	結果を国ごとにグループ化し、対応する国名の値を表示します。
`APPLICATION_ID`	結果をアプリケーションごとにグループ化し、対応するアプリケーションIDの値を表示します。
`ENTITY_ID`	結果をエンティティごとにグループ化し、対応するエンティティIDの値を表示します。
`STATUS_GROUP`	結果をステータスグループごとにグループ化し、対応する応答のステータスグループの値を表示します。
`STATUS`	結果をステータス名ごとにグループ化し、対応する応答のステータスの値を表示します。
`ERROR_GROUP`	結果をエラーグループごとにグループ化し、対応する応答のエラーグループの値を表示します。
`CAPABILITY`	結果を機能別にグループ化し、対応する機能コード値を表示します。

チャネルコードによる強制アグリゲーション

CHANNEL_CODE ディメンションは、aggregateBy パラメーターで指定されているかどうかに関係なく、常に結果に含まれます。これにより、算出されたメトリクスの整合性と正確性が保たれます。例えば、HOURのみでアグリゲーションをリクエストした場合でも、結果にはCHANNEL_CODEディメンションが含まれます。
最初のリクエストでCHANNEL_CODEもCHANNEL_NAMEも指定されていない場合、CHANNEL_CODEディメンションが結果に暗黙的に追加されます。
CHANNEL_NAMEで集計することを選択した場合、CHANNEL_CODEは自動的に追加されません。これにより、クライアントは必要に応じて両方の値を柔軟に持つことができます。

フィルター

様々なフィルタリングオプションを使用することにより、クエリをカスタマイズしたり、特定の特性によって結果を絞り込むことができます。こうしたオプションを柔軟に組み合わせることにより、特定の要件にだけ焦点を当てたデータを取得できるようになります。

フィルター	API構文	説明	必須
アカウント	`accountKeys`	accountKeys (opens in a new tab) に基づいて特定のアカウントだけををターゲットにすることができます。レガシーアカウントには、制限事項が適用されることがあります。	不可
サブアカウント	`includeSubaccounts`	網羅的な分析を行う際に必要になるサブアカウントのトラフィックデータが含まれます。	不可
送信時間範囲	`sentSinces`	メッセージを送信する特定の時間枠が含まれます。	可
送信時間範囲	`sentUntil`	メッセージを送信する特定の時間枠が含まれます。	可
エンゲージメントの時間枠	`timeToDeliver`	タイムバケットを使用してメッセージが配信される時間を表します。たとえば、1 秒以内に配信されたメッセージのみをフィルター処理できます。 `from`バケットは包括的ですが、`to`バケットは排他的です。	不可
	`timeToClickFromSeen`	タイムバケットを使用してメッセージが表示された後に URL がクリックされた時間を表します。たとえば、URL が表示されてから 1 秒以内にクリックされたメッセージのみをフィルタリングできます。 `from`バケットは包括的ですが、`to`バケットは排他的です。
	`timeToClickFromDelivered`	タイムバケットを使用してメッセージが配信された後、URL がクリックされた時間を表します。たとえば、配信後 1 秒以内に URL がクリックされたメッセージのみをフィルタリングできます。 `from`バケットは包括的ですが、`to`バケットは排他的です。
	`timeToSeenFromDelivered`	タイムバケットを使用してメッセージが配信された後、メッセージが表示される時間を表します。たとえば、配信後 1 秒以内に表示されたメッセージのみをフィルター処理できます。 `from`バケットは包括的ですが、`to`バケットは排他的です。
	`timeToOpenFromDelivered`	タイムバケットを使用してメッセージが配信された後、メッセージが開かれる時間を表します。たとえば、配信後 1 秒以内に表示されたメッセージのみをフィルター処理できます。 `from`バケットは包括的ですが、`to`バケットは排他的です。
ステータスとエラーコード	`statusGroups`	特定のステータスまたはエラーコードでフィルタリングします。利用可能な [一般的なステータスコード]の一覧 (/essentials/api-essentials/response-status-and-error-codes#general-status-codes)。利用可能な [メッセージステータス]の一覧 (/essentials/api-essentials/response-status-and-error-codes)。利用可能な[エラーコード]の一覧 (/essentials/api-essentials/response-status-and-error-codes#error-codes)。	不可
	`statuses`
	`errorGroups`
	`errorCodes`
方向	`direction`	送受信の方向に基づいてトラフィックを分類し、アウトバウンドとインバウンドのメッセージを区別します。	不可
チャネル	`channelCodes`	通信チャネルに基づいてトラフィックを分類します。	可
資格	`capabilities`	そのチャネル内の機能、テクノロジ、またはフレーバーを指定して、チャネルまたはサービス間で類似したサービスを簡単に識別できるようにします。使用可能な機能とそのコード: LINE Official Account: `LINE_OA` LINE Official Notifications: `LINE_ON` Kakao Alim: `KAKAO_A` Kakao Chingu: `KAKAO_C` Kakao Sangdam: `KAKAO_S` Zalo Notification Services: `ZALO_NS` Zalo Follower: `ZALO_F` Viber Business Messages: `VIBER_BM` Viber Bots: `VIBER_BOTS` Facebook Messenger: `MESSENGER` Instagram Direct Messaging: `INSTAGRAM_DM`	可
トラフィックの種類	`trafficTypes`	指定可能なトラフィックの種類の値の一覧	不可
送信者	`senders`	特定の送信者または送信者の種類に基づいてトラフィックをフィルタリングします。指定可能な送信者の種類の値の一覧。	不可
送信者の種類	`senderTypes`	特定の送信者または送信者の種類に基づいてトラフィックをフィルタリングします。指定可能な送信者の種類の値の一覧。	不可
通信ID	`communicationIds`	通信IDなどの特定の識別子に基づいてトラフィックを分類します。これは、ブロードキャストやMoments (フロー) をはじめとするNTT CPaaSのSaaSソリューションを介して送信されるトラフィックにのみ適用されます。	不可
キャンペーン参照ID	`campaignReferenceIds`	キャンペーン参照ID などの特定の識別子に基づいてトラフィックを分類します。これは、NTT CPaaS API を介して送信されるトラフィックにのみ適用されます。	不可
ネットワーク	`networkIds`	ネットワークID や国ID などの特定の識別子に基づいてトラフィックを分類します。	不可
国	`countryIds`	ネットワークID や国ID などの特定の識別子に基づいてトラフィックを分類します。	不可
アプリケーション	`applicationId`	applicationId や entityId などの追加の CPaaSX パラメーターを含めると、コミュニケーションアクティビティのソースや目的に関する貴重なインサイトを得て、分析の精度を高め、より適切な意思決定を下しやすくなります。メトリクスAPIは、1つのリクエスト内でアプリケーションとエンティティのペアを複数使ってデータを絞り込む、高度なフィルタリング機能をサポートしています。これらのパラメーターは、CPaaSXの概念と機能が利用可能な時に使用します。 CPaaSXの詳細については、こちらをご参照ください。	不可
エンティティ	`entityId`		不可

チャネル

以下は、利用可能なチャネルとサービス、およびそれらのコードの一覧です。

ディメンション名	説明
「SMS」	SMS
「メール」	メール
「フェイスブック」	Facebook Messenger
「インスタグラム」	Instagram Messaging
「カカオ」	カカオ
「ライン」	線
`MMS`	MMS
「RCS」	RCS
「テレグラム」	Telegram
「バイバー」	Viber
`VOICE_VIDEO`	Voice and Video
「ワッツアップ」	WHATSAPP
「ザロ」	Zalo
`APPLE_MB`	Apple Messages for Business

トラフィックの種類

WhatsApp、RCS、Viber Business Messages などのメッセージングプラットフォームでは、トラフィックの種類によって、目的と性質に基づいてメッセージングのやり取りが分類されます。この構造化された分類は、通信パターンに関する貴重な分析情報を提供し、メッセージング動作の分析に役立ちます。

WhatsAppメッセージのトラフィックの種類の分類方法は、特定のメッセージ送信日を境に変わります。

2025年6月30日以前に送信されたメッセージ

トラフィックの種類は、会話レベルで適用されます：

Marketing (マーケティング)：顧客エンゲージメントを目的としたプロモーション用メッセージのことです。
Utility (ユーティリティ)：注文確認などの重要なアップデート情報を提供するトランザクション用メッセージのことです。
Authentication (認証)：ワンタイムパスワード (OTP) など、ID検証に使用されるメッセージのことです。
Service conversations (サービス会話)：典型的に顧客によって開始されるカスタマーサービス関連のインタラクションのことです。
MM Lite：マーケティングカテゴリーと同じユースケースを対象としていますが、MetaのMM Liteプログラムに参加している企業向けのものです。

この期間中の会話レベルのトラフィックに関するレポートを作成する場合は、INTERACTION_COUNTを使用します。TRAFFIC_TYPEには、上記の従来の分類が反映されます。

2025年7月1日以後に送信されたメッセージ

トラフィックの種類は、メッセージレベルで適用されます：

Marketing (マーケティング)：ユーザーに行動を促すプロモーション、オファー、または最新の情報を送信するメッセージのことです。内容が混在していたり、不明瞭であったりするテンプレートも、マーケティングに分類されます。
Utility (ユーティリティ)：注文、アカウント、サービス、取引に関連するプロモーション以外のメッセージのことです。。また、詐欺アラートなどの重要なアップデートにも使用されます。
Authentication (認証)：ログイン、アカウントの検証、またはリカバリーのためのワンタイムパスコード(OTP)を含むメッセージのことです。
Authentication - International (認証 - 国際)：Authentication (認証) と同じですが、30日間に75万件以上のメッセージが送信された特定の国に適用されます。
MM Lite：マーケティングと同じユースケースですが、MetaのMM Liteプログラムに参加している企業に適用されます。
Free-form (フリーフォーム)：ユーザーが企業にメッセージを送信した後の24時間以内のアクティブな時間枠に送信されたフリーフォーム用メッセージのことです。応答ウィンドウは、各ユーザーのメッセージごとにリセットされます。

TRAFFIC_TYPEをレポートに使用する際、DELIVERED_TRAFFIC_COUNTやSENT_TRAFFIC_COUNTなどのメッセージレベルのメトリクスと組み合わせて使用します。2025年7月1日以降に送信されたWhatsAppトラフィックにはINTERACTION_COUNTを使用しないでください。

重要

トラフィックの種類とメッセージレベルのメトリクスは、レポートのみを目的としています。課金対象のイベントの計測には使用できません。メッセージの種類によっては、トラフィックが分類されている場合があり、常に課金対象のものであるとは限りません。例えば：

カスタマーサービスウィンドウを開いた間に送信されたユーティリティタイプのテンプレートメッセージには、トラフィックの種類がユーティリティのものが含まれる場合がありますが、それらは課金対象ではありません。
広告をクリックするとWhatsAppに移行するカスタマーサービスウィンドウを開いた場合、フリーフォーム用メッセージは課金されることがありますが、テンプレートは無料で使用でき、フリークエンシーキャップの対象となるメッセージもトラフィックの種類は保持するものの、料金が発生しない可能性があります。

RCS

トラフィックの種類は、次のように分類されます：

Basic transactions (基本的トランザクション)：通知などの単純なメッセージのやり取りのことです。
Single transactions (単一トランザクション)：ユーザーと企業間の 1 回限りのやり取りのことです。
A2P conversations (A2P会話)：アプリケーションから個人へのメッセージングのことで、多くの場合、プロモーションまたはトランザクションの目的で使用されます。
P2A conversations (P2A会話)：通常、エンドユーザーによって開始される個人からアプリケーションへのメッセージングのことです。

会話レベルのレポート (A2PおよびP2A) には、セッションベースのトラフィックであるため、INTERACTION_COUNTメトリクスを使用します。

単一トランザクションや基本的トランザクションのメッセージレベルのレポートには、DELIVERED_TRAFFIC_COUNTまたはSENT_TRAFFIC_COUNTメトリクスを使用します。

Viber Business Messages

トラフィックの種類は、次のように分類されます：

Transactional (トランザクション)：注文確認、サービス通知、配送アラートなどの重要なアップデート情報を提供するメッセージのことです。
Promotional (プロモーション)：オファー、お知らせ、またはマーケティングコンテンツを通じて顧客エンゲージメントを促進することを目的としたメッセージのことです。
OTP Template (OTPテンプレート)：安全な認証のためのワンタイムパスワード (OTP) メッセージ専用のテンプレートのことです。
International (国際)：ローカルマーケット以外のユーザーに送信されたプロモーション用トラフィックとトランザクション用トラフィックの両方を対象としています。
Session (セッション)：Viberのセッションルールに基づく双方向の会話を表します。プロモーションやトランザクションモデルを補完するように設計されています。
Regulated (Transactional, Promotional, OTP, Session, International) (規制対象 (トランザクション、プロモーション、OTP、セッション、国際))：上記と同じカテゴリーですが、特別な規制の対象となるギャンブル、マイクロクレジットやローンなどを扱う業界に適用されます。

会話レベルのレポート (セッション) には、INTERACTION_COUNTメトリクスを使用します。

メッセージレベルのレポート (トランザクション、プロモーション、OTP、国際) には、DELIVERED_TRAFFIC_COUNTまたはSENT_TRAFFIC_COUNTメトリクスを使用します。

主なメッセージ分析用メトリクス

INTERACTION_COUNT
- 個別のセッションまたは会話の数を表します。このメトリクスは、会話またはセッションの量をキャプチャすることで、メッセージングトラフィックの詳細なビューを提供します。
  - TRAFFIC_TYPEディメンションと組み合わせると、INTERACTION_COUNTは、インタラクションを会話やセッションなど、特定のRCS、WhatsAppまたはViber Business Messagesのカテゴリーに分類するのに役立ちます。(WhatsAppの場合、2025年6月30日以前に送信されたトラフィックに適用する必要があります。)

DELIVERED_TRAFFIC_COUNT
- 配信された個々のメッセージの数 を追跡します。
  - このメトリクスをTRAFFIC_TYPEディメンションと組み合わせて使用すると、個々のメッセージ (RSCの単一トランザクションや基本的トランザクション用メッセージ) の分析に最適で、メッセージ配信のパフォーマンスに関する詳細なインサイトが得られます。
    - RSCの単一トランザクションや基本的トランザクション用メッセージ
    - Viberのトランザクション、プロモーション、OTPまたは国際認証用メッセージ
    - Whatsappのユーティリティ、認証、国際認証、MM Lite用またはフリーフォーム用メッセージ

これらのメトリクスとディメンションを活用することで、企業は自社のメッセージング活動に関する実用的なインサイトを得て、コミュニケーション戦略をより深く理解し、最適化することができます。

ID	名前	説明
1	`UTILITY_CONVERSATION`	Whatsappのユーティリティ関連の会話
2	`AUTHENTICATION_CONVERSATION`	Whatsappの認証関連の会話
3	`MARKETING_CONVERSATION`	Whatsappのマーケティング関連の会話
4	`SERVICE_CONVERSATION`	Whatsappのサービス関連の会話
5	`MM_LITE`	WhatsappのMM Lite関連の会話
6	`BASIC_TRANSACTION_BASED_MESSAGE`	RCSの基本的トランザクション用メッセージ
7	`SINGLE_TRANSACTION_BASED_MESSAGE`	RCSの単一トランザクション用メッセージ
8	`A2P_CONVERSATION`	RCSのA2P (Application-to-Person) 方向の会話
9	`P2A_CONVERSATION`	RCSのP2A (Person-to-Application) 方向の会話
10	`TRANSACTIONAL` / `REGULATED_TRANSACTIONAL`	VIBER Business Messagesのトランザクション用メッセージ
11	`PROMOTIONAL` / `REGULATED_PROMOTIONAL`	VIBER Business Messagesのトランザクション用メッセージ
12	`OTP_TEMPLATE` / `REGULATED_OTP_TEMPLATE`	VIBER Business Messagesのトランザクション用メッセージ
13	`INTERNATIONAL` / `REGULATED_INTERNATIONAL`	VIBER Business Messagesのトランザクション用メッセージ
14	`SESSION` / `REGULATED_SESSION`	VIBER Business Messagesのトランザクション用メッセージ
15	`MARKETING`	Whatsappのマーケティング用メッセージ
16	`MM_LITE`	WhatsappのMM Lite用メッセージ
17	`UTILITY`	Whatsappのユーティリティ用メッセージ
18	`AUTHENTICATION`	Whatsappの認証用メッセージ
19	`AUTHENTICATION_INTERNATIONAL`	Whatsappの国際認証用メッセージ
20	`FREE_FORM`	Whatsappのフリーフォーム用メッセージ

送信者の種類

次の表は、メッセージング活動に使用できる様々な送信者の種類 (senderTypes) の概要をまとめたもので、それぞれ特定の目的を果たし、サポートされている地域も異なります。

ID	名前	説明
1	`ALPHANUMERIC`	英数字送信者
2	`SHORT_CODE`	ショートナンバー
3	`TOLL_FREE_NUMBER`	フリーダイヤル (北米限定)
4	`VIRTUAL_LONG_NUMBER`	バーチャルロングナンバー (VLN)
5	`10DLC`	10DLC (北米限定)
6	`DOMAIN`	メールに使用

Viber Business Messages や RCS などの一部のチャネルの送信者タイプは、特定の送信者タイプが関連しないため、チャネル値にマッピングされます。

資格

機能を使用して、チャネル内の特定のサービスまたはテクノロジを識別します。たとえば、カカオチングとカカオアリム、またはViberビジネスメッセージとViberボットを区別できます。これにより、類似したサービスのパフォーマンスを分析し、チャネル間で結果を一貫して比較することが容易になります。

サポートされている機能については、以下の表を参照してください。

機能コード	説明
`LINE_OA`	LINE公式アカウント
`LINE_ON`	LINE公式通知
`KAKAO_A`	Kakao Alim
`KAKAO_C`	Kakao Chingu
`KAKAO_S`	Kakao Sangdam
`ZALO_NS`	Zalo 通知サービス
`ZALO_F`	Zaloフォロワー
`VIBER_BM`	Viber Business Messages
`VIBER_BOTS`	Viber Bots
「メッセンジャー」	Facebook Messenger
`INSTAGRAM_DM`	Instagramダイレクトメッセージング

データのクエリ Voice and Video のメトリックとフィルタ