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

# Métricas (overview)

> Agregados de API, webhooks e deliverability por período — sem baixar cada log linha a linha.

## Endpoint

```http theme={null}
GET https://api.notifique.dev/v1/metrics/overview?startDate=2026-01-01&endDate=2026-01-31
Authorization: Bearer sk_live_...
```

## Escopos

Precisa de **um** destes:

* `logs:read`
* `webhooks:read` ou `webhooks:manage`

## Query

| Parâmetro   | Descrição                                    |
| ----------- | -------------------------------------------- |
| `startDate` | ISO 8601 opcional (default: \~30 dias atrás) |
| `endDate`   | ISO 8601 opcional (default: agora)           |

## Resposta **200**

```json theme={null}
{
  "success": true,
  "data": {
    "range": { "startDate": "...", "endDate": "..." },
    "api": {
      "requests": 1200,
      "failures": 12,
      "successRate": 99.0,
      "avgDurationMs": 145.2
    },
    "webhooks": {
      "deliveries": 800,
      "failures": 4,
      "successRate": 99.5
    },
    "deliverability": { }
  }
}
```

`deliverability` traz insights de entrega por canal (estrutura conforme workspace).

## Erros

| HTTP / `code`               | Situação                               |
| --------------------------- | -------------------------------------- |
| **401** `UNAUTHORIZED`      | API Key inválida                       |
| **403** `FORBIDDEN`         | Sem `logs:read` nem escopo de webhooks |
| **402** `WORKSPACE_BLOCKED` | Workspace bloqueado                    |

Para request individual, use [Logs da API](/guides/logs/index).