Skip to main content
POST
/
analytics
/
v2
/
data
/
creditbreakdown
Credit Breakdown
curl --request POST \
  --url https://gateway.creditbenchmark.com/analytics/v2/data/creditbreakdown \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metric": "CCR",
  "rating_scale": "CB21",
  "effective_date": 20250930,
  "lookback_period": 24,
  "lookback_unit": "months",
  "scope": {
    "filters": [
      {
        "key": "CBSector",
        "operator": "==",
        "values": "Banks"
      }
    ]
  },
  "facet_column": "CBCountryOfRisk"
}
'
{
  "CBCountryOfRisk": [
    "United States",
    "United Kingdom"
  ],
  "entity_count": [
    14,
    9
  ],
  "benchmark_entity_count": [
    14,
    9
  ],
  "CCR": [
    "bbb",
    "bbb-"
  ],
  "CCRPD": [
    0.00264,
    0.00314
  ],
  "upgrades": [
    1,
    0
  ],
  "downgrades": [
    0,
    2
  ],
  "rating_change": [
    1,
    -2
  ]
}

Authorizations

​
Authorization
string
header
required

JWT bearer token.

Body

application/json
​
scope
object
required

Defines the input universe. Use portfolio, filters, or both.

​
facet_column
string
required

Column to summarize by. Built-in facetable columns and custom scope.portfolio columns are supported.

​
metric
enum<string>
default:CCR

Metric to compute. Use CCR for consensus analytics or MyRating for client-specific analytics.

Available options:
CCR,
MyRating
​
rating_scale
enum<string>
default:CB21

Rating scale to map results onto. Use CB21, CB7, or MyScale for the requesting bank's master scale.

Available options:
CB21,
CB7,
MyScale
​
effective_date
integer

As-of date in YYYYMMDD format. If omitted, the latest available date is used.

​
lookback_period
integer
default:24

Number of lookback_unit intervals before effective_date.

Required range: x >= 0
​
lookback_unit
enum<string>
default:months
Available options:
months,
quarters,
years
​
result_filter
object

Filtering, sorting, and limiting applied after an analytic has computed its results. filters[].key and sort.field must reference supported result fields for the selected route. Some routes also accept documented alias names that map to returned fields.

Response

Credit breakdown retrieved successfully

Credit breakdown results.

​
entity_count
integer[]
​
benchmark_entity_count
integer[]
​
CCR
(string | integer | number | boolean | null)[]
​
CCRPD
number[]
​
upgrades
integer[]
​
downgrades
integer[]
​
rating_change
number[]
​
ClientRating
(string | integer | number | boolean | null)[]
​
ClientPD
number[]
​
ExMeRating
(string | integer | number | boolean | null)[]
​
ExMePD
number[]
​
notch_difference
number[]
​
notch_diff_aggressive
integer[]
​
notch_diff_consistent
integer[]
​
notch_diff_conservative
integer[]
​
{key}
(string | integer | number | boolean | null)[]