Listar monitoramentos da empresa

GET

/v2/monitoring/

Lista os monitoramentos da empresa do usuário, criados por qualquer usuário dela, com um resumo da empresa em summary.

isOwner filtra só os criados pelo usuário autenticado (true) ou só os dos demais (false). search busca parte do nome, sem diferenciar maiúsculas nem acentos. total conta os monitoramentos que atendem aos filtros, sem a paginação; summary considera todos os monitoramentos da empresa, sem filtros.

Os contadores de alertas de cada monitoramento consideram só os alertas de risco vigentes que não foram limpos. A listagem também confere a permissão de quem criou cada monitoramento da página.

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.

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 Consulta

Parâmetros Header

Respostas

🟢200Sucesso

application/json

Monitoramentos da empresa e resumo

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver monitoramentos

🟠403Acesso negado

🟠422Parâmetros de consulta inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/monitoring/?search=safra&isOwner=true&sort=createdAt&order=desc&offset=0&limit=20' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Monitoramentos em vários estados

{
    "summary": {
        "groupsCount": 3,
        "monitoredClientsCount": 42,
        "monitoredClientsWalletsCount": 1,
        "alertsLast7DaysCount": 9,
        "alertsLast7DaysVariation": 9,
        "creditsConsumedMonth": 186.5
    },
    "monitorings": [
        {
            "_id": "9c1e4b7a-0000-4000-8000-000000000d01",
            "name": "Carteira safra 26/27",
            "classification": "Produtores de soja do MT",
            "clientsCount": 40,
            "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",
            "alertsTodayCount": 0,
            "alertsCount": 9,
            "unreadAlertsCount": 4,
            "unreadAlertsToday": 0,
            "hasBlockedModules": true,
            "createdBy": {
                "_id": "b2d4f6a8-0000-4000-8000-000000000e01",
                "name": "Maria Exemplo da Silva"
            },
            "isOwner": true
        },
        {
            "_id": "9c1e4b7a-0000-4000-8000-000000000d02",
            "name": "Fornecedores críticos",
            "classification": null,
            "clientsCount": 0,
            "status": "DRAFT",
            "deactivationReason": null,
            "draftReasons": [
                "WITHOUT_CLIENTS"
            ],
            "effectiveStartDate": "2026-10-20T00:00:00.000Z",
            "effectiveEndDate": "2027-04-20T00:00:00.000Z",
            "remainingDays": null,
            "lastTriggerAt": null,
            "alertsTodayCount": 0,
            "alertsCount": null,
            "unreadAlertsCount": 0,
            "unreadAlertsToday": 0,
            "hasBlockedModules": false,
            "createdBy": {
                "_id": "b2d4f6a8-0000-4000-8000-000000000e02",
                "name": "João Exemplo"
            },
            "isOwner": false
        },
        {
            "_id": "9c1e4b7a-0000-4000-8000-000000000d03",
            "name": "Clientes com CPR",
            "classification": "Acompanhamento de CPRs",
            "clientsCount": 2,
            "status": "INACTIVE",
            "deactivationReason": "PERMISSION_REVOKED",
            "draftReasons": [],
            "effectiveStartDate": "2026-08-01T00:00:00.000Z",
            "effectiveEndDate": "2026-12-31T00:00:00.000Z",
            "remainingDays": null,
            "lastTriggerAt": "2026-09-30T00:00:00.000Z",
            "alertsTodayCount": 0,
            "alertsCount": 0,
            "unreadAlertsCount": 0,
            "unreadAlertsToday": 0,
            "hasBlockedModules": true,
            "createdBy": {
                "_id": "b2d4f6a8-0000-4000-8000-000000000e01",
                "name": "Maria Exemplo da Silva"
            },
            "isOwner": true
        }
    ],
    "total": 3,
    "offset": 0,
    "limit": 20
}

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

Página anterior

Marcar falhas de consulta do monitoramento como vistas

Próxima página

Cadastrar monitoramento