Eksempler på API-nyttelast

Hent data for CB-ID-er

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

{
  "lookback_period": 0,
  "columns": [
    "CB_ID",
    "CB_Legal_Name",
    "CB_Effective_Date_ID",
    "CB_CCR",
    "CB_CCR_100_PDMid"
  ],
  "scope": {
    "portfolio": {
      "CB_ID": [
        "CB0000022706",
        "CB0000022177"
      ]
    }
  }
}

Hent data for et univers

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

{
  "lookback_period": 0,
  "columns": [
    "CB_ID",
    "CB_Legal_Name",
    "CB_Effective_Date_ID",
    "CB_CCR",
    "CB_CCR_100_PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CB_Country",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CB_CCR_21_Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}

Hent alle data

Bruk en bred scope.filters betingelse når du ønsker alle enheter med en konsensusvurdering.

{
  "lookback_period": 0,
  "columns": [
    "CB_ID",
    "CB_Legal_Name",
    "CB_Effective_Date_ID",
    "CB_CCR",
    "CB_CCR_100_PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CB_CCR",
        "operator": "!=",
        "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 inndatuniverset før spørringen kjøres.

{
  "lookback_period": 0,
  "columns": [
    "CB_ID",
    "CB_Legal_Name",
    "CB_Effective_Date_ID",
    "CB_CCR",
    "CB_CCR_100_PDMid"
  ],
  "scope": {
    "portfolio": {
      "CB_ID": [
        "CB0000022706",
        "CB0000022177"
      ]
    }
  },
  "result_filter": {
    "filters": [
      {
        "key": "CB_CCR_100_PDMid",
        "operator": ">",
        "values": 0.002
      }
    ],
    "sort": [
      {
        "field": "CB_CCR_100_PDMid",
        "direction": "asc"
      }
    ]
  }
}

Syntaks for filtersammenkobling

filters_join er valgfritt. Hvis du utelater det, kobles flere filtre sammen med AND.Legg det kun til filters_join når du trenger eksplisitt boolsk logikk, for eksempel 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": "CB_Country",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CB_CCR_21_Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}

For eksplisitt OR plasserer du | mellom filtrene.

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

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

Oversikt

Endepunkter

Modell for entitetsavstemming

Analytikk