{
"wabaId": "<string>",
"officialTemplateId": "<string>",
"templateName": "<string>",
"language": "<string>",
"timezone": "<string>",
"analyticsStatus": "ENABLED",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"dataPoints": [
{
"date": "2023-12-25",
"sent": 123,
"delivered": 123,
"failed": 123,
"read": 123,
"clicks": 123,
"uniqueReplies": 123,
"buttonClicks": [
{
"type": "<string>",
"buttonContent": "<string>",
"count": 123
}
]
}
]
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
},
"messengerApiError": {
"code": "100",
"subcode": "2018276"
}
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
},
"messengerApiError": {
"code": "100",
"subcode": "2018276"
}
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
},
"messengerApiError": {
"code": "100",
"subcode": "2018276"
}
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
},
"messengerApiError": {
"code": "100",
"subcode": "2018276"
}
}
}Retrieve WhatsApp template analytics
Returns daily YCloud message metrics and, when available, Meta Template Insights
for one WhatsApp template. Authenticate with X-API-Key.
analyticsStatus describes Meta Template Insights only; it does not describe YCloud metrics.
Dates are interpreted in the WABA timezone, both boundaries are inclusive, and the range
must contain between 1 and 90 calendar days.
The selected template must currently exist under the requested WABA. REST resolves and
validates the template before querying any statistics. A missing template returns 404,
a template that belongs to another WABA returns 403, and a template lookup failure returns
500; none of these errors returns partial statistics.
{
"wabaId": "<string>",
"officialTemplateId": "<string>",
"templateName": "<string>",
"language": "<string>",
"timezone": "<string>",
"analyticsStatus": "ENABLED",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"dataPoints": [
{
"date": "2023-12-25",
"sent": 123,
"delivered": 123,
"failed": 123,
"read": 123,
"clicks": 123,
"uniqueReplies": 123,
"buttonClicks": [
{
"type": "<string>",
"buttonContent": "<string>",
"count": 123
}
]
}
]
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
},
"messengerApiError": {
"code": "100",
"subcode": "2018276"
}
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
},
"messengerApiError": {
"code": "100",
"subcode": "2018276"
}
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
},
"messengerApiError": {
"code": "100",
"subcode": "2018276"
}
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
},
"messengerApiError": {
"code": "100",
"subcode": "2018276"
}
}
}Authorizations
Body
Specify exactly one template selector: either officialTemplateId alone, or templateName together with language. officialTemplateId cannot be combined with templateName or language.
"102012345678901"
Inclusive start date interpreted in the WABA timezone.
"2026-07-01"
Inclusive end date interpreted in the WABA timezone. The inclusive range must not exceed 90 calendar days.
"2026-07-07"
Official WhatsApp/Meta template ID exposed by the existing template REST APIs.
"875432109876543"
Exact template name. Must be provided together with language when officialTemplateId is absent.
"order_update"
Template language code. Must be provided together with templateName when officialTemplateId is absent.
"en_US"
Response
Successfully retrieved template analytics.
WhatsApp Business Account ID.
Resolved official WhatsApp/Meta template ID. Successful queries resolve a current template; the property remains nullable for contract compatibility.
Template name used for the statistics query.
Template language used for the statistics query.
IANA timezone resolved from the WABA configuration and used to interpret the date range.
Meta Template Insights status only; it does not describe YCloud message metrics. NO_DATA means the Meta query completed without data for the requested date range. ERROR indicates that Template Insights are unavailable because of an error after the current template was successfully resolved and validated.
ENABLED, NOT_ENABLED, UNSUPPORTED_REGION, PERMISSION_DENIED, NO_DATA, ERROR Inclusive start date from the request.
Inclusive end date from the request.
One item for every date in the requested range, ordered by date ascending. Missing metrics are returned as zero and missing button details as an empty array.
Show child attributes
Show child attributes