Visualizar monitoramento

GET

/v2/monitoring/{monitoringId}

Devolve o monitoramento informado em monitoringId, de qualquer usuário da empresa, com a configuração, todos os módulos (ligados e desligados) e uma página dos clientes.

Os clientes vêm ordenados pelo nome, com os sem nome no fim, e sem os excluídos da base de clientes; search busca parte do nome, sem diferenciar maiúsculas nem acentos, ou parte do CPF/CNPJ, e filter separa os clientes com e sem alertas de risco vigentes. available e unavailableReason de cada módulo seguem o perfil de permissão de quem criou o monitoramento. hasQueryError indica se alguma consulta ficou sem resultado, falhou ou teve módulo pulado por indisponibilidade depois da última vez que as falhas foram marcadas como vistas.

Só conta módulos com alertEnabled; a falha de um módulo com alerta desligado não aparece aqui. A consulta também confere a permissão de quem criou o monitoramento. Se o perfil de permissão dessa pessoa deixou de dar acesso a um módulo ligado, o módulo é desligado e a mudança entra no histórico. Se todos os módulos de um monitoramento SCHEDULED ou ACTIVE forem desligados, ele passa a INACTIVE, com motivo PERMISSION_REVOKED, e a resposta já traz o novo status.

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

Monitoramento e página de clientes

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?search=Exemplo&filter=withAlerts&offset=0&limit=20' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Monitoramento ativo

{
    "_id": "9c1e4b7a-0000-4000-8000-000000000d01",
    "name": "Carteira safra 26/27",
    "classification": "Produtores de soja do MT",
    "status": "ACTIVE",
    "deactivationReason": null,
    "draftReasons": [],
    "effectiveStartDate": "2026-09-01T00:00:00.000Z",
    "effectiveEndDate": "2027-08-31T00:00:00.000Z",
    "remainingDays": 316,
    "lastTriggerAt": "2026-10-15T00:00:00.000Z",
    "clientsCount": 40,
    "modules": [
        {
            "moduleKey": "PROTESTS",
            "name": "Protestos",
            "productId": "5f8d0d55-0000-4000-8000-000000000a01",
            "frequencyDays": 15,
            "enabled": true,
            "alertEnabled": true,
            "available": true,
            "unavailableReason": null,
            "criterion": "SPECIFIC_CHANGE",
            "conditions": {
                "logic": "OR",
                "conditions": [
                    {
                        "field": "totalProtests",
                        "operator": "GREATER_THAN",
                        "value": 0
                    },
                    {
                        "field": "totalValue",
                        "operator": "GREATER_THAN_OR_EQUAL",
                        "value": 50000
                    }
                ]
            },
            "lastRunAt": "2026-10-15T00:00:00.000Z",
            "nextRunAt": "2026-10-30T00:00:00.000Z"
        },
        {
            "moduleKey": "JUDICIAL",
            "name": "Judicial",
            "productId": "5f8d0d55-0000-4000-8000-000000000a02",
            "frequencyDays": 30,
            "enabled": true,
            "alertEnabled": true,
            "available": false,
            "unavailableReason": "SERVICE_UNAVAILABLE",
            "criterion": "ANY_CHANGE",
            "conditions": {},
            "lastRunAt": "2026-10-15T00:00:00.000Z",
            "nextRunAt": "2026-11-14T00:00:00.000Z"
        },
        {
            "moduleKey": "DEBT",
            "name": "Endividamento",
            "productId": "5f8d0d55-0000-4000-8000-000000000a03",
            "frequencyDays": 30,
            "enabled": false,
            "alertEnabled": true,
            "available": true,
            "unavailableReason": null,
            "criterion": "ANY_CHANGE",
            "conditions": {},
            "lastRunAt": "2026-09-01T00:00:00.000Z",
            "nextRunAt": "2026-10-01T00:00:00.000Z"
        }
    ],
    "createdAt": "2026-08-25T14:24:32.384Z",
    "updatedAt": "2026-10-18T13:05:12.481Z",
    "createdBy": {
        "_id": "b2d4f6a8-0000-4000-8000-000000000e01",
        "name": "Maria Exemplo da Silva"
    },
    "isOwner": true,
    "hasQueryError": true,
    "clients": {
        "items": [
            {
                "_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
                "name": "Empresa Exemplo Ltda",
                "taxId": "11222333000181",
                "kind": "legal",
                "alertsCount": 2,
                "unreadAlertsCount": 1
            },
            {
                "_id": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22",
                "name": "Maria Exemplo da Silva",
                "taxId": "11144477735",
                "kind": "natural",
                "alertsCount": 0,
                "unreadAlertsCount": 0
            }
        ],
        "total": 40,
        "offset": 0,
        "limit": 20
    }
}

Modificado em 2026-10-21 13:21:17

Página anterior

Atualizar monitoramento

Próxima página

Desativar monitoramento