GET /v1/analytics/dashboard — Analytics

Este endpoint retorna os mesmos dados exibidos no painel (KPIs e série diária), já com escopo no número da chave de API.

Endpoint

GET https://pilotstatus.com.br/v1/analytics/dashboard

Parâmetros de query

string

padrão:"30d"

Janela do relatório. Um de 7d, 30d (padrão) ou 90d.

string

Fuso horário IANA opcional, por exemplo America/Sao_Paulo. timezone é aceito como alias de tz.

Exemplo

curl "https://pilotstatus.com.br/v1/analytics/dashboard?tz=America/Sao_Paulo" \
  -H "x-api-key: ps_your_key_here"

curl "https://pilotstatus.com.br/v1/analytics/dashboard?tz=America/Sao_Paulo" \
  -H "x-api-key-id: ck_xxx"

{
  "totalSent": 120,
  "totalFailed": 3,
  "sentPercentChange": 0,
  "failedPercentChange": 0,
  "failureRate": 2.44,
  "dailyMessages": [
    { "date": "2026-02-24", "count": 10 },
    { "date": "2026-02-25", "count": 40 }
  ],
  "statusDistribution": {
    "queued": 10.0,
    "sent": 80.0,
    "failed": 2.5,
    "read": 7.5
  }
}

Erros comuns

401 — header de chave de API ausente/inválido (x-api-key/x-api-key-id).
403 — uma chave com escopo de tenant foi usada neste endpoint com escopo de número (code: "TENANT_SCOPE_NOT_ALLOWED").

Visão Geral

Mensagens

Modelos

Números

Conversas & Dados

Webhooks

Chamadas de Voz

Camada de Compatibilidade

Conta & Cobrança

Marca & Incorporação

GET /v1/analytics/dashboard — Analytics

Endpoint

Parâmetros de query

Exemplo

Erros comuns

​Endpoint

​Parâmetros de query

​Exemplo

​Erros comuns

Endpoint

Parâmetros de query

Exemplo

Erros comuns