List metrics
List metrics.
At least one of event_id, company_id, or sector_id is required — the
endpoint returns 422 if none are supplied.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter metrics by event id.
Filter metrics by company id.
Filter metrics by sector id.
Filter metrics by type. Discriminator for the metric single-table hierarchy.
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 Filter to a specific leverage sub-type. Implicitly narrows to leverage metrics (LEVERAGE_TARGET, CURRENT_LEVERAGE).
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 Filter to a specific liquidity sub-type. Implicitly narrows to LIQUIDITY metrics. Sub-type for LIQUIDITY metrics.
BALANCE_SHEET, CREDIT_FACILITY, OTHER Filter to a specific capital-allocation category. Implicitly narrows to CAPITAL_ALLOCATION_PRIORITY metrics.
DEBT_REDUCTION, SHAREHOLDER_RETURNS, M_AND_A, ORGANIC_GROWTH, OTHER 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).
DATA, ISSUER_TOTAL, SECTION_TOTAL, SCOPE_TOTAL, GRAND_TOTAL, SECTION_HEADER, VALUE_ECHO Filter by Schedule-of-Investments instrument class. Implicitly narrows to PORTFOLIO_HOLDING metrics. Coarse instrument kind, derived from the row's type context.
DEBT, EQUITY, FUND, CASH_EQUIVALENT, DERIVATIVE, OTHER Opaque cursor for pagination.
Maximum number of records to return.
1 <= x <= 200Public scalar field used to sort metrics. Extension fields require metric_type; PORTFOLIO_HOLDING value is fair value.
1 - 64^[a-z][a-z0-9_]*$Sort direction. Null values sort last.
asc, desc