Справка по API Messaging Insights

API Messaging Insights позволяет с помощью программных средств получать информацию, доступную на вкладке "Статистика Страницы" вашей Страницы Facebook.

Подробнее об API Messaging Insights и о других доступных на платформе Messenger инструментах аналитики.

Узнать больше об API Pages Insights, в том числе о других доступных метриках и обязательных разрешениях, можно в документации Pages Insights или справке по объектам статистики.

Разрешения

Для взаимодействия с этой конечной точкой необходим маркер доступа к Странице с разрешением read_insights.

Пример запроса

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

Пример ответа

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

Параметры

Параметр	Описание
`breakdowns`	Величины, по которым группируются ответы. Варианты: `messaging_channel` (Messenger либо Instagram), `recurring_notifications_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 Messaging Insights.

Название метрики (`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`	Количество раз, когда раз вы создавали заказ в переписках в приложениях Meta или в сторонних приложениях либо на сайтах, используемых для управления такими переписками. Сейчас эта метрика находится на этапе разработки.
`page_messages_paid_order_earnings`	Приблизительная сумма, которую вы заработали на заказах, оформленных в переписках в приложениях Meta или в сторонних приложениях либо на сайтах, используемых для управления такими переписками. После конвертации валют окончательные показатели дохода могут отличаться. Сейчас эта метрика находится на этапе разработки.
`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 года (когда стали доступны данные).

Свойства ответа

Свойство	Описание
`data` Массив объектов	Список объектов метрики
`name` Строка	Название метрики
`period` Строка	Период времени, за который были собраны данные.
`values` Массив объектов	Список данных метрики.
`value` Массив объектов	Счетчик значения запрашиваемой метрики за день. При запросе метрик с разбивкой по типу будет возвращен объект, содержащий количество для каждого типа.
`end_time` Метка времени в формате Unix	Метка времени конца диапазона по стандарту UTC для метрики.

Статьи по теме

Узнать больше об API Messaging Insights можно в разделе Об использовании API Messaging Insights.