Estatísticas da Instância
curl --request GET \
--url https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats', 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://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats",
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://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats"
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))
}HttpResponse<String> response = Unirest.get("https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats")
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_bodyAnalytics
Estatísticas da Instância
Métricas agregadas de mensagens e conversas sincronizadas da Meta, com séries temporais e breakdown por status.
GET
/
analytics
/
instances
/
{instanceId}
/
stats
Estatísticas da Instância
curl --request GET \
--url https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats', 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://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats",
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://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats"
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))
}HttpResponse<String> response = Unirest.get("https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats")
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_bodyParâmetros
string
required
ID da instância.
string
Data de início (ISO 8601 ou
YYYY-MM-DD). Padrão: 30 dias atrás.string
Data de fim (ISO 8601 ou
YYYY-MM-DD). Padrão: hoje.string
default:"day"
Agrupamento das séries temporais:
day, week ou month.Exemplo de Requisição
curl --request GET \
--url 'https://apis.vectalk.com.br/api/analytics/instances/{instanceId}/stats?from=2026-01-01&to=2026-01-31&groupBy=day' \
--header 'Authorization: Bearer {seu_token}'
Resposta
{
"summary": {
"totalSent": 1250,
"totalReceived": 340,
"totalDelivered": 1180,
"totalRead": 950,
"totalFailed": 15,
"deliveryRate": 94,
"readRate": 76,
"failureRate": 1,
"source": "meta"
},
"byStatus": [
{ "status": "SENT", "count": 1250 },
{ "status": "DELIVERED", "count": 230 },
{ "status": "READ", "count": 950 },
{ "status": "FAILED", "count": 15 }
],
"timeSeries": [
{
"period": "2026-01-01",
"sent": 42,
"delivered": 40,
"read": 35
}
],
"conversations": {
"total": 200,
"totalCost": 50.5,
"byCategory": [
{ "label": "MARKETING", "conversation": 80, "cost": 20.0 },
{ "label": "UTILITY", "conversation": 120, "cost": 30.5 }
],
"byType": [
{ "label": "REGULAR", "conversation": 200, "cost": 50.5 }
]
},
"channel": {
"qualityRating": "GREEN",
"verifiedName": "Minha Empresa",
"displayPhoneNumber": "+55 11 99999-9999",
"status": "ACTIVE"
}
}
Campos da Resposta
| Campo | Descrição |
|---|---|
summary.source | meta se dados vêm da Meta, local se vêm do banco local (fallback) |
summary.deliveryRate | Porcentagem de entrega (delivered + read / sent) |
summary.readRate | Porcentagem de leitura (read / sent) |
timeSeries | Série temporal agrupada por groupBy |
conversations | Dados de conversas sincronizados da Meta (últimos 90 dias) |
channel | Metadados do número (quality rating, nome verificado) |
Os dados são sincronizados da Meta diariamente. Use
POST /analytics/instances/{instanceId}/sync para forçar sincronização.⌘I