Starting December 1, 2025, the maximum lookback window for messaging, conversation, and pricing analytics is changing from 10 years to 1 year. The lookback window for template and template group analytics will be unaffected and will continue to be 90 days.
Analytics
This document describes how to get messaging, conversation, and template analytics, such as the number of messages sent from a business phone number, the number of conversations and their costs for a WhatsApp Business Account (WABA), or the number of times a given template has been read.
Only metrics for business phone numbers and templates associated with your WABA at the time of the request will be included in responses.
Get data
Use the GET /<WHATSAPP_BUSINESS_ACCOUNT_ID> endpoint to get analytics.
Request syntax
curl -g 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=<FIELD>.<FILTERS>' \ -H 'Authorization: Bearer <ACCESS_TOKEN>'
Request parameters
| Placeholder | Description | Example Value |
|---|---|---|
| Required. Metric. Value can be one of: |
|
| Required. Metric filtering parameter. Append additional filtering parameters using dots. For possible values, see: |
|
Messaging analytics
The analytics field provides the number and type of messages sent and delivered by the phone numbers associated with a specific WABA — for conversation metrics, see Conversation Analytics. When calling /<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=analytics.{filtering-parameters}, you can attach the following parameters.
Messaging analytics parameters
| Name | Description |
|---|---|
type: UNIX Timestamp | Required. The start date for the date range for which you are retrieving analytics. |
type: UNIX Timestamp | Required. The end date for the date range for which you are retrieving analytics. |
type: String | Required. The granularity at which you would like to retrieve the analytics. Supported Options:
|
type: Array | Optional. An array of phone numbers for which you would like to retrieve analytics. If not provided, all phone numbers added to your WABA are included. |
type: Array | Optional. The types of messages (notification messages and/or customer support messages) for which you want to retrieve notifications. Provide an array and include |
type: Array | Optional. The countries for which you would like to retrieve analytics. Provide an array with 2 letter country codes for the countries you would like to include. If not provided, analytics will be returned for all countries you have communicated with. |
Example
Scenario: You need to get the number of messages sent and delivered by all phone numbers associated with your WABA.
Suggested Solution: Assemble the URL you want to call and include the following filtering parameters: start, end, granularity. Then, make a GET request to that URL:
curl -i -X GET "https://graph.facebook.com/v24.0/102290129340398
?fields=analytics
.start(1543543200)
.end(1544148000)
.granularity(DAY)
&access_token=BLI8lkj..."A successful response returns an analytics object with the data you have requested:
{
"analytics": {
"phone_numbers": [
"16505550111",
"16505550112",
"16505550113"
],
"country_codes": [
"US",
"BR"
],
"granularity": "DAY",
"data_points": [
{
"start": 1543543200,
"end": 1543629600,
"sent": 196093,
"delivered": 179715
},
{
"start": 1543629600,
"end": 1543716000,
"sent": 147649,
"delivered": 139032
},
{
"start": 1543716000,
"end": 1543802400,
"sent": 61988,
"delivered": 58830
},
{
"start": 1543802400,
"end": 1543888800,
"sent": 132465,
"delivered": 124392
}
# more data points
]
},
"id": "102290129340398"
}
Conversation analytics
The conversation_analytics field provides cost and conversation information for a specific WABA. When calling /<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=conversation_analytics.{filtering-parameters}, you can attach the following parameters.
Conversation analytics parameters
| Name | Description (Click the arrow in the left column for supported options.) |
|---|---|
type: UNIX Timestamp | Required. The start date for the date range for which you are retrieving analytics. |
type: UNIX Timestamp | Required. The end date for the date range for which you are retrieving analytics. |
type: String | Required. The granularity at which you would like to retrieve the analytics. Supported Options:
|
type: Array | Optional. An array of phone numbers for which you would like to retrieve analytics. If not provided, all phone numbers added to your WABA are included. |
| Optional. List of metrics you would like to receive. If you send an empty list, we return results for all metric types. Supported Options: {#supported}
As of July 1, 2023,
If you query a time period that includes dates on or after July 1, 2023, (for example, May 1, 2023 through August 1, 2023), the response will include the above exception. There is no change for partners when querying the |
| Optional. List of conversation categories. If you send an empty list, we return results for all conversation categories. Supported Options:
|
| Optional. List of conversation types. If you send an empty list, we return results for all conversation types. Supported Options:
|
| Optional. List of conversation directions. If you send an empty list, we return results for all conversation directions. Supported Options:
|
| Optional. List of breakdowns you would like to apply to your metrics. If you send an empty list, we return results without any breakdowns. Supported Options:
|
Analytics data is approximate and may differ from what’s shown on invoices due to small variations in data processing.
Examples
Given a time range, you can get conversation and cost information associated with your WABA. If you want, you can filter and break down your results. See the code samples below for examples.
Get monthly data, using all breakdowns
Scenario: Given a month, you want to retrieve all conversation and cost information for all phone numbers associated with a WABA.
Suggested Solution: Assemble the URL you want to call and include the following filtering parameters:
start: Start of your time range. In this case, the beginning of the month you want metrics for.end: End of your time range. In this case, the end of the month you want metrics for.granularity: How granular you want your data points to be. In the example below, we useMONTHLY, so each datapoint will represent a month’s worth of data.phone_numbers: Send an empty array and we return information for all phone numbers associated with the WABA.dimensions: Set it to all available breakdowns:"CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY", and"PHONE".
In this case, you do not need to specify country_codes, metric_types, conversation_types and conversation_categories. If you don't send us anything for those fields, we return all available options. Once you set up the URL, make a GET request:
curl -i -X GET
"https://graph.facebook.com/v24.0/102290129340398
?fields=conversation_analytics
.start(1685602800).end(1688194800)
.granularity(MONTHLY)
.phone_numbers([])
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY","PHONE"])
&access_token=BLI8lkj..."
A successful response returns a conversation_analytics object with the data you have requested. In the following example, the WABA contains only one phone number.
{
"conversation_analytics": {
"data": [
{
"data_points": [
{
"start": 1685602800,
"end": 1688194800,
"conversation": 1558,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "REGULAR",
"conversation_direction": "UNKNOWN",
"conversation_category": "AUTHENTICATION",
"cost": 15.58
},
{
"start": 1685602800,
"end": 1688194800,
"conversation": 2636,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "REGULAR",
"conversation_category": "MARKETING",
"cost": 26.36
},
{
"start": 1685602800,
"end": 1688194800,
"conversation": 2238,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "REGULAR",
"conversation_category": "SERVICE",
"cost": 22.38
},
{
"start": 1685602800,
"end": 1688194800,
"conversation": 1782,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "REGULAR",
"conversation_category": "UTILITY",
"cost": 17.82
},
{
"start": 1685602800,
"end": 1688194800,
"conversation": 1568,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "FREE_TIER",
"conversation_category": "AUTHENTICATION",
"cost": 15.68
},
{
"start": 1685602800,
"end": 1688194800,
"conversation": 2716,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "FREE_TIER",
"conversation_category": "MARKETING",
"cost": 27.16
},
{
"start": 1685602800,
"end": 1688194800,
"conversation": 2180,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "FREE_TIER",
"conversation_category": "SERVICE",
"cost": 21.8
},
{
"start": 1685602800,
"end": 1688194800,
"conversation": 1465,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "FREE_TIER",
"conversation_category": "UTILITY",
"cost": 14.65
},
{
"start": 1685602800,
"end": 1688194800,
"conversation": 1433,
"phone_number": "15550458206",
"country": "US",
"conversation_type": "FREE_ENTRY_POINT",
"conversation_category": "SERVICE",
"cost": 14.33
}
]
}
]
},
"id": "102290129340398",
}
Get data for a specific phone number, using all breakdowns and half hour granularity
Scenario: Given a time range, you want to retrieve all conversation and cost information for a specific phone number associated with a WABA. In the results, you want to use all possible breakdowns. You need each data point to represent half an hour’s worth of data.
Suggested Solution: Assemble the URL you want to call and include the following filtering parameters:
start: Start of your time range.end: End of your time range.granularity: How granular you want your data points to be. In the example below, we useHALF_HOUR, so each datapoint represents half an hour’s worth of data.phone_numbers: The phone number you need information for.dimensions: Set it to all available breakdowns:CONVERSATION_CATEGORY,CONVERSATION_TYPE,COUNTRY, andPHONE.
In this case, you do not need to specify country_codes, metric_types, conversation_types, or conversation_categories. If you don’t send us anything for those fields, we return all available options. Once you set up the URL, make a GET request:
curl -i -X GET \
"https://graph.facebook.com/v24.0/102290129340398
?fields=conversation_analytics
.start(1685602800)
.end(1685689200)
.granularity(HALF_HOUR)
.phone_numbers(["19195552584"])
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY,PHONE"])
&access_token=BLI8lkj..."
A successful response returns a conversation_analytics object with the data you have requested:
{
"conversation_analytics": {
"data": [
{
"data_points": [
{
"start": 1685602800,
"end": 1685604600,
"conversation": 4,
"phone_number": "19195552584",
"country": "US",
"conversation_type": "REGULAR",
"conversation_direction": "UNKNOWN",
"conversation_category": "SERVICE",
"cost": 0.0232
},
{
"start": 1685602800,
"end": 1685604600,
"conversation": 4,
"phone_number": "19195552584",
"country": "US",
"conversation_type": "REGULAR",
"conversation_direction": "UNKNOWN",
"conversation_category": "MARKETING",
"cost": 0.0232
},
# ... more data points
]
}
]
},
"id": "102290129340398"
}Get monthly data, using conversation type breakdowns
Scenario: Given a time range, you want to retrieve all conversation and cost information for all phone numbers associated with a WABA. In the results, you want to break down by conversation type.
Suggested Solution: Assemble the URL you want to call and include the following filtering parameters:
start: Start of your time range.end: End of your time range.granularity: How granular you want your data points to be. In the example below, we useMONTHLY, so each datapoint represents half a month’s worth of data.phone_numbers: Send an empty array and we’ll return information for all phone numbers associated with the WABA.dimensions: Set it toCONVERSATION_TYPE.
In this case, you do not need to specify country_codes, metric_types, conversation_types, conversation_directions, or conversation_categories. If you don't send us anything for those fields, we return all available options. Once you set up the URL, make a GET request:
curl -i -X GET "https://graph.facebook.com/v24.0/102290129340398
?fields=conversation_analytics
.start(1643702400).end(1646121600)
.granularity(MONTHLY)
.phone_numbers([])
.dimensions([CONVERSATION_TYPE])
&access_token=BLI8lkj..."A successful response returns a conversation_analytics object with the data you have requested:
{
"data": [
{
"data_points": [
{
"start": 1643702400,
"end": 1646121600,
"conversation": 8500,
"conversation_type": "REGULAR",
"cost": 88.1010
},
{
"start": 1643702400,
"end": 1646121600,
"conversation”: 1000,
"conversation_type": "FREE_TIER",
"cost": 0.0000
}
{
"start": 1643702400,
"end": 1646121600,
"conversation”: 250,
"conversation_type": "FREE_ENTRY_POINT",
"cost": 0.0000
}
]
}
]
}Get half-hour data broken down by conversation category
Request:
curl -i -X GET "https://graph.facebook.com/v24.0/102290129340398
?fields=conversation_analytics
.start(1685527200)
.end(1685613600)
.granularity(HALF_HOUR)
.conversation_categories(["MARKETING","AUTHENTICATION"])
.dimensions(["CONVERSATION_CATEGORY"])
&access_token=BLI8lkj..."
Response:
{
"conversation_analytics": {
"data": [
{
"data_points": [
{
"start": 1685529000,
"end": 1685530800,
"conversation": 2,
"conversation_category": "AUTHENTICATION",
"cost": 0.0128
},
{
"start": 1685527200,
"end": 1685529000,
"conversation": 3,
"conversation_category": "MARKETING",
"cost": 0.0432
}
]
}
]
},
"id": "102290129340398"
}Get half-hour data broken down by conversation category and conversation type
Request:
curl -i -X GET \
"https://graph.facebook.com/v24.0/102290129340398
?fields=conversation_analytics
.start(1685527200)
.end(1685613600)
.granularity(HALF_HOUR)
.conversation_categories(["MARKETING","AUTHENTICATION"])
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE"])
&access_token=BLI8lkj..."
Response:
{
"conversation_analytics": {
"data": [
{
"data_points": [
{
"start": 1685527200,
"end": 1685529000,
"conversation": 3,
"conversation_type": "REGULAR",
"conversation_category": "MARKETING",
"cost": 0.0432
},
{
"start": 1685529000,
"end": 1685530800,
"conversation": 2,
"conversation_type": "REGULAR",
"conversation_category": "AUTHENTICATION",
"cost": 0.0128
}
]
}
]
},
"id": "102290129340398"
}Pricing analytics
The pricing_analytics field allows you to get pricing breakdowns for any messages delivered within a specified date range.
Request syntax
GET /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?fields=pricing_analytics .start(<START>) .end(<END>) .granularity(<GRANULARITY>) .phone_numbers(<PHONE_NUMBERS>) .country_codes(<COUNTRY_CODES>) .metric_types(<METRIC_TYPES>) .pricing_types(<PRICING_TYPES>) .pricing_categories(<PRICING_CATEGORIES>) .dimensions(<DIMENSIONS>)
Pricing analytics parameters
| Filter | Description | Example Value |
|---|---|---|
Array of strings | Optional. The countries for which you would like to retrieve analytics. Provide an array with 2 letter country codes for the countries you would like to include. If not provided, analytics will be returned for all countries you have communicated with. | [
US,
BR
] |
Array of strings | Optional. List of breakdowns you would like to apply to your metrics. If you send an empty list, we return results without any breakdowns. Values can be:
| [
PRICING_CATEGORY,
PRICING_TYPE,
COUNTRY
] |
UNIX timestamp | Required. UNIX timestamp indicating the end date for the date range you are retrieving analytics for. |
|
String | Required. The granularity at which you would like to retrieve the analytics. Value can be one of:
|
|
Array of strings | Optional. Array of metrics you would like to receive. If you send an empty array, we return results for all metric types. Values can be:
|
|
Array of strings | Optional. An array of phone numbers for which you would like to retrieve analytics. If not provided, data for all business phone numbers associated with your WABA are included. |
|
Array of strings | Optional. Array of pricing categories. If you send an empty array, we return results for all pricing categories. Values can be:
|
|
Array of strings | Optional. Array of pricing types. If you send an empty array, we return results for all pricing types. Values can be:
|
|
UNIX timestamp | Required. UNIX timestamp indicating the start date for the date range you are retrieving analytics for. |
|
String | Required. WhatsApp Business Account ID. |
|
Volume tier information
Include the TIER, PRICING_CATEGORY, and COUNTRY parameters in the dimensions array to get volume tier information. Data points representing messages affected by volume tier pricing will have a tier property in the response.
Example response syntax with tier information
{
"start": <START_TIMESTAMP>,
"end": <END_TIMESTAMP>,
"phone_number": "<BUSINESS_PHONE_NUMBER>",
"country": "<COUNTRY_CODE>",
"tier": "<LOWER>:<UPPER>",
"pricing_type": "<PRICING_TYPE>",
"pricing_category": "<PRICING_CATEGORY>",
"volume": <VOLUME>,
"cost": <COST>
}The tier property value represents a concatenation of the lower and upper bounds for the tier specific to the market–category pair (country and pricing_category) that that data point represents.
<LOWER>– An integer representing the lower bound of the tier (inclusive).<UPPER>– An integer representing the upper bound of the tier (inclusive), or the stringMAX.
Notes
- To determine your current volume tier, read the
tier,country, andpricing_categoryvalues. Thetiervalue's<UPPER>integer (the integer after the colon) tells you your current tier for thecountryandpricing_category(for example, (India and utility, respectively). - To determine how many messages you need to send to reach the next tier for a given
countryandpricing_category, subtract thevolumeinteger from the tier value's<UPPER>integer. - Volume tiers will only be available for utility and authentication template messages. For marketing template messages (where volume tiers will not apply), tier will be set to
0:MAX. - The
tierproperty will be omitted for data points that represent free messages, since free messages don't contribute to tiering counts. - Volume tiers will be determined solely by Meta. All insights data is approximate due to small variations in data processing. Undue reliance should not be placed on insights data.
Example request
curl 'https://graph.facebook.com/v24.0/161311403722088?fields=pricing_analytics.start(1748761200).end(1749687703).granularity(DAILY).dimensions(PRICING_CATEGORY,PRICING_TYPE,TIER,COUNTRY).country_codes(US,IN)' \
-H 'Authorization: Bearer EAAJB'
Example response
{
"pricing_analytics": {
"data": [
{
"data_points": [
{
"start": 1749193200,
"end": 1749279600,
"country": "IN",
"pricing_type": "FREE_CUSTOMER_SERVICE",
"pricing_category": "SERVICE",
"volume": 2,
"cost": 0
},
{
"start": 1749106800,
"end": 1749193200,
"country": "IN",
"tier": "0:750000",
"pricing_type": "REGULAR",
"pricing_category": "AUTHENTICATION_INTERNATIONAL",
"volume": 2,
"cost": 4.6
},
{
"start": 1749106800,
"end": 1749193200,
"country": "IN",
"pricing_type": "FREE_CUSTOMER_SERVICE",
"pricing_category": "SERVICE",
"volume": 2,
"cost": 0
},
{
"start": 1748934000,
"end": 1749020400,
"country": "US",
"tier": "0:MAX",
"pricing_type": "REGULAR",
"pricing_category": "MARKETING",
"volume": 1,
"cost": 10
},
{
"start": 1748847600,
"end": 1748934000,
"country": "US",
"pricing_type": "FREE_CUSTOMER_SERVICE",
"pricing_category": "SERVICE",
"volume": 1,
"cost": 0
},
{
"start": 1748847600,
"end": 1748934000,
"country": "US",
"pricing_type": "FREE_ENTRY_POINT",
"pricing_category": "SERVICE",
"volume": 6,
"cost": 0
},
{
"start": 1748847600,
"end": 1748934000,
"country": "US",
"tier": "0:2",
"pricing_type": "REGULAR",
"pricing_category": "AUTHENTICATION",
"volume": 1,
"cost": 10
},
{
"start": 1748847600,
"end": 1748934000,
"country": "IN",
"tier": "0:750000",
"pricing_type": "REGULAR",
"pricing_category": "AUTHENTICATION_INTERNATIONAL",
"volume": 1,
"cost": 2.3
},
{
"start": 1748761200,
"end": 1748847600,
"country": "US",
"pricing_type": "FREE_CUSTOMER_SERVICE",
"pricing_category": "SERVICE",
"volume": 2,
"cost": 0
},
{
"start": 1748761200,
"end": 1748847600,
"country": "US",
"tier": "0:2",
"pricing_type": "REGULAR",
"pricing_category": "AUTHENTICATION",
"volume": 1,
"cost": 10
},
{
"start": 1748761200,
"end": 1748847600,
"country": "US",
"pricing_type": "FREE_CUSTOMER_SERVICE",
"pricing_category": "UTILITY",
"volume": 1,
"cost": 0
},
{
"start": 1748761200,
"end": 1748847600,
"country": "US",
"tier": "0:2",
"pricing_type": "REGULAR",
"pricing_category": "UTILITY",
"volume": 1,
"cost": 10
},
{
"start": 1748761200,
"end": 1748847600,
"country": "US",
"tier": "0:MAX",
"pricing_type": "REGULAR",
"pricing_category": "MARKETING",
"volume": 4,
"cost": 40
},
{
"start": 1748761200,
"end": 1748847600,
"country": "US",
"tier": "0:MAX",
"pricing_type": "REGULAR",
"pricing_category": "MARKETING_LITE",
"volume": 1,
"cost": 10
}
]
}
]
}
}
Template analytics
Template analytics describe the number of times a template has been sent, delivered, and read, and the number of times URL buttons or Quick Reply buttons in the template have been clicked. Additionally, onboarded MM Lite businesses can track offsite conversion metrics.
Data is returned with a daily granularity in the default timezone of UTC and WABA's timezone, with a lookback window of up to 90 days. To show data in the WABA’s configured timezone, pass in the use_waba_timezone param with a value of true.
Display data in the WABA’s configured timezone by passing in the use_waba_timezone param with a value of true.
{
"data": [
{
"waba_timezone": "America/Los_Angeles",
"granularity": "DAILY",
"product_type": "cloud_api",
"data_points": [
...
]
}
}
Limitations
- Template Analytics are only available for On-Premises API if the account has not opted into Cloud API template analytics.
- Button click analytics are only available for templates categorized as
MARKETINGorUTILITY. - WABAs owned by or shared with Meta Business Accounts in the European Union, United Kingdom, or Japan, or that have a business phone number with a country calling code from any of those countries or regions, are not supported.
- Offsite conversion metrics are available exclusively for businesses onboarded to MM Lite.
- Read and click event data for WhatsApp template messages is only available for up to 7 days from the date the message is sent. After this 7-day window, the corresponding read/click counts reset to zero and no further updates are recorded for those messages.
Confirming template analytics
You must confirm template analytics on your WhatsApp Business Account before you can get template analytics. You can confirm template analytics using the WhatsApp Manager or the API.
By confirming access via the API, you direct Meta to add insights to your WhatsApp Business Account. These insights include link tracking to report website clicks. You can turn off link tracking on each message template. You also direct Meta to collect and anonymize data from your chats with customers. Meta will anonymize this data to improve services it provides you and other businesses.
To confirm via API, send the following request:
POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>?is_enabled_for_insights=true
Once confirmed, we will begin capturing template analytics for the WhatsApp Business Account. Once confirmed, template analytics cannot be disabled.
Upon success, the API will respond with your WhatsApp Business Account ID. For example:
{
"id": 102290129340398
}
Template analytics parameters
| Name | Description | Example Value |
|---|---|---|
UNIX Timestamp or date string | Required. The start time for the date range you are retrieving analytics for. Can be represented as either a unix timestamp integer or a date string in the format YYYY-MM-DD. As template analytics are being provided with a daily granularity in the UTC timezone, a start unix timestamp that does not correspond to 0:00 UTC will be adjusted back to the current day’s 00:00 UTC. If |
|
UNIX Timestamp or date string | Required. The end time for the date range you are retrieving analytics for. Can be represented as either a unix timestamp integer or a date string in the format YYYY-MM-DD. As template analytics are being provided with a daily granularity in the UTC timezone, an end unix timestamp that does not correspond to 0:00 UTC will be adjusted back to the current day’s 00:00 UTC. If |
|
Enum | Required. The granularity at which you would like to retrieve the analytics. Value must be |
|
Array of IDs | Required. An array of template IDs for which you would like to retrieve analytics for. Maximum 10. |
|
Array of enums | Optional.
The types of metrics which you want to retrieve. If omitted or an empty array, analytics for all metric types will be returned. Possible values:
|
|
Enum | Optional. The product type of the metrics you want to retrieve. If omitted, only analytics for Cloud API will be returned. Possible values:
|
|
Boolean | Optional. Whether to show metrics in the WABA’s configured timezone. If false or omitted, metrics will be shown in UTC. If true, params start and end must be in the format YYYY-MM-DD. |
|
Examples
Getting all template analytics
Scenario: Given a 1-day timeframe, get all template analytics metric types for an authentication template and a marketing template with a URL button.
Example Request:
curl -g 'https://graph.facebook.com/v24.0/109259195336416/template_analytics?start=1718064000&end=1718122745&granularity=daily&metric_types=cost%2Cclicked%2Cdelivered%2Cread%2Csent&template_ids=[1421988012088524%2C2632273056924580]' \
-H 'Authorization: Bearer EAAJB...'
Example response:
{
"data": [
{
"granularity": "DAILY",
"product_type": "cloud_api", // Only available to businesses in the Marketing Messages Lite API alpha
"data_points": [
{
"template_id": "1421988012088524",
"start": 1718064000,
"end": 1718150400,
"sent": 1,
"delivered": 1,
"read": 1,
"cost": [
{
"type": "amount_spent",
"value": 0.01
},
{
"type": "cost_per_delivered",
"value": 0.01
}
]
},
{
"template_id": "2632273056924580",
"start": 1718064000,
"end": 1718150400,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": [
{
"type": "quick_reply_button",
"button_content": "Contact Support",
"count": 108
},
{
"type": "unique_url_button",
"button_content": "Tell me more",
"count": 16
}
],
"cost": [
{
"type": "amount_spent",
"value": 0.03
},
{
"type": "cost_per_delivered",
"value": 0.03
},
{
"type": "cost_per_url_button_click",
"value": 0.03
}
]
}
]
}
],
"paging": {
"cursors": {
"before": "MAZDZD",
"after": "MjQZD"
}
}
}Cost and click metrics
Cost metrics are returned as an array of cost objects, each with a type and value. Types can be:
amount_spent— Total amount spent on conversations opened within thestartandendtimeframe as a result of sending the template. See Opening Conversations.cost_per_delivered— Theamount_spentvalue divided by the number of times the template was delivered within thestartandendtimeframe.cost_per_url_button_click— Theamount_spentvalue divided by the number of times the template's URL button was clicked, within thestartandendtimeframe. Quick reply button clicks are not included. Object omitted if the template does not have a URL button.
Click metrics are returned as an array of JSON objects each with a type and value. Clicks are only returned for URL buttons and quick-reply buttons in templates categorized as MARKETING or UTILITY.
Types can be:
url_button— The total number of clicks on the url button.unique_url_button— Unique clicks track the number of distinct WhatsApp accounts that have clicked on a button. This metric helps you understand how many individual users are engaging with your CTAs, while eliminating duplicate clicks from the same recipient and providing an accurate measurement of engagement.
Disabling button click analytics
You can disable button click tracking on an individual template by setting its cta_url_link_tracking_opted_out field to true. Once disabled, the API will no longer return the clicked property in template analytics or display button engagement/clicks in the WhatsApp Manager when viewing the template's insights.
Request syntax
POST /<TEMPLATE_ID> ?cta_url_link_tracking_opted_out=<OPT_OUT> &category=<TEMPLATE_CATEGORY>
Request parameters
| Placeholder | Description | Example Value |
|---|---|---|
Template ID | Required. Template ID. |
|
Boolean | Required. Indicates if template button click tracking is disabled. Set to This value is set to |
|
String | Required. Template's current category. If you set the template category to a value other than its current category, the template status will be set to |
|
Example request
curl -X POST 'https://graph.facebook.com/v24.0/245435364965041?cta_url_link_tracking_opted_out=true&category=marketing' \
-H 'Authorization: Bearer EAAJB...'
Example response
Upon success, the API will respond with:
{
"success": true
}
Template group analytics
The template_group_analytics field allows you to get the number of times templates within a template group have been sent, delivered, and read, and the number of times their URL buttons or Quick Reply buttons have been clicked.
Data is returned with a daily granularity in the default timezone of UTC and WABA's timezone, with a lookback window of up to 90 days. To show data in the WABA’s configured timezone, pass in the use_waba_timezone param with a value of true.
{
"data": [
{
"waba_timezone": "America/Los_Angeles",
"granularity": "DAILY",
"product_type": "cloud_api",
"data_points": [
...
]
}
}
Limitations
Button click analytics are only available for templates categorized as marketing or utility.
WABAs owned by or shared with Meta Business Accounts in the European Union, United Kingdom, or Japan, or that have a business phone number with a country calling code from any of those countries or regions, are not supported.
Enabling template analytics
You must enable template analytics on your WhatsApp Business Account before you can get template group analytics. You can confirm template analytics enablement using the WhatsApp Manager or the API.
By confirming access via the API, you direct Meta to add insights to your WhatsApp Business Account. These insights include link tracking to report website clicks. You can turn off link tracking on each message template. You also direct Meta to collect and anonymize data from your chats with customers. Meta will anonymize this data to improve services it provides you and other businesses.
To confirm enablement via API, send the following request:
POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>?is_enabled_for_insights=true
Upon success, the API will respond with your WhatsApp Business Account ID and we will begin capturing template group analytics for the WhatsApp Business Account.
Once enabled, template analytics cannot be disabled.
Request syntax
GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>/template_group_analytics ?granularity=daily &start=<START_TIME> &end=<END_TIME> &metric_types=<METRIC_TYPES> &template_group_ids=[<TEMPLATE_GROUP_IDS>]
Request parameters
| Placeholder | Description | Example value |
|---|---|---|
| Required. WhatsApp Business Account ID. |
|
UNIX Timestamp or date string | Required. The start time for the date range you are retrieving analytics for. Can be represented as either a unix timestamp integer or a date string in the format YYYY-MM-DD. As template group analytics are being provided with a daily granularity in the UTC timezone, a start unix timestamp that does not correspond to 0:00 UTC will be adjusted back to the current day’s 00:00 UTC. If |
|
UNIX Timestamp or date string | Required. The end time for the date range you are retrieving analytics for. Can be represented as either a unix timestamp integer or a date string in the format YYYY-MM-DD. As template group analytics are being provided with a daily granularity in the UTC timezone, an end unix timestamp that does not correspond to 0:00 UTC will be adjusted back to the current day’s 00:00 UTC. If |
|
Array of strings | Optional. Array of metrics you would like to receive. If you send an empty array, the API returns results for all metric types. Values can be:
Note that See Cost and click metrics to learn more about cost and click metrics. | |
| Required. An array of template group IDs for which you wish to get template group metrics. Maximum 10 IDs. |
|
Boolean | Optional. Whether to show metrics in the WABA’s configured timezone. If false or omitted, metrics will be shown in UTC. If true, params start and end must be in the format YYYY-MM-DD. |
|
Example request
curl -g 'https://graph.facebook.com/v24.0/102290129340398/template_group_analytics?granularity=daily&start=1738465116&end=1739559516&metric_types=sent,delivered,read&template_group_ids=[1044106240855852]' \
-H 'Authorization: Bearer EAAJB...'
Example response
Note that the example below has been truncated with an ellipsis (...) for brevity.
{
"data": [
{
"granularity": "DAILY",
"data_points": [
{
"template_group_id": "1044106240855852",
"start": 1739491200,
"end": 1739577600,
"sent": 1460,
"delivered": 1460,
"read": 1399
},
{
"template_group_id": "1044106240855852",
"start": 1739404800,
"end": 1739491200,
"sent": 673,
"delivered": 673,
"read": 645
},
...
]
}
],
"paging": {
"cursors": {
"before": "MAZDZD",
"after": "MjQZD"
}
}
}
Cost and click metrics
Cost metrics are returned as an array of cost objects, each with a type and value. Types can be:
amount_spent— Total amount spent on conversations opened within thestartandendtimeframe as a result of sending the template. See Opening Conversations.cost_per_delivered— Theamount_spentvalue divided by the number of times the template was delivered within thestartandendtimeframe.cost_per_url_button_click— Theamount_spentvalue divided by the number of times the template's URL button was clicked, within thestartandendtimeframe. Quick reply button clicks are not included. Object omitted if the template does not have a URL button.
Click metrics are returned as an array of JSON objects each with a type and value. Clicks are only returned for URL buttons and quick-reply buttons in templates categorized as marketing or utility.
Types can be:
url_button— The total number of clicks on the url button.unique_url_button— Unique clicks track the number of distinct WhatsApp accounts that have clicked on a button. This metric helps you understand how many individual users are engaging with your CTAs, while eliminating duplicate clicks from the same recipient and providing an accurate measurement of engagement.
Reference
For a list of all possible values for each field, see the Graph API reference of the WhatsApp Business Account Analytics field.