Listar consultas de um monitoramento

GET

/v2/monitoring/{monitoringId}/queries

Lista as consultas feitas pelo monitoramento informado em monitoringId, com uma linha por cliente e módulo em cada rodada.

Cada linha traz o cliente, o módulo, o critério que valia na rodada, quando a consulta foi feita e o resultado dela em alertStatus. alertStatus considera também alertas já lidos ou limpos. queryId é o ID da consulta na plataforma, o mesmo que as rotas de resultado de cada serviço recebem.

Linhas de clientes excluídos da base de clientes, ou que não são pessoa física nem jurídica, continuam na lista com client null; um cliente só tirado do monitoramento continua com client preenchido.

Qualquer usuário da empresa pode consultar. Monitoramento inexistente ou de outra empresa devolve 404 (Monitoria não encontrada.). Requer autenticação via Bearer JWT ou header x-api-key e a permissão de ver monitoramentos. Usuário sem perfil de permissão recebe 403 (Acesso negado); perfil inexistente, 401 (Permissão inválida!); perfil sem a permissão, 400 (Permissão não encontrada); usuário inativo, 404 (Usuário não encontrado).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200Sucesso

application/json

Consultas do monitoramento

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver monitoramentos

🟠403Acesso negado

🟠404Monitoramento não encontrado

🟠422Parâmetros de consulta inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/monitoring/9c1e4b7a-0000-4000-8000-000000000d01/queries?search=Exemplo&sort=createdAt&order=desc&offset=0&limit=20' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Rodada com resultados variados

{
    "queries": [
        {
            "queryId": "e1f2a3b4-0000-4000-8000-0000000000b2",
            "clientId": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22",
            "client": {
                "_id": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22",
                "name": "Maria Exemplo da Silva",
                "taxId": "11144477735",
                "kind": "natural"
            },
            "moduleKey": "PROTESTS",
            "moduleName": "Protestos",
            "criterion": "SPECIFIC_CHANGE",
            "alertStatus": "NO_ALERT",
            "createdAt": "2026-10-15T09:00:00.000Z",
            "scheduledDate": "2026-10-15T00:00:00.000Z"
        },
        {
            "queryId": "e1f2a3b4-0000-4000-8000-0000000000b2",
            "clientId": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22",
            "client": {
                "_id": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22",
                "name": "Maria Exemplo da Silva",
                "taxId": "11144477735",
                "kind": "natural"
            },
            "moduleKey": "JUDICIAL",
            "moduleName": "Judicial",
            "criterion": "ANY_CHANGE",
            "alertStatus": "QUERY_ERROR",
            "createdAt": "2026-10-15T09:00:00.000Z",
            "scheduledDate": "2026-10-15T00:00:00.000Z"
        },
        {
            "queryId": "e1f2a3b4-0000-4000-8000-0000000000b3",
            "clientId": "5b2c3d4e-0000-4000-8000-000000000c09",
            "client": null,
            "moduleKey": "PROTESTS",
            "moduleName": "Protestos",
            "criterion": "SPECIFIC_CHANGE",
            "alertStatus": "PROCESSING",
            "createdAt": "2026-10-15T09:00:00.000Z",
            "scheduledDate": "2026-10-15T00:00:00.000Z"
        },
        {
            "queryId": "e1f2a3b4-0000-4000-8000-0000000000b3",
            "clientId": "5b2c3d4e-0000-4000-8000-000000000c09",
            "client": null,
            "moduleKey": "JUDICIAL",
            "moduleName": "Judicial",
            "criterion": "ANY_CHANGE",
            "alertStatus": "QUERY_ERROR",
            "createdAt": "2026-10-15T09:00:00.000Z",
            "scheduledDate": "2026-10-15T00:00:00.000Z"
        },
        {
            "queryId": "e1f2a3b4-0000-4000-8000-0000000000b1",
            "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "client": {
                "_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
                "name": "Empresa Exemplo Ltda",
                "taxId": "11222333000181",
                "kind": "legal"
            },
            "moduleKey": "PROTESTS",
            "moduleName": "Protestos",
            "criterion": "SPECIFIC_CHANGE",
            "alertStatus": "ALERT_GENERATED",
            "createdAt": "2026-10-15T09:00:00.000Z",
            "scheduledDate": "2026-10-15T00:00:00.000Z"
        },
        {
            "queryId": "e1f2a3b4-0000-4000-8000-0000000000b1",
            "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "client": {
                "_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
                "name": "Empresa Exemplo Ltda",
                "taxId": "11222333000181",
                "kind": "legal"
            },
            "moduleKey": "JUDICIAL",
            "moduleName": "Judicial",
            "criterion": "ANY_CHANGE",
            "alertStatus": "QUERY_ERROR",
            "createdAt": "2026-10-15T09:00:00.000Z",
            "scheduledDate": "2026-10-15T00:00:00.000Z"
        }
    ],
    "total": 205,
    "offset": 0,
    "limit": 6
}

Modificado em 2026-10-21 13:23:15

Página anterior

Marcar alertas de um cliente como lidos

Próxima página

Solicitar contato sobre antecipação de crédito