Skip to main content
O registro de alterações guarda cada criação, alteração e exclusão dos objetos principais da Olie, com o autor e o momento da ação. Esta página mostra como consultar esse registro pela API, o que ele cobre e quais são os limites dele.

O que é o registro de alterações

O registro de alterações é a fonte de auditoria da Olie: é nele que você descobre quem mudou determinado dado, e quando. Ele é permanente e alimenta o histórico do projeto na interface. O endpoint desta página dá acesso ao registro de qualquer objeto auditado.
O registro de alterações é diferente do registro de execuções de automação. O registro de execuções mostra o que uma automação fez em cada disparo e guarda só as cerca de 100 execuções mais recentes de cada automação. Ele serve para depurar, não para auditar.

Consultar o registro

A consulta usa um único endpoint:
A requisição é autenticada como qualquer outra da API: veja Autenticação e segurança. A consulta traz só os registros da empresa autenticada. Se a requisição usar o token de um usuário, ele precisa da permissão Visualizar o histórico de alterações dos registros. Sem ela, a resposta é HTTP 403 com message: permission_required. Veja Papéis e permissões.

Parâmetros

Envie todos os parâmetros no corpo da requisição.
string
required
Nome completo da classe do objeto auditado, no formato usado internamente pela plataforma (por exemplo, App\Models\Project). É o único parâmetro obrigatório: cada busca cobre um tipo de objeto. Os valores aceitos estão em O que é registrado.
string | integer
Identificador do objeto. Restringe a busca ao histórico daquele registro específico. Sem ele, a resposta traz as alterações de todos os objetos daquele tipo.
string
Tipo de ação. Em criações, alterações e exclusões, os valores são created, updated e deleted. Alguns eventos próprios usam nomes compostos, como funnel_step.moved para o movimento de um projeto entre etapas.
string
Identificador de quem executou a ação, um usuário ou uma aplicação. Restringe a busca ao que aquele autor fez.
string
Identificador do lote. Uma única operação que altera vários objetos grava todos os registros sob o mesmo lote; este filtro recupera o lote inteiro.
integer
default:"0"
Página da listagem, começando em 0. Cada incremento avança 10 registros.
Não existe filtro por data. Para recortar um período, percorra as páginas a partir do registro mais recente e pare quando created_at sair do período desejado.

Paginação

Este endpoint não segue o formato descrito em Paginação. A resposta traz 10 registros por página, sempre da alteração mais recente para a mais antiga, e não inclui o objeto meta nem o total de registros. Você navega só pelo offset. Como não há total, a última página é a que vem com menos de 10 registros, ou vazia.

Resposta

A resposta traz a lista de registros em activities:
string
Nome interno da ação registrada, no formato objeto.evento — por exemplo project.updated.
string
Tipo da ação. O mesmo valor aceito no filtro event.
string
Classe do objeto alterado.
string | integer
Identificador do objeto alterado.
object
O objeto em si, buscado no momento da consulta. Um objeto excluído que ainda pode ser restaurado continua vindo preenchido. Vem null quando o objeto foi excluído definitivamente: o histórico permanece, o objeto não.
string
Classe do autor: App\Models\User quando a ação partiu de uma pessoa, App\Models\Application quando partiu de um token de integração.
string
Identificador do autor.
object
O autor da ação. Vem null quando não há autor identificado — veja Autoria.
object
O conteúdo da alteração. Nas alterações de modelo, traz attributes com os valores gravados e old com os anteriores, campo a campo. Nos eventos próprios, o formato varia: costuma trazer value com o objeto envolvido na ação.
string
Identificador do lote, quando a ação fez parte de uma operação que alterou vários objetos. O mesmo valor aceito no filtro log_batch_id.
string
Data e hora da alteração.

O que é registrado

Cada linha abaixo é um valor aceito em subject_type. Para todos eles, ficam registradas a criação, a alteração e a exclusão.
O papel é a exceção da tabela: nele o registro cobre a criação, a edição e a alteração das permissões do papel — papéis não são excluídos na plataforma.
Além da criação, da alteração e da exclusão, o registro guarda os movimentos do projeto entre etapas, com subject_type igual a App\Models\Project e event começando por funnel_step.. O registro traz a etapa de origem e a de destino. Outros objetos também gravam histórico e podem ser consultados da mesma forma, como área de negócio, anexos de funil e de etapa, convites, menções e páginas do Caderno. A tabela cobre o que costuma ser pedido em auditoria.

Autoria

Cada registro guarda quem executou a ação, em causer_type e causer_id:
  • um usuário, quando a ação veio da interface ou de uma conexão MCP;
  • uma aplicação, quando veio de um token de API.
Uma ação executada por uma automação roda em segundo plano, fora da sessão de quem a disparou, e por isso é gravada sem autor: causer vem null. Ao montar um relatório de auditoria, trate a ausência de autor como “executado pela plataforma”, e não como falha do registro.

Limites do registro

Considere estes limites antes de montar um relatório com estes dados.
Na automação, o registro guarda apenas o título e se ela está ativa ou inativa.Gatilho, condições e ações não entram no histórico. Se uma automação passou a fazer outra coisa, o registro mostra que alguém a editou, mas não o que foi editado.
Atribuir ou remover um papel de um usuário é registrado (eventos role.attach e role.detach, sobre App\Models\FrameRelationship), mas esse registro é gravado sem a empresa.Como a busca é sempre escopada pela empresa autenticada, esses registros não aparecem no resultado. A alteração existe no histórico; ela apenas não é recuperável por este endpoint.
Alterar as permissões de um papel é registrado (evento permissions.updated, sobre Spatie\Permission\Models\Role).Já as permissões concedidas diretamente a um usuário, sem passar por um papel, não são registradas. Auditorias de acesso devem considerar essa lacuna.
O envio e a remoção de mídias gravam histórico, mas sem a empresa. Pelo mesmo motivo do item dos papéis, esses registros não são retornados por esta busca.

Retenção

Os registros de alteração não são apagados: o histórico permanece disponível desde a primeira gravação, sem prazo de descarte. Isso vale só para o registro de alterações. O registro de execuções de automação descarta as execuções antigas e não serve como evidência de auditoria.

Exemplos

Os exemplos mostram o corpo da requisição para POST /api/management/search-activities.

Histórico de um projeto

Só os movimentos entre etapas de um projeto

O que uma pessoa alterou nos clientes, segunda página

Próximos passos

Estas páginas complementam o registro de alterações:

Estrutura de respostas

O envelope comum a todas as respostas da API.

Autenticação e segurança

Como autenticar a requisição e o que o token pode fazer.

Segurança e privacidade

Onde os dados ficam, como o acesso é controlado e o que consta nos documentos legais.

Logs de automação

O registro de execuções — diagnóstico, não auditoria.