消息功能成效分析 API 参考文档

借助消息功能成效分析 API，您可通过编程的方式检索 Facebook 公共主页的“公共主页成效分析”选项卡中显示的数据。

如需详细了解消息功能成效分析 API 及 Messenger 开放平台提供的其他分析，请参阅分析。

如需获取有关公共主页成效分析 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`	某个帐户订阅接收您企业营销信息的次数。如果一个帐户订阅了多个主题，则每个主题都将重新计入一次。计算方式：这项指标计算帐户同意接收定期消息的次数减去帐户退订的次数。 `breakdowns` 值可以是： `messaging_channel` `recurring_notifications_frequency` `recurring_notifications_topic` 这项指标仍在逐步发展。
`page_messages_engagement`	用户在企业公共主页上通过轻触行动号召按钮与消息互动的次数。该指标仅包含来自营销消息的数据。 `breakdowns` 值可以是： `messaging_channel` `recurring_notifications_topic` 这项指标仍在逐步发展。
`page_messages_sent`	企业公共主页发送给客户的消息数量。该指标仅包含来自营销消息的数据。 `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`	创建了至少一个订单的消息联系人数量。这项指标仍在逐步发展。
`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` 对象数组	每天请求的指标计数。对于按类型细分的指标，系统将返回包含每种类型计数的对象。
`end_time` UNIX 时间戳	指标的结束时间，以 UTC 时间戳表示。

另请参阅

如需详细了解消息功能成效分析 API 的使用情况，请访问消息功能成效分析 API 使用指南。