Choosing an Analytics Route - Credit Benchmark Docs

The Analytics API has six routes. Pick the one whose output shape matches what you need — a trend line, a rating histogram, a sector table, a list of movers, or raw entity rows. The four analytic routes below compute summaries server-side from your scope. Use getdata when you need one row per entity and date. Use columns to list available fields and check entitlements before you build.

Route comparison

Route	Required input	When to use it
`columns`	None	Before building a UI or integration, to confirm field names and entitlements
`getdata`	`scope`	Exports, time series, or downstream models from raw fields
`aggregatetrend`	`scope`	Portfolio credit quality over time
`creditbreakdown`	`scope`, `facet_column`	Latest summary by sector, country, or custom portfolio column
`entityratingchange`	`scope`	Upgrades, downgrades, or PD moves over a lookback window
`ratingdistribution`	`scope`	Composition of a portfolio by rating grade

If you already plan to aggregate, bucket, sort, or group the data yourself, prefer the analytic route instead of pulling rows with getdata and reshaping them client-side.

Request order

Every analytic route follows the same order:

scope selects the input universe.
The route computes its result for that universe.
result_filter shapes the returned rows.

scope.filters decides which entities enter the analytic. result_filter.filters only filters the rows that come back. See Scope and empty results for patterns and edge cases. For metric and rating_scale, see Metrics and scales. For copy-paste payloads, see Payload examples.

​Route comparison

​Request order

Route comparison

Request order