メッセージインサイトAPIのリファレンス

メッセージインサイトAPIを使用すると、Facebookページの[ページインサイト]タブに表示されるものと同じ情報を、プログラムを使用して取得できます。

Messengerプラットフォームで利用可能なメッセージインサイトAPIおよびその他の分析に関する詳細については、分析をご覧ください。

他の利用可能な指標や必要なアクセス許可など、ページインサイトAPIに関する詳細についてはページインサイトのドキュメントまたはインサイトオブジェクトのリファレンスをご覧ください。

アクセス許可

このエンドポイントとやり取りするには、read_insightsアクセス許可を持つページアクセストークンが必要です。

リクエストの例

curl -X GET "https://graph.facebook.com/v2.8/me/insights/?metric=

応答の例

{ 
  "data": [ 
    { 
      "name": "

パラメーター

パラメーター	説明
`breakdowns`	応答がグループ化されるディメンション。`messaging_channel` (MessengerまたはInstagram)、`recurring_notification_topic`、`recurring_notifications_freuency`
`date_preset`	`since`と`until`の代わりに使用できる相対的な期間。`last_week`、`last_month`、`last_quarter`、など。
`metric`	返される指標のコンマ区切りリスト
`period`	since/untilまたはdate_preset範囲内で提供された集計。`total_over_range`の値は、指定された期間の指標の単一の値を返します。`day`、`week`、`month`、`days_28`、`total_over_range`
`since`	指標を取得する期間の開始時間のUNIX タイムスタンプ
`until`	指標を取得する期間の終了時間のUNIX タイムスタンプ

利用できる指標

以下の指標は、メッセージングインサイトAPIで入手できます。

`metric`名	説明
`recurring_notification_tokens`	ビジネスからのマーケティングメッセージを受信するために1つのアカウントがサブスクリプション登録した回数。アカウントが複数のトピックをサブスクリプション登録している場合、トピックごとに再カウントされます。算出方法: この指標は、アカウントが定期的なメッセージを受信することに同意した回数から、アカウントがサブスクリプション登録を解除した回数を引いて算出されます。利用できる`breakdowns`値は次のとおりです。 `messaging_channel` `recurring_notifications_frequency` `recurring_notifications_topic` この指標は開発中です。
`page_messages_engagement`	CTAボタンをタップして、ユーザーがビジネスページでメッセージとやり取りした回数。この指標には、マーケティングメッセージからのデータのみが含まれます。利用できる`breakdowns`値は次のとおりです。 `messaging_channel` `recurring_notifications_topic` この指標は開発中です。
`page_messages_sent`	ビジネスページがメッセージを1人の顧客に送信したメッセージの数。この指標には、マーケティングメッセージからのデータのみが含まれます。利用できる`breakdowns`値は次のとおりです。 `messaging_channel` `recurring_notifications_topic` この指標は開発中です。
`page_messages_read_ratio`	既読のメッセージ数を、ページから送信されたメッセージ数で割った数。顧客が開封証明をオフにしている場合など、一部のメッセージ既読数はカウントされていない可能性があります。この指標には、マーケティングメッセージからのデータのみが含まれます。利用できる`breakdowns`値は次のとおりです。 `messaging_channel` `recurring_notifications_topic` この指標は開発中です。
`page_messages_order_count`	メッセージスレッドから、またはメッセージスレッドを管理するサードパーティのアプリやウェブサイトから、注文を作成した回数。この指標は開発中です。
`page_messages_paid_order_earnings`	メッセージスレッドから、またはメッセージスレッドの管理に使用されるサードパーティアプリやウェブサイトから作成された注文によって獲得した推定収益額。最終的な収益は、交換レートによって異なる場合があります。この指標は開発中です。
`page_messages_with_business_outcomes`	少なくとも1つの注文が作成されたメッセージのつながりの数。この指標は開発中です。
`page_messages_blocked_conversations_unique`	当該ページとのスレッドのうちブロックされた数。
`page_messages_new_conversations_unique`	これまでビジネスにメッセージを送ったことがない人と始まった、Messengerでのメッセージスレッドの数。
`page_messages_reported_conversations_unique`	スパムや不適切なコンテンツを含むなどの理由で報告を受けた、ページから発信されたスレッドの数。
`page_messages_total_messaging_connections`	自分のビジネスでメッセージを送信できる人の数。この指標は、これまでにMessengerでビジネスにメッセージを送信した人の数を表します(Messengerで該当ビジネスをブロックしたり何らかの報告を行ったりした人を除きます)。特定の時間帯に送信できるメッセージの数に制限があるなど、つながるためにメッセージを送信する能力に一定の制約がある場合があります。この指標にも、データが入手可能になった2016年10月以降にできたつながりのみが含まれます。

応答のプロパティ

プロパティ	説明
`data` オブジェクトの配列	指標オブジェクトのリスト
`name` 文字列	指標の名前
`period` 文字列	データが収集された期間
`values` オブジェクトの配列	指標のデータのリスト
`value` オブジェクトの配列	リクエストされた指標の1日当たりのカウント。型別内訳の指標については、各型ごとのカウントを含むオブジェクトが返されます。
`end_time` unixタイムスタンプ	指標の期間の終了時間のUTCタイムスタンプ。

参考情報

メッセージングインサイトAPIの使い方について詳しくは、メッセージングインサイト API利用ガイドをご覧ください。