Template

Get Template Metrics

Returns Meta’s template analytics for up to 10 templates of a single application: an overall summary, a per-template summary, and a daily series.

Gap-filled buckets. Days Meta returns no data for are emitted as zero points, so the series is always continuous across the requested range.

Pending days. Zero buckets that fall after Meta’s dataAvailableUntil watermark are flagged isPending: true, telling you the day is not yet aggregated rather than genuinely empty.

Derived rates. deliveredRate, readRate, clickRate, and costPerDelivered are computed for you — rates to 4 decimals, amountSpent to 6. Rates are always recomputed from the totals, never averaged from the buckets.

Invariants. Σ series[].sent == summary.sent for each template, and the same holds for delivered, read, clicked, and amountSpent. The top-level summary is the sum of every template summary.

Limits. At most 10 templateId values and at most a 90-day range per request; split larger reports into several calls.

This endpoint is per-application and per-template. For organization-wide message volume, use Get Messages instead.

Note that this path is matched before /wa/{app_id}/templates/{source_id}, so metrics is never treated as a template ID.

GET

{app_id}

templates

metrics

Get Template Metrics

curl --request GET \
  --url https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "granularity": "DAILY",
    "productType": "CLOUD_API",
    "periodStart": "2026-07-14T00:00:00+00:00",
    "periodEnd": "2026-08-13T23:59:59+00:00",
    "dataAvailableUntil": "2026-08-13T00:00:00+00:00",
    "usesWabaTimezone": false,
    "summary": {
      "sent": 1200,
      "delivered": 1140,
      "read": 860,
      "clicked": 210,
      "deliveredRate": 0.95,
      "readRate": 0.7544,
      "clickRate": 0.1842,
      "amountSpent": 18.42,
      "costPerDelivered": 0.0162,
      "clicksBreakdown": [
        {
          "type": "url_button",
          "buttonContent": "Track Order",
          "count": 210
        }
      ],
      "costBreakdown": [
        {
          "type": "amount_spent",
          "value": 18.42
        },
        {
          "type": "cost_per_delivered",
          "value": 0.0162
        }
      ]
    },
    "templates": [
      {
        "templateId": "842802041844912",
        "summary": {
          "sent": 1200,
          "delivered": 1140,
          "read": 860,
          "clicked": 210,
          "deliveredRate": 0.95,
          "readRate": 0.7544,
          "clickRate": 0.1842,
          "amountSpent": 18.42,
          "costPerDelivered": 0.0162,
          "clicksBreakdown": [],
          "costBreakdown": []
        },
        "series": [
          {
            "periodStart": "2026-08-12T00:00:00+00:00",
            "periodEnd": "2026-08-13T00:00:00+00:00",
            "sent": 400,
            "delivered": 380,
            "read": 290,
            "clicked": 70,
            "deliveredRate": 0.95,
            "readRate": 0.7632,
            "clickRate": 0.1842,
            "amountSpent": 6.14,
            "isPending": false,
            "clicksBreakdown": [
              {
                "type": "url_button",
                "buttonContent": "Track Order",
                "count": 70
              }
            ],
            "costBreakdown": [
              {
                "type": "amount_spent",
                "value": 6.14
              }
            ]
          }
        ]
      }
    ]
  },
  "isSuccess": true
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "errors": {
    "code": "META_103",
    "group": "CONFLICT",
    "description": "Template analytics is not enabled for this WhatsApp Business Account. Enable insights and try again."
  },
  "isSuccess": false
}

