Calcular previsão de créditos de um monitoramento

POST

/v2/monitoring/estimate

Calcula, sem cobrar nada, quantos créditos custaria um monitoramento.

O preço de cada módulo é o do produto que entrega o serviço dele no perfil de permissão do usuário; quando mais de um produto do perfil entrega o mesmo serviço, vale o mais barato. Cada módulo roda no início do período e depois a cada frequencyDays dias, contando os dias inteiros entre startDate e endDate, e cada rodada custa o preço do módulo por cliente. totalForecast soma todas as rodadas de todos os clientes, monthlyCost divide esse total pelos meses de 30 dias do período, no mínimo 1 mês, e modulesCostPerClient é o custo de uma rodada de todos os módulos para um cliente; os valores vêm com 2 casas decimais.

Diferente do cadastro, startDate pode ser hoje ou uma data passada e clientsCount pode ser 0. Cada módulo precisa estar disponível no perfil de permissão do usuário, como em available na rota de listar módulos monitoráveis. 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 Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Sucesso

application/json

Previsão de créditos

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver monitoramentos

🟠403Acesso negado

🟠422Corpo ou módulo inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/monitoring/estimate' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "modules": [
        {
            "moduleKey": "PROTESTS",
            "frequencyDays": 30
        },
        {
            "moduleKey": "DEBT"
        }
    ],
    "clientsCount": 40,
    "startDate": "2026-10-20",
    "endDate": "2027-10-19"
}'

Response Example

200 - Sucesso

{
    "modulesCostPerClient": 8,
    "totalForecast": 4160,
    "monthlyCost": 342.86,
    "modulesCount": 2,
    "clientsCount": 40
}

Modificado em 2026-10-21 13:16:40

Página anterior

Consultar alertas não lidos do usuário

Próxima página

Atualizar monitoramento