API Reference
Help Center

Retrieve WhatsApp template analytics

post
https://api.ycloud.com/v2/whatsapp/templates/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specify exactly one template selector: either officialTemplateId alone, or templateName together
with language. officialTemplateId cannot be combined with templateName or language.

string
required
string | null

Official WhatsApp/Meta template ID exposed by the existing template REST APIs.

string | null

Exact template name. Must be provided together with language when officialTemplateId is absent.

string | null

Template language code. Must be provided together with templateName when officialTemplateId is absent.

date
required

Inclusive start date interpreted in the WABA timezone.

date
required

Inclusive end date interpreted in the WABA timezone. The inclusive range must not exceed 90 calendar days.

Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?