Resumo por anúncio
Tráfego Click-to-WhatsApp agrupado por anúncio, com os nomes resolvidos do anúncio, do conjunto de anúncios e da campanha e a quantidade de leads do Meta Lead Ads que cada anúncio gerou (leadCount). Ordenado por conversations e depois por lastAt.
Permissão: analytics:read, que todo papel do workspace tem, ANALYST incluído — é volume, não conteúdo de conversa (compare com GET /v1/referrals/summary, que exige chat:read e cobre um número). Escopo: uma chave com escopo de número, ou uma credencial da conta inteira com x-whatsapp-number-id, reporta só aquele número; uma credencial da conta inteira sem o header reporta o workspace todo e pode restringir com o parâmetro de consulta whatsappNumberId.
conversations conta conversas distintas e messages conta mensagens, separadamente. lastHeadline e lastSourceUrl (o texto do anúncio) vêm null para um anúncio visto só em número RELAY_ONLY; as contagens não mudam. namesResolvedAt preenchido com todos os nomes null significa que a Pilot Status perguntou à Meta e não recebeu nada (peça a concessão de parceiro ao anunciante); null significa que ainda não perguntou. Limite de 200 anúncios: truncated: true avisa que a lista foi cortada — restrinja com startDate/endDate. Um anúncio que gerou leads mas nunca uma conversa não tem linha aqui; consulte-o em GET /v1/leads.
curl --request GET \
--url https://pilotstatus.com.br/v1/ads/summary \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/ads/summary"
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/ads/summary', 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/ads/summary",
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/ads/summary"
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/ads/summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/ads/summary")
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{
"ads": [
{
"sourceId": "120249828053880703",
"sourceType": "ad",
"conversations": 37,
"messages": 214,
"firstAt": "2026-10-02T11:04:19.000Z",
"lastAt": "2026-10-20T22:41:07.000Z",
"lastSourceUrl": "https://fb.me/2bXyZ",
"lastHeadline": "Reforma com 70% de desconto",
"adName": "Ads 01 - Vídeo dos 70%",
"adsetId": "120249828053880001",
"adsetName": "[IG] [LL1% IG + VÍDEOS] - 35 a 50",
"campaignId": "120249828053870000",
"campaignName": "[CD-01] [LEADS] - MM Design - Sale 70%",
"namesResolvedAt": "2026-10-20T23:00:02.000Z",
"leadCount": 12
}
],
"total": 1,
"limit": 200,
"truncated": false
}{
"error": "startDate must be before or equal to endDate | Intervalo de datas inválido (use ISO 8601, startDate <= endDate)",
"code": "INVALID_DATE_RANGE"
}{
"error": "Unauthorized"
}{
"error": "This credential is not granted access to that WhatsApp number | Esta credencial não tem acesso a esse número de WhatsApp",
"code": "NUMBER_NOT_IN_GRANT"
}{
"error": "Internal server error | Erro interno do servidor",
"code": "INTERNAL_ERROR"
}Autorizações
Sua chave de API ps_
Cabeçalhos
Restringe uma credencial da conta inteira a um número (o id dele ou o id da instância, de GET /v1/numbers). Sem ele, uma credencial da conta inteira vê o workspace todo; uma chave com escopo de número vê sempre só o próprio número.
Parâmetros de consulta
Restringe a um número dentro do escopo da credencial (senão, 403 NUMBER_NOT_IN_GRANT).
Início do intervalo (ISO 8601), sobre o horário da mensagem — e a data de criação do lead na Meta para leadCount. Deve ser ≤ endDate.
Fim do intervalo (ISO 8601), inclusive.
Resposta
Resumo por anúncio
Esta página foi útil?
curl --request GET \
--url https://pilotstatus.com.br/v1/ads/summary \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/ads/summary"
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/ads/summary', 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/ads/summary",
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/ads/summary"
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/ads/summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/ads/summary")
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{
"ads": [
{
"sourceId": "120249828053880703",
"sourceType": "ad",
"conversations": 37,
"messages": 214,
"firstAt": "2026-10-02T11:04:19.000Z",
"lastAt": "2026-10-20T22:41:07.000Z",
"lastSourceUrl": "https://fb.me/2bXyZ",
"lastHeadline": "Reforma com 70% de desconto",
"adName": "Ads 01 - Vídeo dos 70%",
"adsetId": "120249828053880001",
"adsetName": "[IG] [LL1% IG + VÍDEOS] - 35 a 50",
"campaignId": "120249828053870000",
"campaignName": "[CD-01] [LEADS] - MM Design - Sale 70%",
"namesResolvedAt": "2026-10-20T23:00:02.000Z",
"leadCount": 12
}
],
"total": 1,
"limit": 200,
"truncated": false
}{
"error": "startDate must be before or equal to endDate | Intervalo de datas inválido (use ISO 8601, startDate <= endDate)",
"code": "INVALID_DATE_RANGE"
}{
"error": "Unauthorized"
}{
"error": "This credential is not granted access to that WhatsApp number | Esta credencial não tem acesso a esse número de WhatsApp",
"code": "NUMBER_NOT_IN_GRANT"
}{
"error": "Internal server error | Erro interno do servidor",
"code": "INTERNAL_ERROR"
}