{
  "errors": {
    "code": "META_105",
    "group": "VALIDATION",
    "description": "The requested date range is too large. The maximum allowed range is 90 days."
  },
  "isSuccess": false
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

Authorizations

Authorization

string

header

required

Secret key in Bearer sk_... format. Server-to-server only — never embed it in a browser or mobile client. The organization is resolved from the key, so organization_id is never passed explicitly.

Path Parameters

app_id

string

required

Application ID. Must belong to the organization resolved from your secret key, otherwise the request returns 404 with APPLICATION_004.

Example:

"app_7poyXj8GXuv76e"

Query Parameters

templateId

string[]

required

Repeatable: ?templateId=a&templateId=b. Between 1 and 10 IDs per request. Blank values are discarded and duplicates collapsed before the request reaches Meta; more than 10 distinct IDs returns 422 with META_104.

Required array length: 1 - 10 elements

startDate

string<date-time>

ISO-8601 datetime. Start of the range. Defaults to 30 days before today 00:00:00 UTC.

endDate

string<date-time>

ISO-8601 datetime. End of the range; must be greater than startDate, and the total span cannot exceed 90 days. Defaults to today 23:59:59 UTC.

granularity

enum<string>

default:DAILY

Bucket size of the series. DAILY is the only value Meta exposes for template analytics, so this is effectively fixed.

Available options:

DAILY

metricType

enum<string>[]

Repeatable. Omit for the full core set (SENT, DELIVERED, READ, CLICKED, COST). Conversion metrics can be requested explicitly and are surfaced per bucket under additionalMetrics.

Available options:

SENT,

DELIVERED,

READ,

CLICKED,

COST,

APP_ACTIVATIONS,

APP_ADD_TO_CART,

APP_CHECKOUTS_INITIATED,

APP_PURCHASES,

APP_PURCHASES_CONVERSION_VALUE,

WEBSITE_ADD_TO_CART,

WEBSITE_CHECKOUTS_INITIATED,

WEBSITE_PURCHASES,

WEBSITE_PURCHASES_CONVERSION_VALUE

productType

enum<string>

Restricts the result to one messaging product. Omit for all products.

Available options:

CLOUD_API,

MARKETING_MESSAGES_LITE_API

useWabaTimezone

boolean

default:false

When true, Meta buckets the days in the WABA's own timezone instead of UTC. The applied choice is echoed back as usesWabaTimezone.

Response

Range metadata, an overall summary, and one entry per requested template — in the order you sent them. A template with no data is still returned, with a zeroed summary and a fully gap-filled series.

data

object

Show child attributes

isSuccess

enum<boolean>

Available options:

true

Get Template Metrics

curl --request GET \
  --url https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/templates/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "granularity": "DAILY",
    "productType": "CLOUD_API",
    "periodStart": "2026-07-14T00:00:00+00:00",
    "periodEnd": "2026-08-13T23:59:59+00:00",
    "dataAvailableUntil": "2026-08-13T00:00:00+00:00",
    "usesWabaTimezone": false,
    "summary": {
      "sent": 1200,
      "delivered": 1140,
      "read": 860,
      "clicked": 210,
      "deliveredRate": 0.95,
      "readRate": 0.7544,
      "clickRate": 0.1842,
      "amountSpent": 18.42,
      "costPerDelivered": 0.0162,
      "clicksBreakdown": [
        {
          "type": "url_button",
          "buttonContent": "Track Order",
          "count": 210
        }
      ],
      "costBreakdown": [
        {
          "type": "amount_spent",
          "value": 18.42
        },
        {
          "type": "cost_per_delivered",
          "value": 0.0162
        }
      ]
    },
    "templates": [
      {
        "templateId": "842802041844912",
        "summary": {
          "sent": 1200,
          "delivered": 1140,
          "read": 860,
          "clicked": 210,
          "deliveredRate": 0.95,
          "readRate": 0.7544,
          "clickRate": 0.1842,
          "amountSpent": 18.42,
          "costPerDelivered": 0.0162,
          "clicksBreakdown": [],
          "costBreakdown": []
        },
        "series": [
          {
            "periodStart": "2026-08-12T00:00:00+00:00",
            "periodEnd": "2026-08-13T00:00:00+00:00",
            "sent": 400,
            "delivered": 380,
            "read": 290,
            "clicked": 70,
            "deliveredRate": 0.95,
            "readRate": 0.7632,
            "clickRate": 0.1842,
            "amountSpent": 6.14,
            "isPending": false,
            "clicksBreakdown": [
              {
                "type": "url_button",
                "buttonContent": "Track Order",
                "count": 70
              }
            ],
            "costBreakdown": [
              {
                "type": "amount_spent",
                "value": 6.14
              }
            ]
          }
        ]
      }
    ]
  },
  "isSuccess": true
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "errors": {
    "code": "META_103",
    "group": "CONFLICT",
    "description": "Template analytics is not enabled for this WhatsApp Business Account. Enable insights and try again."
  },
  "isSuccess": false
}

{
  "errors": {
    "code": "META_105",
    "group": "VALIDATION",
    "description": "The requested date range is too large. The maximum allowed range is 90 days."
  },
  "isSuccess": false
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

Getting Started

Sandbox Public API

Analytics

Application

Template

Media

Developers

Reference

Get Template Metrics

Authorizations

Path Parameters

Query Parameters

Response