DataBolsa docs
Referência da APIExtensõesCreditAlertas

Ledger de alertas já observados

Append-only: cada linha é o registro imutável de um alerta que disparou, com o valor e o LIMIAR vigentes naquele instante. Editar uma regra depois não reescreve o passado. É o insumo do backtest de um sinal (lift, falso positivo, antecedência) e do 'o que mudou desde a última vez'.

GET
/v1/desk/orgs/{org}/alert-history
AuthorizationBearer <token>

In: header

Path Parameters

orgstring

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

Query Parameters

cnpj?string

Recorta por classe (CNPJ).

source?string

Origem: covenant (regulamento), rule (regra da mesa) ou reporting (parou de reportar).

Value in"covenant" | "rule" | "reporting"
since?string

ISO 8601; devolve só o que disparou depois disso.

limit?integer

Registros a devolver (1–500).

Range1 <= value <= 500

Response Body

curl -X GET "https://api.databolsa.com/v1/desk/orgs/string/alert-history?cnpj=string&source=covenant&since=string&limit=1"
{
  "data": [
    {
      "alert_key": "string",
      "cnpj": "string",
      "source": "string",
      "severity": "string",
      "metric": "string",
      "value": 0,
      "threshold": 0,
      "distance": 0,
      "reference_date": "string",
      "title": "string",
      "detected_at": "string"
    }
  ],
  "meta": {
    "count": 0
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string"
}