> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /v1/analytics/dashboard — Analytics

> Recupere os KPIs do painel e a série diária de mensagens, com escopo no número da chave de API.

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

<ParamField query="period" default="30d" type="string">
  Janela do relatório. Um de `7d`, `30d` (padrão) ou `90d`.
</ParamField>

<ParamField query="tz" type="string">
  Fuso horário IANA opcional, por exemplo `America/Sao_Paulo`. `timezone` é aceito como alias de `tz`.
</ParamField>

## Exemplo

<CodeGroup>
  ```bash cURL (x-api-key) theme={null}
  curl "https://pilotstatus.com.br/v1/analytics/dashboard?tz=America/Sao_Paulo" \
    -H "x-api-key: ps_your_key_here"
  ```

  ```bash cURL (x-api-key-id) theme={null}
  curl "https://pilotstatus.com.br/v1/analytics/dashboard?tz=America/Sao_Paulo" \
    -H "x-api-key-id: ck_xxx"
  ```

  ```json Response (200) theme={null}
  {
    "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
    }
  }
  ```
</CodeGroup>

## 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"`).