Skip to main content

O que é

Toda criação, alteração e exclusão dos objetos principais da plataforma é gravada em um registro permanente, com o autor da ação e o momento em que ela aconteceu. É a fonte de auditoria da Olie: é aqui que se responde quem mudou determinado dado, e quando. É o mesmo registro que alimenta o histórico do projeto na interface. O endpoint abaixo dá acesso a ele para qualquer objeto auditado.
Não confunda com o registro de execuções de automação. Aquele mostra o que uma automação fez em cada disparo, guarda cerca de 100 execuções por automação e descarta as antigas — serve para depurar, não para auditar. O registro de alterações desta página é outra coisa: é a trilha de auditoria, e é permanente.

O endpoint

A requisição é autenticada como qualquer outra da API — veja Autenticação e segurança. A consulta é feita no contexto da empresa autenticada.

Parâmetros

Todos são enviados 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: a busca é sempre por um tipo de objeto de cada vez. Os valores aceitos estão na seção O que é registrado, mais abaixo.
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 alterações de modelo, os valores são created, updated e deleted. Alguns eventos próprios usam nomes compostos — por exemplo 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 da janela desejada.

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 bloco meta nem o total de registros. A navegação é feita só pelo offset.
Como não há total, a última página é aquela em que a resposta vem com menos de 10 registros — ou vazia.

Resposta

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. Vem null quando o registro 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 das operações de criação, alteração e exclusão, os movimentos do projeto entre etapas também são registrados — com subject_type igual a App\Models\Project e event começando por funnel_step.. O registro guarda a etapa de destino e a de origem.
Outros objetos também gravam histórico e podem ser consultados da mesma forma — área de negócio, anexos de funil e de etapa, convites, menções e páginas do Caderno, entre outros. A tabela acima 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, ou 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

Vale conhecer antes de desenhar qualquer relatório em cima destes 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. Uma automação que passou a fazer outra coisa não deixa rastro do que mudou — o registro mostra que alguém a editou, 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 — e, pelo mesmo motivo do item dos papéis, não são retornados por esta busca.

Retenção

Os registros de alteração não são expurgados: 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 é rotativo e não serve como evidência de auditoria.

Exemplos

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

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.