OrbitSenderDocs
ReferenceParceiro

KPIs agregados do tenant

GET
/api/external/partner/statistics

Retorna KPIs agregados do tenant que autorizou o app, sem qualquer PII ou identificador (nada de nomes de canal/segmento, telefones ou JIDs). Apenas números crus e seguros. Requer o scope statistics:read.

Authorization

x-api-key<token>

Chave de API no formato sk_live_..., no header x-api-key.

In: header

Query Parameters

days?integer

Janela do período em dias (1 a 365). Valores fora do intervalo caem para 30.

Range1 <= value <= 365
Default30

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/external/partner/statistics"
{  "success": true,  "period_days": 30,  "statistics": {    "campaigns": 12,    "total_reads": 3480,    "messages_total": 5200,    "messages_sent": 5011,    "messages_failed": 189  }}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Forbidden",  "message": "Limite de canais atingido.",  "current": 5,  "max": 5}
{  "success": false,  "error": "Too Many Requests",  "code": "rate_limited",  "message": "Muitas requisições. Tente novamente em instantes."}
{  "success": false,  "error": "Internal Server Error",  "message": "Erro interno ao processar a requisição."}