DataBolsa docs
Referência da APIExtensõesCreditAlertas

Criar ou atualizar uma regra de alerta

O limiar é informado na UNIDADE DA MÉTRICA: inadimplência de 5% entra como 0.05 (fração), concentração de 60% entra como 60 (percentual). O catálogo em `GET /grid` diz a unidade de cada uma.

PUT
/v1/desk/orgs/{org}/alert-rules
AuthorizationBearer <token>

In: header

Path Parameters

orgstring

Id ou slug da organização (de deskGetMe).

metricstring

Métrica do catálogo de deskGetGrid.

comparatorstring

gt dispara acima do limiar; lt, abaixo.

Value in"gt" | "lt"
thresholdnumber

Limiar na UNIDADE da métrica (fração para inadimplência: 0.05 = 5%; percentual para concentração: 60 = 60%).

severity?string

Severidade do alerta gerado (default attention).

Value in"info" | "attention" | "critical"
enabled?boolean

false desliga a regra sem apagá-la.

Response Body

curl -X PUT "https://api.databolsa.com/v1/desk/orgs/string/alert-rules" \  -H "Content-Type: application/json" \  -d '{    "metric": "string",    "comparator": "gt",    "threshold": 0  }'
{
  "id": "string",
  "metric": "string",
  "comparator": "string",
  "threshold": 0,
  "severity": "string",
  "enabled": true
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string"
}