Eksempler på API-nyttelast - Credit Benchmark Docs

Hent data for CBIds

For en liste over kjente enheter, bruk scope.portfolio.CBId. Sett lookback_period til 0 for punktdata, og be om bare de kolonnene du trenger.

{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "portfolio": {
      "CBId": [
        "CB0000022706",
        "CB0000022177"
      ]
    }
  }
}

Hent data for et univers

Bruk scope.filters når du vil at API-et skal bygge inndatuniverset før spørringen kjøres. Dette eksemplet returnerer enheter i USA med en rating på bbb- eller dårligere.

{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CBCountryOfRisk",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CCR21Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}

Hent alle data

Bruk en bred scope.filters betingelse når du vil ha alle enheter med en konsensusrating.

{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CCR",
        "operator": "is not null",
        "values": ""
      }
    ]
  }
}

Filtrering og sortering av resultater

Bruk result_filter til å filtrere eller sortere rader etter at dataene er valgt. Dette er atskilt fra scope.filters, som definerer inndatamengden før spørringen kjøres.

{
  "result_filter": {
    "filters": [
      {
        "key": "CCR100PDMid",
        "operator": ">",
        "values": 0.002
      }
    ],
    "sort": [
      {
        "field": "CCR100PDMid",
        "direction": "asc"
      }
    ]
  }
}

Syntaks for filtersammenføyning

filters_join er valgfritt. Hvis du utelater det, kobles flere filtre sammen med AND.Legg kun til filters_join når du trenger eksplisitt boolsk logikk som NOT, OR eller et blandet uttrykk. Når det er til stede, er det posisjonelt og må ha ett element mer enn filters.For et enkelt AND, utelat filters_join.

{
  "scope": {
    "filters": [
      {
        "key": "CBCountryOfRisk",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CCR21Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}

For eksplisitt OR, plasser | mellom filtrene.

{
  "scope": {
    "filters": [
      {
        "key": "CBCountryOfRisk",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CBSector",
        "operator": "!=",
        "values": "Insurance"
      }
    ],
    "filters_join": ["", "|", ""]
  }
}

Bruk scope.filters til å definere inndatauniverset før analysen kjøres. Bruk result_filter.filters bare for å filtrere beregnede utgangsrader etter at analysen allerede er kjørt.

Documentation Index