Obter insights do template
Retorna os números de entrega e engajamento da Meta para um template nos últimos days dias (7, 30 ou 90; padrão 30): totais de enviadas, entregues e lidas, readRate (lidas / entregues, null quando nada foi entregue), cliques em botões e uma série diária.
Os dados vêm das análises de templates da Meta: granularidade diária, só os últimos 90 dias, e os dias mais recentes ainda podem estar sendo preenchidos. A primeira chamada para uma conta do WhatsApp Business pode ativar os insights de templates nessa conta, na Meta.
Só templates enviados à Meta têm insights (caso contrário, 409 TEMPLATE_NOT_ON_META). A Meta não fornece insights de templates para números do app WhatsApp Business / coexistência (422 TEMPLATE_INSIGHTS_UNAVAILABLE_SMB). Mesmo acesso do GET /v1/templates/{id}: permissão templates:read; uma chave com escopo de número só vê templates dos seus números.
Requer uma chave com escopo de número.
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
}
]
}Autorizações
Sua chave de API ps_
Parâmetros de caminho
Id ou nome do template.
Parâmetros de consulta
Janela em dias: 7, 30 ou 90. Padrão 30. Qualquer outro valor retorna 400 INVALID_DAYS.
7, 30, 90 Resposta
Insights do template
Id do template.
Nome, status, categoria, idioma e nota de qualidade da Meta do template.
Show child attributes
Show child attributes
A janela usada.
7, 30, 90 Somas na janela.
Show child attributes
Show child attributes
read / delivered, de 0 a 1. null quando delivered é 0.
Cliques em botões na janela, uma entrada por botão.
Show child attributes
Show child attributes
Uma entrada por dia da janela, do mais antigo ao mais recente.
Show child attributes
Show child attributes
Esta página foi útil?
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
}
]
}