Omfang og tomme resultater

Analytiske funksjoner skiller valg av inndata fra utformingen av utdata.

scope definerer hvilke enheter som inngår i analysen.
«result_filter» bestemmer hvilke rader som returneres etter at analysen er kjørt.

For valg av rute, se Velge en rute. For metric og rating_scale, se Metrikker og skalaer.

Omfang

scope evalueres før endepunktet beregner resultatet.

Porteføljeomfang
Filtermess
Portefølje og filtre
Sintaks for filterkobling

Bruk scope.portfolio når du allerede kjenner enhetene.

{
  "scope": {
    "portfolio": {
      "CB_ID": ["CB0000022706", "CB0000022177"]
    }
  }
}

Egendefinerte porteføljekolonner kan brukes som facet_column verdier som endepunktet støtter fasetter.

Bruk scope.filters når API-et skal bygge universet ut fra feltbetingelser.

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

Dersom filters_join utelates, kobles flere filtre sammen med AND.

Når både filter og resultatfilter er angitt, benyttes skjæringspunktet.

{
  "scope": {
    "portfolio": {
      "CB_ID": ["CB0000022706", "CB0000022177"]
    },
    "filters": [
      {
        "key": "CB_Sector",
        "operator": "==",
        "values": "Banks"
      }
    ]
  }
}

Dette betyr enheter i porteføljen din som er banker, ikke porteføljen din pluss alle banker.

Bruk filters_join bare når du trenger eksplisitt OR- eller NOT-logikk. Den er posisjonell og har ett element mer enn filters.

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

Resultatfilter

result_filter endrer ikke inndatainnsettet. Det filtrerer, sorterer eller begrenser kun beregnede utdatarader.

Mekanisme	Gjelder for
`scope.filters`	Enheter før analysen kjøres
`result_filter.filters`	etter at analysen er kjørt
`result_filter.sort`	Radrekkefølge i svaret
`result_filter.limit`	Maksimalt antall returnerte rader

Bruk scope for å bestemme hva som skal inkluderes. Bruk result_filter for å bestemme hva som skal returneres.

MyRating-dekning

Med metric: "CCR", bruker analysen enheter innenfor omfanget som har konsensusdata. Med metric: "MyRating"bruker analysen kun den delen av omfanget der banken din har sendt inn vurderinger for det forespurte datointervallet. Med andre ord, ved å velge MyRating kan redusere universet fra «alt du ba om» til «de forespurte enhetene som banken din har vurdert». Hvis banken din ikke har vurdert noen enheter i det forespurte omfanget, returnerer API-et et tomt suksesssvar i stedet for en feilmelding.

Forespurt omfang	Dekningsområde for banken din	MyRating benytter
3 enheter	3 vurderte enheter	3 enheter
3 enheter	2 vurderte enheter	2 enheter
3 enheter	0 vurderte enheter	Tomme suksesssvar

For MyRating-ruter av aggregert type beregnes «ex-me»-feltene for den samme delmengden som dekkes. De utgjør ikke en fullstendig referanse for enheter som banken din ikke vurderer. Ikke sammenlign AGG_EntityCount fra CCR svar med AGG_ClientEntityCount fra MyRating svar som om de har samme nevner.

Tomme svar etter rute

Rute	Tomme suksesssvar
`getdata`	`{}` eller tomme kolonnematriser
`aggregatetrend`	`{}`
`creditbreakdown`	`{}`
`entityratingchange`	`{}`
`ratingdistribution` med `metric: "CCR"`	`{"ccr": {}}`
`ratingdistribution` med `metric: "MyRating"`	`{"my_bank": {}, "ex_me": {}}`

Oversikt

Endepunkter

Modell for entitetsavstemming

Analytikk

Omfang

Resultatfilter

MyRating-dekning

Tomme svar etter rute

​Omfang

​Resultatfilter

​MyRating-dekning

​Tomme svar etter rute

Omfang

Resultatfilter

MyRating-dekning

Tomme svar etter rute