Skip to main content
GET
Listar

Visão Geral

Recupera eventos de usuários com recursos poderosos de filtragem. Use este endpoint para consultar eventos por usuário, entidade, tipo de evento, intervalo de datas e muito mais. Perfeito para construir trilhas de auditoria, ferramentas de investigação de fraude e dashboards de análise.
Lógica OU para IDs de Entidade: Ao consultar por identificadores de entidade (entity_id, entity_external_id, tax_id), o sistema usa lógica OU, retornando eventos que correspondam a qualquer um dos identificadores fornecidos.

Endpoint

Autenticação

Requer uma chave de API válida no cabeçalho Authorization:

Parâmetros de Consulta

string
Filtrar eventos por identificador de usuárioExemplo: ?user_id=user_12345
string
Filtrar eventos por UUID de entidadeExemplo: ?entity_id=550e8400-e29b-41d4-a716-446655440000
string
Filtrar eventos por identificador externo de entidadeExemplo: ?entity_external_id=user_12345
string
Filtrar eventos por número de identificação fiscalExemplo: ?tax_id=20242455496
string
Filtrar eventos por tipo (ex: LOGIN_SUCCESS, TRANSFER_SUCCESS)Exemplo: ?event_type=LOGIN_SUCCESS
string
Filtrar eventos após esta data (formato ISO 8601)Exemplo: ?start_date=2026-01-01T00:00:00Z
string
Filtrar eventos antes desta data (formato ISO 8601)Exemplo: ?end_date=2026-01-31T23:59:59Z
number
default:"100"
Número máximo de eventos a retornar por página (máx: 1000)Exemplo: ?limit=50
number
default:"0"
Número de eventos a pular para paginaçãoExemplo: ?offset=100

Resposta

boolean
Indica se a requisição foi bem-sucedida
array
Array de objetos de eventos ordenados por timestamp (mais recente primeiro)
string
UUID do evento
string
Tipo de evento
string
Identificador do usuário
string
UUID da entidade
string
Identificador externo da entidade
string
ID fiscal
string
Timestamp do evento (ISO 8601)
string
Identificador do dispositivo
string
Endereço IP
string
Código do país
boolean
Flag de detecção de VPN
boolean
Flag de detecção de proxy
object
Metadados específicos do evento
string
Timestamp de criação do registro
object
Informações de paginação
number
Número total de eventos correspondentes aos filtros
number
Tamanho de página usado
number
Offset usado
boolean
Se há mais páginas disponíveis

Exemplos

Consulta Básica

Filtrar por Tipo de Evento

Filtrar por Intervalo de Datas

Exemplo de Resposta

Respostas de Erro

400 Bad Request

401 Unauthorized

403 Forbidden

500 Internal Server Error

Casos de Uso

Trilha de Auditoria

Construa uma trilha de auditoria completa para conformidade:

Investigação de Fraude

Investigue atividade suspeita:

Linha do Tempo do Usuário

Construa uma linha do tempo de atividade do usuário:

Dicas de Filtragem

Múltiplos Identificadores de Entidade

Você pode fornecer múltiplos identificadores de entidade para lançar uma rede mais ampla:

Combinando Filtros

Combine múltiplos filtros para consultas precisas:

Melhores Práticas de Paginação

Iterar Através de Todas as Páginas

Próximos Passos

Criar Evento

Rastrear novos eventos

Estatísticas de Eventos

Obter estatísticas agregadas

Listar por Entidade

Obter eventos para uma entidade específica

Detecção de Fraude

Construa regras de fraude com eventos