Skip to main content
GET
List metrics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

event_id
string<uuid> | null

Filter metrics by event id.

company_id
string<uuid> | null

Filter metrics by company id.

sector_id
string<uuid> | null

Filter metrics by sector id.

metric_type
enum<string> | null

Filter metrics by type. Discriminator for the metric single-table hierarchy.

Available options:
FINANCIAL_LINE_ITEM,
LEVERAGE_TARGET,
CURRENT_LEVERAGE,
CAPITAL_ALLOCATION_PRIORITY,
LIQUIDITY,
PIK_INCOME,
FIRST_LIEN_SHARE,
NON_ACCRUAL_SHARE,
FLOATING_RATE_SHARE,
SPILLOVER_INCOME,
UNDISTRIBUTED_NII,
INDUSTRY_EXPOSURE,
RETURN_ON_EQUITY,
CHEMICALS_VOLUME,
CHEMICALS_CAPACITY_UTILIZATION,
PRODUCT_SEGMENT_MIX,
END_MARKET_EXPOSURE,
CUSTOMER_CONCENTRATION,
GEOGRAPHIC_EXPOSURE,
MAINTENANCE_GROWTH_CAPEX_SPLIT,
PRIMARY_INPUT_COST_DRIVERS,
PRODUCTION_VOLUME,
CASH_OPERATING_COST,
PROVED_RESERVES,
REALIZED_PRICE_HEDGE,
STATED_BREAKEVEN,
RATE_BASE_CAPEX_PLAN,
COMMS_SUBSCRIBERS_NET_ADDS,
COMMS_ARPU_ARPA,
COMMS_CHURN,
COMMS_NETWORK_FOOTPRINT,
DEBT_TO_CAPITAL,
HOMEBUILDING_GROSS_MARGIN,
NAV_GAV,
TOTAL_LIABILITIES,
SHARES_OUTSTANDING,
PORTFOLIO_HOLDING
leverage_metric_type
enum<string> | null

Filter to a specific leverage sub-type. Implicitly narrows to leverage metrics (LEVERAGE_TARGET, CURRENT_LEVERAGE).

Available options:
DEBT_TO_EBITDA,
FFO_TO_DEBT,
MOODYS_CFO_TO_DEBT,
S_AND_P_FFO_TO_DEBT,
FITCH_FFO_TO_DEBT,
DEBT_TO_CAPITALIZATION,
DEBT_TO_EQUITY,
PORTFOLIO_DEBT_TO_EBITDA,
PORTFOLIO_AVG_LOAN_TO_VALUE
liquidity_type
enum<string> | null

Filter to a specific liquidity sub-type. Implicitly narrows to LIQUIDITY metrics. Sub-type for LIQUIDITY metrics.

Available options:
BALANCE_SHEET,
CREDIT_FACILITY,
OTHER
priority_category
enum<string> | null

Filter to a specific capital-allocation category. Implicitly narrows to CAPITAL_ALLOCATION_PRIORITY metrics.

Available options:
DEBT_REDUCTION,
SHAREHOLDER_RETURNS,
M_AND_A,
ORGANIC_GROWTH,
OTHER
row_role
enum<string> | null

Filter by Schedule-of-Investments row role. Implicitly narrows to PORTFOLIO_HOLDING metrics. What a printed schedule row IS (label-don't-drop: consumers filter, nothing is dropped).

Available options:
DATA,
ISSUER_TOTAL,
SECTION_TOTAL,
SCOPE_TOTAL,
GRAND_TOTAL,
SECTION_HEADER,
VALUE_ECHO
instrument_class
enum<string> | null

Filter by Schedule-of-Investments instrument class. Implicitly narrows to PORTFOLIO_HOLDING metrics. Coarse instrument kind, derived from the row's type context.

Available options:
DEBT,
EQUITY,
FUND,
CASH_EQUIVALENT,
DERIVATIVE,
OTHER
cursor
string | null

Opaque cursor for pagination.

limit
integer
default:50

Maximum number of records to return.

Required range: 1 <= x <= 200
sort_by
string
default:id

Public scalar field used to sort metrics. Extension fields require metric_type; PORTFOLIO_HOLDING value is fair value.

Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9_]*$
sort_order
enum<string>
default:asc

Sort direction. Null values sort last.

Available options:
asc,
desc

Response

Successful Response

data
Metric · object[]
required
has_more
boolean
required
next_cursor
string | null