> ## 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.

# Logs da API

> Aprenda a consultar o histórico de chamadas à API para auditar integrações e debugar erros.

<Tip>
  Logs da API são o **extrato da integração**: cada chamada HTTP fica registrada com request, response e status. Quando algo quebra, você vê exatamente o que entrou e o que a API respondeu.
</Tip>

## O que são logs da API?

É o histórico de **todas as chamadas** feitas à API no seu workspace: método, endpoint, body enviado, resposta e código HTTP.

Pense no extrato do cartão: não mostra se a mensagem chegou ao cliente, mas mostra **cada transação** entre seu sistema e a Notifique.

## Para que serve?

Com logs você pode:

* **Debugar** erros 401, 403 ou 400 na integração
* **Auditar** qual API Key gerou cada chamada
* **Ver** request e response exatos (com dados sensíveis mascarados)
* **Filtrar** por status, método, data ou chave
* **Cruzar** com [Respostas de erro](/guides/conceitos/resposta-de-erros) para entender o `code` retornado

## Logs vs webhooks

São complementares, não substitutos:

| Situação                                | Logs da API | Webhooks |
| --------------------------------------- | ----------- | -------- |
| Entender por que a API retornou 403     | **Sim**     | Não      |
| Saber qual chave fez a chamada          | **Sim**     | Não      |
| Ver request e response da chamada HTTP  | **Sim**     | Não      |
| Saber se a mensagem chegou ao cliente   | Não         | **Sim**  |
| Reagir em tempo real a entrega ou falha | Não         | **Sim**  |

<Note>
  **Webhook** avisa o que aconteceu com uma **mensagem** (entregue, falhou, lida). **Log da API** registra **quem chamou a API** e o que a API respondeu na hora da requisição.
</Note>

## Como consultar

### No painel

1. Abra **Logs** no menu lateral (ou pelo **Developer Hub**)
2. Escolha o workspace (se tiver mais de um)
3. Filtre por status, método ou data
4. Clique em um item para ver request e response completos

### Via API

#### 1. Permissão

A chave precisa do escopo **`logs:read`**. Os logs ficam restritos ao **workspace da chave**.

#### 2. Listar logs

Retorna histórico paginado do workspace.

```http theme={null}
GET https://api.notifique.dev/v1/logs?page=1&limit=20
Authorization: Bearer sk_live_xxxxx
```

Resposta paginada (`pagination.total`, `pagination.page`, `pagination.limit`, `pagination.totalPages`). Cada item inclui:

| Campo                          | O que é                                        |
| ------------------------------ | ---------------------------------------------- |
| `endpoint`                     | Caminho chamado (ex.: `/v1/whatsapp/messages`) |
| `method`                       | `GET`, `POST`, etc.                            |
| `status`                       | Código HTTP retornado                          |
| `requestBody` / `responseBody` | JSON enviado e recebido                        |
| `requestQuery`                 | Query string, quando houver                    |
| `duration`                     | Tempo da requisição em ms                      |
| `apiKeyId`                     | Chave que fez a chamada                        |
| `instanceId`                   | Instância relacionada, se aplicável            |
| `userAgent` / `ip`             | Metadados da requisição                        |
| `createdAt`                    | Data/hora UTC                                  |

#### 3. Filtrar resultados

| Parâmetro                   | Uso                                                                   |
| --------------------------- | --------------------------------------------------------------------- |
| **page**                    | Página (padrão 1)                                                     |
| **limit**                   | Itens por página (máx. 100)                                           |
| **status**                  | HTTP separados por vírgula (ex.: `200,202,403`)                       |
| **startDate** / **endDate** | Intervalo ISO 8601                                                    |
| **method**                  | Ex.: `GET,POST`                                                       |
| **apiKeyId**                | Filtrar por chave do workspace (precisa pertencer ao mesmo workspace) |

Exemplo filtrando erros 403 em POST:

```http theme={null}
GET https://api.notifique.dev/v1/logs?status=403&method=POST&startDate=2025-02-20T00:00:00.000Z&endDate=2025-02-20T23:59:59.000Z
Authorization: Bearer sk_live_xxxxx
```

<Warning>
  Tokens e dados sensíveis nos logs aparecem como `[REDACTED]` antes de salvar. Veja [Segurança e Confiabilidade](/guides/conceitos/seguranca-e-confiabilidade).
</Warning>

***

## Próximos passos

* [Respostas de erro](/guides/conceitos/resposta-de-erros): códigos HTTP e `code`
* [Chaves de API](/guides/api-key/index): escopos e `logs:read`
* [Webhooks](/guides/webhooks/index): status de entrega em tempo real
* [Workspaces](/guides/workspaces/index): onde ficam os logs do workspace