v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
WhatsApp Analytics

Fetch Template Analytics API

Call this endpoint to retrieve analytics metrics for one or more WhatsApp templates. Pass template identifiers and a valid date range to receive time-bucketed performance data, including delivery, read, click, cost, and conversion metrics.

get/v3/metainfo/template/analytics

Query parameters

template_idstring required

Enter one or more WhatsApp template IDs separated by commas. You can pass up to 10 template IDs in a single request. Use this when you want analytics grouped by Meta template ID.

nc_template_idstring

Enter a single Netcore template ID. Pass only one value. Do not combine with multiple IDs. Use this when you want analytics using Netcore’s internal template reference.

date_startstring required

Provide the start date for the analytics range. Use YYYY-MM-DD format. Metrics are included from this date onward.

date_endstring required

Provide the end date for the analytics range. Use YYYY-MM-DD format. Ensure this date is the same as or later than date_start.

granularitystring

Set the time grouping level for the results (for example DAILY). Use this if you want metrics split into time buckets. If you skip this parameter, the default aggregation is applied.

limitinteger

Set how many records to return in this response page. Use this together with cursors to paginate through large datasets. If not set, the system default limit is used.

use_waba_timezoneboolean

Set this to true to calculate metrics using your WABA timezone. Set to false or omit to use the system default timezone.

product_type'CLOUD_API' | 'cloud_api' | 'MARKETING_MESSAGES_LITE_API' | 'marketing_messages_lite_api'

Pass the product type to filter analytics by template channel. Use cloud_api for utility templates. Use MARKETING_MESSAGES_LITE_API for marketing templates on MMLite. Skip this parameter to get combined metrics across product types.

afterstring

Pass the “after” cursor value from the previous response to fetch the next page of results.

beforestring

Pass the “before” cursor value from the previous response to fetch the previous page of results.

metric_typesstring

Provide a comma-separated list of metric names to return. Use this to limit the response to specific conversion metrics. Skip this parameter to return all supported metrics.

Response

Template analytics fetched successfully

request_idstring

Capture this request ID when contacting support for this API call.

statusstring

Check this field to confirm whether the request succeeded or failed.

messagestring

Read this message for a short summary of the API result.