---
title: "Fetch Template Analytics API"
method: GET
path: "/v3/metainfo/template/analytics"
tags: ["WhatsApp Analytics"]
---

# Fetch Template Analytics API

`GET /v3/metainfo/template/analytics`

## Request

- Base URL: `https://cpaaswa.netcorecloud.net/api`
- URL: `https://cpaaswa.netcorecloud.net/api/v3/metainfo/template/analytics`
- Auth: HTTP bearer

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.

## Query parameters

- `template_id` string, required
- `nc_template_id` string
- `date_start` string, required
- `date_end` string, required
- `granularity` string
- `limit` integer
- `use_waba_timezone` boolean
- `product_type` 'CLOUD_API' | 'cloud_api' | 'MARKETING_MESSAGES_LITE_API' | 'marketing_messages_lite_api'
- `after` string
- `before` string
- `metric_types` string

## Response `200`

Template analytics fetched successfully

- object
  - `request_id` string: Capture this request ID when contacting support for this API call.
  - `status` string: Check this field to confirm whether the request succeeded or failed.
  - `message` string: Read this message for a short summary of the API result.
  - `data` object[]: Review this array to access analytics grouped by granularity and product type.
    - `granularity` string: Shows the time aggregation level applied to these metrics.
    - `product_type` string: Identifies which product type these metrics belong to.
    - `waba_timezone` string: Shows the timezone used to compute the time buckets.
    - `data_points` object[]: Iterate through each object to read metrics for a time window.
      - `app_activations` integer: Read how many app activation events were attributed to template clicks.
      - `app_add_to_cart` integer: Read how many app add-to-cart events came from template clicks.
      - `app_checkouts_initiated` integer: Read how many app checkout starts came from template clicks.
      - `app_purchases` integer: Read how many completed app purchases were attributed to template clicks.
      - `app_purchases_conversion_value` integer: Read the total purchase value from app conversions.
      - `clicked` object[]: Check button-level click counts grouped by button text and type.
        - `button_content` string: Read the exact button label shown to users.
        - `count` integer: Read how many times this button was clicked.
        - `type` string: Identify the button type used in the template.
      - `cost` object[]: Review cost metrics related to sends and clicks.
        - `type` string: Identify the cost metric name.
        - `value` number: Read the numeric value for this cost metric.
      - `delivered` integer: Read how many messages were successfully delivered.
      - `end` integer: Convert this Unix timestamp to get the bucket end time.
      - `read` integer: Read how many delivered messages were opened.
      - `sent` integer: Read how many messages were sent for delivery.
      - `start` integer: Convert this Unix timestamp to get the bucket start time.
      - `template_id` string: Match metrics to this WhatsApp template ID.
      - `web_add_to_cart` integer: Read how many website add-to-cart events came from template clicks.
      - `web_checkouts_initiated` integer: Read how many website checkout starts came from template clicks.
      - `web_purchases` integer: Read how many completed website purchases were attributed to template clicks.
      - `web_purchases_conversion_value` integer: Read the total purchase value from website conversions.
  - `paging` object: Use these cursor values to navigate between pages.
    - `cursors` object: Copy these cursor tokens into your next request.
      - `before` string: Pass this cursor in the before parameter to load the previous page.
      - `after` string: Pass this cursor in the after parameter to load the next page.

---

[API](https://skmtc.dev/netcorecloud/apis/whatsapp-api.md) - [All operations](https://skmtc.dev/netcorecloud/apis/whatsapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/netcorecloud/apis/whatsapp-api/revisions/82cdf689fb7a?raw)