Skip to main content

​
O que são os logs?

Os logs são o registro das chamadas feitas à API do Notifique no seu workspace. Cada requisição (GET, POST, PUT, DELETE, etc.) que chega à API com uma API Key do seu workspace gera um log com endpoint, método HTTP, status de resposta, corpo da requisição e da resposta (quando registrados), duração e data/hora. Eles não substituem os eventos em tempo real dos webhooks (mensagem enviada, entregue, lida, etc.). Os logs são o histórico de uso da API: quem chamou qual rota, com que payload e qual foi o resultado.

​
Para que servem?

  • Auditoria — Saber quais integrações ou sistemas chamaram a API, em qual horário e com quais parâmetros. Útil para compliance e revisão de ações.
  • Debug — Quando uma mensagem não foi enviada ou um endpoint retornou erro, os logs mostram o corpo da requisição e da resposta, o status HTTP e a duração. Facilita identificar payload incorreto, escopo faltando ou problema de integração.
  • Monitoramento de uso — Ver volume de chamadas por endpoint, por método ou por API Key. Ajuda a dimensionar e a detectar picos ou uso anômalo.
  • Filtros — Consulte por período (startDate, endDate), por status HTTP (status=200,404), por método (method=POST) ou por API Key (apiKeyId), para focar em erros ou em uma integração específica.

​
Logs e API

O acesso aos logs é via API, com uma API Key que tenha o escopo logs:read. A listagem é paginada e retorna apenas os logs do workspace dessa API Key. Detalhes como corpo da requisição/resposta podem ser truncados ou omitidos conforme a política de privacidade da plataforma. Na documentação Quick Start desta seção você encontra o endpoint GET /v1/logs e os parâmetros de filtro para listar e consultar o histórico de chamadas do seu workspace.