Listar histórico de alterações de um monitoramento

GET

/v2/monitoring/{monitoringId}/history

Lista o histórico de alterações do monitoramento informado em monitoringId, da mais recente para a mais antiga.

Entram as mudanças de período, de frequência e de módulos ligados, a troca e a remoção de clientes, a desativação, a reativação, a passagem para rascunho e o encerramento do período. Cada item traz a ação, quem fez, quando e um payload com os detalhes, cujo formato depende da ação; as alterações automáticas aparecem com changedBy SYSTEM (Sistema). total é a quantidade de alterações, sem a paginação.

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

Histórico de alterações

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

Response Example

200 - Histórico com várias ações

{
    "changes": [
        {
            "_id": "8e3a1c20-0000-4000-8000-0000000000a5",
            "action": "CLIENT_REMOVED",
            "changedBy": {
                "id": "b2d4f6a8-0000-4000-8000-000000000e01",
                "name": "Maria Exemplo da Silva"
            },
            "createdAt": "2026-10-18T13:05:00.000Z",
            "payload": {
                "clientIds": [
                    "3a9d7e21-0000-4000-8000-000000000c10"
                ]
            }
        },
        {
            "_id": "8e3a1c20-0000-4000-8000-0000000000a4",
            "action": "FREQUENCY_CHANGED",
            "changedBy": {
                "id": "b2d4f6a8-0000-4000-8000-000000000e01",
                "name": "Maria Exemplo da Silva"
            },
            "createdAt": "2026-09-30T14:30:00.000Z",
            "payload": {
                "moduleKey": "PROTESTS",
                "from": 30,
                "to": 15
            }
        },
        {
            "_id": "8e3a1c20-0000-4000-8000-0000000000a3",
            "action": "MODULE_TOGGLED",
            "changedBy": {
                "id": "b2d4f6a8-0000-4000-8000-000000000e01",
                "name": "Maria Exemplo da Silva"
            },
            "createdAt": "2026-09-30T14:30:00.000Z",
            "payload": {
                "moduleKey": "DEBT",
                "enabled": false
            }
        },
        {
            "_id": "8e3a1c20-0000-4000-8000-0000000000a2",
            "action": "MONITORING_REACTIVATED",
            "changedBy": {
                "id": "b2d4f6a8-0000-4000-8000-000000000e01",
                "name": "Maria Exemplo da Silva"
            },
            "createdAt": "2026-09-12T10:00:00.000Z",
            "payload": {
                "startDate": "2026-09-01T00:00:00.000Z",
                "endDate": "2027-08-31T00:00:00.000Z",
                "status": "SCHEDULED"
            }
        },
        {
            "_id": "8e3a1c20-0000-4000-8000-0000000000a1",
            "action": "MONITORING_DEACTIVATED",
            "changedBy": {
                "id": "b2d4f6a8-0000-4000-8000-000000000e01",
                "name": "Maria Exemplo da Silva"
            },
            "createdAt": "2026-09-10T16:40:00.000Z",
            "payload": {
                "reason": "MANUAL"
            }
        }
    ],
    "total": 5,
    "offset": 0,
    "limit": 20
}

Modificado em 2026-10-21 13:18:25

Página anterior

Desativar monitoramento

Próxima página

Reativar monitoramento