Registro de atividades
Trilha de auditoria da loja: consulta, filtros, exportação, configuração do que é registrado e limpeza de registros antigos.
O registro de atividades (activity log) é a trilha de auditoria da loja. Cada vez que alguém faz login, altera um pedido, edita um produto ou muda uma configuração, a plataforma grava uma linha dizendo quem fez, o quê, em qual registro, de qual IP e quando. É a ferramenta para investigar incidentes ("quem apagou isso?") e para atender exigências de auditoria.
Como funciona
- A plataforma grava um registro quando uma ação acontece e o par
type+actionestá ligado. - Você consulta com filtros por tipo, ação, pessoa, registro afetado, gravidade e período.
- Para análise externa, exporta em CSV.
- Periodicamente, apaga o que é antigo demais.
A gravidade (event_level) vem em três valores:
| Valor | Significado |
|---|---|
N | Normal: operação comum. |
W | Aviso: algo sensível ou fora do esperado, como uma restauração de backup. |
E | Erro. |
Conceitos principais
Par tipo e ação
type é a área (orders, products, auth) e action o verbo (create, update, delete, login). A configuração liga ou desliga cada combinação.
Registro afetado
entity_type e entity_id apontam para o item que mudou. Com eles você monta o histórico de um pedido ou produto.
Antes e depois
Algumas ações guardam o estado anterior e posterior em payload_before e payload_after. Só a consulta em JSON devolve esses campos; o CSV não.
Ações do sistema
Rotinas automáticas gravam com user_id vazio e rótulos como System.
Endpoints
| Método | Caminho | Para que serve | Página |
|---|---|---|---|
| GET | /api/v1/admin/logs | Lista registros de atividade, do mais novo ao mais antigo | Consultar registros |
| GET | /api/v1/admin/logs/export | Exporta os registros filtrados em CSV (até 10.000 linhas) | Consultar registros |
| GET | /api/v1/admin/logs/filters | Tipos, ações, entidades e e-mails existentes (últimos 90 dias) | Consultar registros |
| GET | /api/v1/admin/logs/settings | Lista os pares tipo/ação e se estão ligados | Configurar o que é registrado |
| PUT | /api/v1/admin/logs/settings | Liga ou desliga pares tipo/ação | Configurar o que é registrado |
| POST | /api/v1/admin/logs/seed-settings | Cria os pares padrão que faltam, todos ligados | Configurar o que é registrado |
| POST | /api/v1/admin/logs/cleanup | Apaga registros mais antigos que N dias (mínimo 7) | Limpar registros antigos |
Erros comuns
- Esperar registro de um evento novo sem rodar Semear pares padrão: sem o par, o evento é descartado em silêncio.
- Enviar
date_fromcomo2026-10-01: o formato é RFC 3339 completo e, se estiver errado, o filtro é ignorado sem aviso. - Pedir
per_page=500: valores acima de 100 voltam para 20. - Tratar
logs: nullcomo erro: é a resposta de uma busca sem resultado. - Ignorar
X-Export-Truncatedna exportação. - Desligar
logs+settings_updatee perder a trilha de quem mexeu na própria auditoria.