Referência da API de Insights sobre Mensagens

Com a API de Insights sobre Mensagens, você pode ler, de forma programática, as mesmas informações exibidas na aba Insights da Página da sua Página do Facebook.

Para saber mais a respeito da API de Insights sobre Mensagens e de outras análises da plataforma do Messenger, consulte Análises.

Para obter mais informações sobre a API de Insights da Página, incluindo outras métricas disponíveis e as permissões necessárias, consulte a documentação sobre Insights da Página ou a referência do objeto Insights.

Permissões

Para interagir com esse ponto de extremidade, é preciso ter um token de acesso à Página com a permissão read_insights.

Exemplo de solicitação

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

Exemplo de resposta

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

Parâmetros

Parâmetro	Descrição
`breakdowns`	Dimensões em que a resposta é agrupada. Pode ser `messaging_channel` (Messenger ou Instagram), `recurring_notification_topic`, `recurring_notifications_freuency`
`date_preset`	Intervalo de datas relativo que pode ser usado no lugar de `since` e `until`. Pode ser `last_week`, `last_month`, `last_quarter`, e mais.
`metric`	Uma lista separada por vírgulas das métricas que devem ser retornadas.
`period`	A agregação fornecida dentro do intervalo since/until ou date_preset. O `total_over_range` fornece um único valor para a métrica no intervalo de datas indicado. Pode ser `day`, `week`, `month`, `days_28` ou `total_over_range`
`since`	Registro de data e hora do UNIX da hora de início para obter a métrica.
`until`	Registro de data e hora do UNIX da hora de término para obter a métrica.

Métricas disponíveis

As seguintes métricas estão disponíveis na API de Insights sobre Mensagens:

Nome da `metric`	Descrição
`recurring_notification_tokens`	O número de vezes que uma conta assinou para receber mensagens de marketing da sua empresa. Se uma conta tiver assinado vários tópicos, ela será contabilizada novamente para cada um deles. Como é calculado: a métrica contabiliza o número de vezes que as contas concordaram em receber mensagens recorrentes menos o número de vezes que elas cancelaram a assinatura. Possíveis valores de `breakdowns`: `messaging_channel` `recurring_notifications_frequency` `recurring_notifications_topic` Essa métrica está em desenvolvimento.
`page_messages_engagement`	O número de vezes que os usuários interagiram com mensagens na Página da sua empresa tocando em um botão de chamada para ação. Essa métrica só inclui dados de mensagens de marketing. Possíveis valores de `breakdowns`: `messaging_channel` `recurring_notifications_topic` Essa métrica está em desenvolvimento.
`page_messages_sent`	O número de mensagens que a Página da sua empresa enviou a um cliente. Essa métrica só inclui dados de mensagens de marketing. Possíveis valores de `breakdowns`: `messaging_channel` `recurring_notifications_topic` Essa métrica está em desenvolvimento.
`page_messages_read_ratio`	O número de mensagens lidas dividido pelo número de mensagens enviadas pela sua Página. Algumas mensagens lidas podem não ser capturadas, como quando um cliente desativa as confirmações de leitura. Essa métrica só inclui dados de mensagens de marketing. Possíveis valores de `breakdowns`: `messaging_channel` `recurring_notifications_topic` Essa métrica está em desenvolvimento.
`page_messages_order_count`	O número de vezes que você criou um pedido em conversas por mensagem ou em apps ou sites de terceiros usados para gerenciar conversas por mensagem. Essa métrica está em desenvolvimento.
`page_messages_paid_order_earnings`	A quantia aproximada de dinheiro que você ganhou com pedidos criados em conversas por mensagem ou em apps ou sites de terceiros usados para gerenciar conversas por mensagem. Os ganhos finais podem ser diferentes devido às conversões de moeda. Essa métrica está em desenvolvimento.
`page_messages_with_business_outcomes`	O número de conexões por mensagem com pelo menos um pedido criado. Essa métrica está em desenvolvimento.
`page_messages_blocked_conversations_unique`	O número de conversas com a Página que foram bloqueadas.
`page_messages_new_conversations_unique`	O número de conversas por mensagem no Messenger que foram iniciadas por pessoas que nunca tinham enviado mensagens para a sua empresa antes.
`page_messages_reported_conversations_unique`	O número de conversas da sua Página que foram denunciadas por pessoas por motivos como spam ou por exibirem conteúdo inadequado.
`page_messages_total_messaging_connections`	O número de pessoas para as quais a sua empresa pode enviar mensagens. Essa métrica mostra o número de pessoas que já enviaram uma mensagem para a sua empresa no Messenger. Ela não inclui as pessoas que bloquearam ou denunciaram a empresa na plataforma. Pode haver algumas restrições à sua capacidade de enviar mensagens a conexões, como a limitação de quantas mensagens podem ser enviadas durante determinados períodos. Essa métrica inclui apenas as conexões feitas a partir de outubro de 2016, quando os dados foram disponibilizados.

Propriedades de resposta

Propriedade	Descrição
`data` matriz de objetos	Uma lista de objetos de métricas.
`name` string	O nome da métrica.
`period` string	O período durante o qual os dados foram coletados.
`values` matriz de objetos	Uma lista de dados para uma métrica.
`value` matriz de objetos	A contagem diária da métrica solicitada. Para métricas que detalham por tipo, um objeto com contagens para cada tipo será retornado.
`end_time` registro de data e hora do Unix	Registro de data e hora UTC da hora de término da métrica.

Veja também

Para obter mais informações a respeito do uso da API de Insights sobre Mensagens, leia o guia da API de Insights sobre Mensagens.