Descrição
A API de Eventos permite recuperar registros de log e auditoria de consultas executadas na Plataforma de Dados. Cada consulta gera um registro que inclui informações como tempo de execução, IP de origem, parâmetros utilizados e o resultado retornado. Todos os registros de consulta são armazenados por tempo indefinido. Estando disponíveis para acesso via API por no mínimo 3 meses. Para obter registros mais antigos, entre em contato conosco.
Parâmetros da Requisição
A requisição deve conter um corpo JSON com os parâmetros de busca. É obrigatório informar um dos seguintes parâmetros: QueryId, q ou Tags.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
QueryId | string | Condicional | Identificador único da consulta a ser recuperada. |
q | string | Condicional | String de busca para filtrar eventos com base nos parâmetros da consulta original. Ex: doc{12345678901}. |
Tags | object | Condicional | Objeto com chave:valor para buscar consultas por tags personalizadas. A busca retornará eventos que contenham todas as tags informadas. |
QueryDate | string | Opcional | Data de referência para a consulta no formato especificado em DateFormat. Otimiza a busca quando usado com QueryId ou filtra resultados quando usado com q. |
DateFormat | string | Opcional | Formato da data informada em QueryDate. Ex: yyyy-MM-dd. Obrigatório se QueryDate for informado. |
PageSize | integer | Opcional | Define o número de registros por página. Usado apenas com o parâmetro q. Valor padrão: 50. |
Cursor | string | Opcional | Ponteiro para a próxima página de resultados, obtido em uma resposta anterior. Usado para paginação em conjunto com q. |
Nota: Recomendamos fortemente que todos os QueryIds sejam sempre armazenados, pois esse é o elemento mais forte que amarra as consultas realizadas com os registros de log e auditoria. Por padrão, um usuário tem acesso a todos os registros de eventos associados com a empresa a qual ele pertence.
Exemplos
- Recuperar o resultado de uma consulta específica mais rápido, com uma data de referência:
{
"QueryId": "[seu query id]",
"QueryDate": "2019-07-25",
"DateFormat": "yyyy-MM-dd"
}
- Recuperar todas as consultas que utilizam tags específicas:
{
"Tags": {
"Key1": "Value1",
"Key2": "Value2"
}
}
- Recuperar todas as consultas realizadas contra um CPF específico, de 10 em 10:
{
"q": "doc{xxxxxxxxxxx}",
"PageSize": 10
}
- Realizar a paginação por resultados:
{
"q": "doc{xxxxxxxxxxx}",
"PageSize": 10,
"Cursor": "[valor de cursor retornado pela chamada anterior]"
}