DataBolsa docs
Referência da APIExtensõesCreditAlertas

Alertas da watchlist na competência mais recente

Derivados na leitura a partir de três origens: limiar do regulamento da classe (`covenant`), regra configurada pela mesa (`rule`) e classe que parou de reportar (`reporting`). A leitura também REGISTRA no ledger append-only o que ainda não tinha sido observado, e devolve `first_detected_at` — é o que permite dizer 'desde quando' sem reconstruir o passado com as regras de hoje.

GET
/v1/desk/orgs/{org}/watchlists/{list}/alerts
AuthorizationBearer <token>

In: header

Path Parameters

orgstring

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

liststring

Id ou slug da watchlist (de deskListWatchlists).

Response Body

curl -X GET "https://api.databolsa.com/v1/desk/orgs/string/watchlists/string/alerts"
{
  "data": [
    {
      "key": "string",
      "cnpj": "string",
      "name": "string",
      "source": "covenant",
      "severity": "info",
      "metric": "string",
      "value": 0,
      "threshold": 0,
      "distance": 0,
      "reference_date": "string",
      "title": "string",
      "evidence": {
        "doc_id": "string",
        "page": 0,
        "quote": "string"
      },
      "status": "open",
      "first_detected_at": "string"
    }
  ],
  "meta": {
    "count": 0
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string"
}