VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

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.

Pontos principais
  • Leitura exige view_logs; configuração e limpeza exigem manage_log_settings.
  • Só entram no registro os pares type + action que existem e estão ligados na configuração.
  • A lista traz até 100 itens por página; a exportação em CSV traz no máximo 10.000 linhas.
  • A limpeza apaga em definitivo e nunca remove registros com menos de 7 dias.

Como funciona

  1. A plataforma grava um registro quando uma ação acontece e o par type + action está ligado.
  2. Você consulta com filtros por tipo, ação, pessoa, registro afetado, gravidade e período.
  3. Para análise externa, exporta em CSV.
  4. Periodicamente, apaga o que é antigo demais.

A gravidade (event_level) vem em três valores:

ValorSignificado
NNormal: operação comum.
WAviso: algo sensível ou fora do esperado, como uma restauração de backup.
EErro.

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étodoCaminhoPara que servePágina
GET/api/v1/admin/logsLista registros de atividade, do mais novo ao mais antigoConsultar registros
GET/api/v1/admin/logs/exportExporta os registros filtrados em CSV (até 10.000 linhas)Consultar registros
GET/api/v1/admin/logs/filtersTipos, ações, entidades e e-mails existentes (últimos 90 dias)Consultar registros
GET/api/v1/admin/logs/settingsLista os pares tipo/ação e se estão ligadosConfigurar o que é registrado
PUT/api/v1/admin/logs/settingsLiga ou desliga pares tipo/açãoConfigurar o que é registrado
POST/api/v1/admin/logs/seed-settingsCria os pares padrão que faltam, todos ligadosConfigurar o que é registrado
POST/api/v1/admin/logs/cleanupApaga 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_from como 2026-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: null como erro: é a resposta de uma busca sem resultado.
  • Ignorar X-Export-Truncated na exportação.
  • Desligar logs + settings_update e perder a trilha de quem mexeu na própria auditoria.

Próximos passos

Consultar registros
Filtre, pagine e exporte.
Configurar o que é registrado
Controle os pares tipo e ação.
Limpar registros antigos
Controle o tamanho da trilha.
Anterior
Insights da Venddor Intelligence
Próxima
Consultar registros
Nesta página
  • Como funciona
  • Conceitos principais
  • Par tipo e ação
  • Registro afetado
  • Antes e depois
  • Ações do sistema
  • Endpoints
  • Erros comuns
  • Próximos passos