Pular para o conteúdo principal
GET
Listar Eventos de Auditoria

Autorizações

X-API-Key
string
header
obrigatório

Autenticação por API Key. Usada por implantações single-tenant (MULTI_TENANT_ENABLED=false). Enviada em todas as requisições /v1/*.

Cabeçalhos

Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

X-API-Key
string
obrigatório

A chave de API para autenticação. Este header é obrigatório para todos os endpoints, exceto verificações de integridade.

X-Request-Id
string<uuid>

Um identificador único usado para rastrear cada requisição.

Parâmetros de consulta

limit
integer
padrão:100

O número máximo de itens a incluir na resposta. Padrão: 100, Máx: 1000

Intervalo obrigatório: 1 <= x <= 1000
cursor
string

Cursor de paginação da resposta anterior.

start_date
string<date-time>

Data de início (formato RFC3339 com fuso horário, inclusivo). O padrão é 90 dias antes do horário atual.

end_date
string<date-time>

Data final (formato RFC3339 com fuso horário, exclusivo). O padrão é o horário atual.

event_type
enum<string>

Filtrar por tipo de evento.

Opções disponíveis:
TRANSACTION_VALIDATED,
RULE_CREATED,
RULE_UPDATED,
RULE_ACTIVATED,
RULE_DEACTIVATED,
RULE_DRAFTED,
RULE_DELETED,
LIMIT_CREATED,
LIMIT_UPDATED,
LIMIT_ACTIVATED,
LIMIT_DEACTIVATED,
LIMIT_DRAFTED,
LIMIT_DELETED
action
enum<string>

Filtrar por ação.

Opções disponíveis:
VALIDATE,
CREATE,
UPDATE,
DELETE,
ACTIVATE,
DEACTIVATE,
DRAFT
result
enum<string>

Filtrar por resultado.

Opções disponíveis:
SUCCESS,
FAILED,
ALLOW,
DENY,
REVIEW
resource_type
enum<string>

Filtrar por tipo de recurso.

Opções disponíveis:
transaction,
rule,
limit
resource_id
string<uuid>

Filtrar por ID do recurso (UUID).

actor_type
enum<string>

Filtrar por tipo de ator.

Opções disponíveis:
user,
system
actor_id
string

Filtrar por ID do ator.

account_id
string<uuid>

Filtrar por ID da conta (consulta context.request.account.id).

segment_id
string<uuid>

Filtrar por ID do segmento.

portfolio_id
string<uuid>

Filtrar por ID do portfólio.

transaction_type
string

Filtrar por tipo de transação.

matched_rule_id
string<uuid>

Filtrar por ID da regra correspondente (consulta de inclusão em array).

sort_by
enum<string>
padrão:created_at

O campo usado para ordenar os resultados.

Opções disponíveis:
created_at,
event_type
sort_order
enum<string>
padrão:DESC

A ordem usada para ordenar os resultados.

Opções disponíveis:
ASC,
DESC

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

Lista paginada de eventos de auditoria para conformidade SOX/GLBA.

auditEvents
object[]

Lista de registros de eventos de auditoria.

Maximum array length: 1000
hasMore
boolean

Se há mais resultados disponíveis.

nextCursor
string | null

Cursor para buscar a próxima página. Nulo se não houver mais resultados.