Skip to main content
POST
Aggregate Trend

Authorizations

Authorization
string
header
required

JWT bearer token.

Body

application/json
scope
object
required

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

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
facet_column
string

Optional facetable column to segment the aggregate. Built-in facetable columns and custom scope.portfolio columns are supported.

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

Aggregate trend retrieved successfully

Aggregate trend results.

CB_Effective_Date_ID
integer[]
AGG_EntityCount
integer[]
AGG_CCRPD_log
number[]
AGG_CCRPD
number[]
AGG_CCRPD_index
number[]
AGG_CCR
(string | integer | number | boolean | null)[]
AGG_ClientPD_log
number[]
AGG_ClientPD
number[]
AGG_ClientPD_index
number[]
AGG_ClientRating
(string | integer | number | boolean | null)[]
AGG_ClientRatingNotch
number[]
AGG_ExMePD_log
number[]
AGG_ExMePD
number[]
AGG_ExMePD_index
number[]
AGG_ExMeRating
(string | integer | number | boolean | null)[]
AGG_ExMeRatingNotch
number[]
{key}
(string | integer | number | boolean | null)[]
Last modified on July 10, 2026