Templates
Get template insights
Returns Meta’s delivery and engagement numbers for a template over the last days days (7, 30 or 90; default 30): totals of sent, delivered and read, readRate (read / delivered, null when nothing was delivered), button clicks and a daily series.
Data comes from Meta’s template analytics: daily granularity, only the last 90 days, and the most recent days may still be filling in. The first call for a WhatsApp Business Account may enable template insights on that account at Meta.
Only templates submitted to Meta have insights (409 TEMPLATE_NOT_ON_META otherwise). Meta does not provide template insights for WhatsApp Business App / coexistence numbers (422 TEMPLATE_INSIGHTS_UNAVAILABLE_SMB). Same access as GET /v1/templates/{id}: permission templates:read; a number-scoped key only sees templates of its numbers.
Requires a number-scoped key.
GET
/
v1
/
templates
/
{id}
/
insights
Get template insights
curl --request GET \
--url https://pilotstatus.com.br/v1/templates/{id}/insights \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/templates/{id}/insights"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/templates/{id}/insights', 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://pilotstatus.com.br/v1/templates/{id}/insights",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://pilotstatus.com.br/v1/templates/{id}/insights"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/templates/{id}/insights")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/templates/{id}/insights")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"templateId": "tpl_01HZX...",
"template": {
"name": "boas_vindas",
"status": "APPROVED",
"category": "UTILITY",
"language": "pt_BR",
"qualityScore": "GREEN"
},
"days": 7,
"totals": {
"sent": 1240,
"delivered": 1198,
"read": 873
},
"readRate": 0.7287,
"clicks": [
{
"type": "quick_reply_button",
"buttonContent": "Quero saber mais",
"count": 112
},
{
"type": "url_button",
"buttonContent": "https://exemplo.com.br/oferta",
"count": 64
}
],
"daily": [
{
"date": "2026-10-22",
"sent": 180,
"delivered": 175,
"read": 130
},
{
"date": "2026-10-23",
"sent": 172,
"delivered": 166,
"read": 121
},
{
"date": "2026-10-24",
"sent": 190,
"delivered": 184,
"read": 139
},
{
"date": "2026-10-25",
"sent": 160,
"delivered": 155,
"read": 110
},
{
"date": "2026-10-26",
"sent": 178,
"delivered": 171,
"read": 124
},
{
"date": "2026-10-27",
"sent": 185,
"delivered": 180,
"read": 129
},
{
"date": "2026-10-28",
"sent": 175,
"delivered": 167,
"read": 120
}
]
}Authorizations
apiKeyapiKeyId
Your ps_ API key
Path Parameters
Template id or name.
Query Parameters
Window in days: 7, 30 or 90. Defaults to 30. Any other value returns 400 INVALID_DAYS.
Available options:
7, 30, 90 Response
Template insights
Template id.
The template's name, status, category, language and Meta quality score.
Show child attributes
Show child attributes
The window used.
Available options:
7, 30, 90 Sums over the window.
Show child attributes
Show child attributes
read / delivered, from 0 to 1. null when delivered is 0.
Button clicks over the window, one entry per button.
Show child attributes
Show child attributes
One entry per day in the window, oldest first.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get template insights
curl --request GET \
--url https://pilotstatus.com.br/v1/templates/{id}/insights \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/templates/{id}/insights"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/templates/{id}/insights', 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://pilotstatus.com.br/v1/templates/{id}/insights",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://pilotstatus.com.br/v1/templates/{id}/insights"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/templates/{id}/insights")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/templates/{id}/insights")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"templateId": "tpl_01HZX...",
"template": {
"name": "boas_vindas",
"status": "APPROVED",
"category": "UTILITY",
"language": "pt_BR",
"qualityScore": "GREEN"
},
"days": 7,
"totals": {
"sent": 1240,
"delivered": 1198,
"read": 873
},
"readRate": 0.7287,
"clicks": [
{
"type": "quick_reply_button",
"buttonContent": "Quero saber mais",
"count": 112
},
{
"type": "url_button",
"buttonContent": "https://exemplo.com.br/oferta",
"count": 64
}
],
"daily": [
{
"date": "2026-10-22",
"sent": 180,
"delivered": 175,
"read": 130
},
{
"date": "2026-10-23",
"sent": 172,
"delivered": 166,
"read": 121
},
{
"date": "2026-10-24",
"sent": 190,
"delivered": 184,
"read": 139
},
{
"date": "2026-10-25",
"sent": 160,
"delivered": 155,
"read": 110
},
{
"date": "2026-10-26",
"sent": 178,
"delivered": 171,
"read": 124
},
{
"date": "2026-10-27",
"sent": 185,
"delivered": 180,
"read": 129
},
{
"date": "2026-10-28",
"sent": 175,
"delivered": 167,
"read": 120
}
]
}