A tradução para Português (Brasil) não foi concluída ainda.
Atualização em Português (Brasil):
Measure Campaign Performance on Marketing Message API for Messenger
This document explains how to obtain insights for a marketing message campaign, including:
- Number of messages delivered
- Message read and click rate
- Cost per delivery and click
Insights on delivered messages
Send a GET request to the <MESSAGE_CAMPAIGN_ID>/insights endpoint to get insights for marketing messages campaign with the fields parameter set to one or more of the following fields:
marketing_messages_cost_per_deliveredmarketing_messages_cost_per_link_btn_clickmarketing_messages_deliveredmarketing_messages_link_btn_clickmarketing_messages_link_btn_click_ratemarketing_messages_read_ratemarketing_messages_spend
Sample request
Formatted for readability.
curl -i -X GET \
-H "Authorization: Bearer <SYSTEM_USER_ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<MESSAGE_CAMPAIGN_ID>/insights \
?fields=marketing_messages_delivered,marketing_messages_read_rate"
Field Reference
| Propriedade | Descrição |
|---|---|
| O custo médio por mensagem entregue. Essa métrica está em desenvolvimento. |
| O custo médio por cada clique no link da mensagem. Essa métrica não inclui mensagens enviadas para a Europa, Argentina, Turquia, Coreia do Sul e Japão. Essa métrica está em desenvolvimento. |
| O número de mensagens que uma empresa enviou a usuários e que foram entregues. Algumas mensagens podem não ser entregues (por exemplo, quando o dispositivo de um usuário está fora de serviço). Essa métrica não inclui mensagens entregues para a Europa e o Japão. Em alguns casos, essa métrica pode ser estimada e pode ser diferente do que é mostrado na sua fatura devido a pequenas variações no processamento de dados. Essa métrica está em desenvolvimento. |
| O número de cliques ou toques na mensagem de marketing que levaram a destinos especificados pelo anunciante, dentro ou fora das tecnologias da Meta. Essa métrica não inclui mensagens enviadas para a Europa, Argentina, Turquia, Coreia do Sul e Japão. Essa métrica está em desenvolvimento. |
| A porcentagem de mensagens entregues que receberam um clique no link entre o número total de mensagens entregues. Essa métrica não inclui mensagens enviadas para a Europa, Argentina, Turquia, Coreia do Sul e Japão. Essa métrica está em desenvolvimento. |
| O número de mensagens lidas dividido pelo número de mensagens entregues. Algumas mensagens lidas podem não ser capturadas (por exemplo, quando um cliente desativa as confirmações de leitura). Essa métrica não inclui mensagens enviadas para a Europa e o Japão. Essa métrica está em desenvolvimento. |
| O valor total que você usou na sua campanha, conjunto ou mensagem durante a programação Essa métrica está em desenvolvimento. |
On success, your app receives a JSON object with the number of messages delivered, the read rate, and the start and stop date of the messaging campaign.
Example response
{
"data": [
{
"marketing_messages_delivered": "2755",
"marketing_messages_link_btn_click": "268",
"marketing_messages_spend": "38.87",
"marketing_messages_read_rate": "79.419238",
"marketing_messages_link_btn_click_rate": "9.727768",
"marketing_messages_cost_per_link_btn_click": "0.145037",
"marketing_messages_delivery_rate": "0",
"marketing_messages_cost_per_delivered": "0.014109",
"date_start": "2024-05-01",
"date_stop": "2025-07-29"
}
],
"paging": {
"cursors": {
"before": "MAZDZD",
"after": "MAZDZD"
}
}
}
Additionally, insights under an ad account can be obtained by act_<AD_ACCOUNT_ID>/insights endpoint
Querying on time ranges and date presets is also supported for campaigns created March 1st or later. Below are query parameter options you can use to query on specific dates:
| Parameter Name | Description |
|---|---|
{'since':YYYY-MM-DD,'until':YYYY-MM-DD} | A single |
enum{today, yesterday, this_month, last_month, this_quarter, maximum, data_maximum, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, last_week_mon_sun, last_week_sun_sat, last_quarter, last_year, this_week_mon_today, this_week_sun_today, this_year} | Default value: Represents a relative time range. This field is ignored if time_range is specified. |
Next Steps
Now that you have learned how to get insights on your campaign, learn how to increase a business' subscribers.