Vai al contenuto principale

Documentation Index

Fetch the complete documentation index at: https://docs.creditbenchmark.com/llms.txt

Use this file to discover all available pages before exploring further.

Utilizzi questi come forme di payload canoniche per le richieste comuni dell’API di Analytics. La richiesta più comune è una getdata per un elenco noto di CBId.
Per un elenco di entità note, utilizzare scope.portfolio.CBId. Impostare lookback_period su 0 per i dati puntuali e richieda solo le colonne necessarie.
{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "portfolio": {
      "CBId": [
        "CB0000022706",
        "CB0000022177"
      ]
    }
  }
}
Utilizzi scope.filters quando si desidera che l’API crei l’universo di input prima dell’esecuzione della query. Questo esempio restituisce le entità statunitensi con un rating di bbb- o inferiore.
{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CBCountryOfRisk",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CCR21Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}
Utilizzare una condizione generica scope.filters quando si desiderano tutte le entità con un rating di consenso.
{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CCR",
        "operator": "is not null",
        "values": ""
      }
    ]
  }
}
Utilizzi result_filter per filtrare o ordinare le righe dopo la selezione dei dati. Questo parametro è distinto da scope.filters, che definisce l’universo di input prima dell’esecuzione della query.
{
  "result_filter": {
    "filters": [
      {
        "key": "CCR100PDMid",
        "operator": ">",
        "values": 0.002
      }
    ],
    "sort": [
      {
        "field": "CCR100PDMid",
        "direction": "asc"
      }
    ]
  }
}
filters_join è facoltativo. Se omesso, i filtri multipli vengono combinati con AND.Aggiunga filters_join quando è necessaria una logica booleana esplicita, come NOT, OR o un’espressione mista. Quando è presente, è posizionale e deve avere un elemento in più rispetto a filters.Per un semplice AND, ometta filters_join.
{
  "scope": {
    "filters": [
      {
        "key": "CBCountryOfRisk",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CCR21Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}
Per un OR esplicito, inserisca | tra i filtri.
{
  "scope": {
    "filters": [
      {
        "key": "CBCountryOfRisk",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CBSector",
        "operator": "!=",
        "values": "Insurance"
      }
    ],
    "filters_join": ["", "|", ""]
  }
}
Utilizzi scope.filters per definire l’universo di input prima dell’esecuzione dell’analisi. result_filter.filters solo per filtrare le righe di output calcolate dopo che l’analisi è già stata eseguita.
Last modified on May 12, 2026