scope. Use getdata when you need one row per entity and date. Use metadata routes before building a UI or integration, especially metadata/columns for available field names, data types, filters, facets, and entitlements.
Data and analytics routes
| Route | Required input | When to use it |
|---|---|---|
getdata | scope | Exports, time series, or downstream models from raw entity-level 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 |
Metadata routes
| Route | Required input | When to use it |
|---|---|---|
metadata/columns | None | Confirm request-side field names, data types, scope filters, facets, and entitlement requirements |
metadata/rating-scales | None | Load CB21, CB7, and client-scale metadata for labels, order, and band mappings |
metadata/industry-schema | None | Build industry hierarchy filters or map industry levels |
metadata/geography-schema | None | Build geography hierarchy filters or map countries to regions |
metadata/available-dates | None | Find the latest available and finalised effective dates |
getdata and reshaping them client-side.
Request order
Every analytic route follows the same order:scopeselects the input universe.- The route computes its result for that universe.
result_filtershapes 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.