> ## Documentation Index > Fetch the complete documentation index at: https://docs.passu.ai/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi.json get /v1/metrics openapi: 3.1.0 info: title: Passu Public API summary: >- External read-only API for sectors, companies, events, metrics, and analyses. description: >- The Passu Public API is a read-only external API intended for server-to-server integrations. version: v1 servers: - url: https://api.passu.ai description: Production security: [] tags: - name: auth - name: sectors - name: companies - name: events - name: metrics - name: analyses paths: /v1/metrics: get: tags: - metrics summary: List metrics description: >- List metrics. At least one of `event_id`, `company_id`, or `sector_id` is required — the endpoint returns 422 if none are supplied. operationId: listMetrics parameters: - name: event_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' description: Filter metrics by event id. title: Event Id description: Filter metrics by event id. - name: company_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' description: Filter metrics by company id. title: Company Id description: Filter metrics by company id. - name: sector_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' description: Filter metrics by sector id. title: Sector Id description: Filter metrics by sector id. - name: metric_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/MetricType' - type: 'null' description: Filter metrics by type. title: Metric Type description: Filter metrics by type. - name: leverage_metric_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/LeverageMetricType' - type: 'null' description: >- Filter to a specific leverage sub-type. Implicitly narrows to leverage metrics (LEVERAGE_TARGET, CURRENT_LEVERAGE). title: Leverage Metric Type description: >- Filter to a specific leverage sub-type. Implicitly narrows to leverage metrics (LEVERAGE_TARGET, CURRENT_LEVERAGE). - name: liquidity_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/LiquidityType' - type: 'null' description: >- Filter to a specific liquidity sub-type. Implicitly narrows to LIQUIDITY metrics. title: Liquidity Type description: >- Filter to a specific liquidity sub-type. Implicitly narrows to LIQUIDITY metrics. - name: priority_category in: query required: false schema: anyOf: - $ref: '#/components/schemas/PriorityCategory' - type: 'null' description: >- Filter to a specific capital-allocation category. Implicitly narrows to CAPITAL_ALLOCATION_PRIORITY metrics. title: Priority Category description: >- Filter to a specific capital-allocation category. Implicitly narrows to CAPITAL_ALLOCATION_PRIORITY metrics. - name: row_role in: query required: false schema: anyOf: - $ref: '#/components/schemas/PortfolioHoldingRowRole' - type: 'null' description: >- Filter by Schedule-of-Investments row role. Implicitly narrows to PORTFOLIO_HOLDING metrics. title: Row Role description: >- Filter by Schedule-of-Investments row role. Implicitly narrows to PORTFOLIO_HOLDING metrics. - name: instrument_class in: query required: false schema: anyOf: - $ref: '#/components/schemas/PortfolioHoldingInstrumentClass' - type: 'null' description: >- Filter by Schedule-of-Investments instrument class. Implicitly narrows to PORTFOLIO_HOLDING metrics. title: Instrument Class description: >- Filter by Schedule-of-Investments instrument class. Implicitly narrows to PORTFOLIO_HOLDING metrics. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: Opaque cursor for pagination. title: Cursor description: Opaque cursor for pagination. - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 description: Maximum number of records to return. default: 50 title: Limit description: Maximum number of records to return. - name: sort_by in: query required: false schema: type: string minLength: 1 maxLength: 64 pattern: ^[a-z][a-z0-9_]*$ description: >- Public scalar field used to sort metrics. Extension fields require metric_type; PORTFOLIO_HOLDING value is fair value. default: id title: Sort By description: >- Public scalar field used to sort metrics. Extension fields require metric_type; PORTFOLIO_HOLDING value is fair value. - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sort direction. Null values sort last. default: asc description: Sort direction. Null values sort last. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetricListResponse' '401': description: Authentication failed. content: application/json: schema: $ref: '#/components/schemas/Problem' '403': description: Authenticated but not permitted to access this resource. content: application/json: schema: $ref: '#/components/schemas/Problem' '422': description: Request is missing a required filter. content: application/json: schema: $ref: '#/components/schemas/Problem' security: - HTTPBearer: [] components: schemas: MetricType: type: string enum: - 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 title: MetricType description: Discriminator for the metric single-table hierarchy. LeverageMetricType: type: string enum: - 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 title: LeverageMetricType LiquidityType: type: string enum: - BALANCE_SHEET - CREDIT_FACILITY - OTHER title: LiquidityType description: Sub-type for LIQUIDITY metrics. PriorityCategory: type: string enum: - DEBT_REDUCTION - SHAREHOLDER_RETURNS - M_AND_A - ORGANIC_GROWTH - OTHER title: PriorityCategory PortfolioHoldingRowRole: type: string enum: - DATA - ISSUER_TOTAL - SECTION_TOTAL - SCOPE_TOTAL - GRAND_TOTAL - SECTION_HEADER - VALUE_ECHO title: PortfolioHoldingRowRole description: |- What a printed schedule row IS (label-don't-drop: consumers filter, nothing is dropped). PortfolioHoldingInstrumentClass: type: string enum: - DEBT - EQUITY - FUND - CASH_EQUIVALENT - DERIVATIVE - OTHER title: PortfolioHoldingInstrumentClass description: Coarse instrument kind, derived from the row's type context. SortOrder: type: string enum: - asc - desc title: SortOrder MetricListResponse: properties: data: items: $ref: '#/components/schemas/Metric' type: array title: Data next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor has_more: type: boolean title: Has More type: object required: - data - has_more title: MetricListResponse Problem: properties: type: type: string title: Type title: type: string title: Title status: type: integer title: Status detail: type: string title: Detail request_id: type: string title: Request Id instance: anyOf: - type: string - type: 'null' title: Instance errors: anyOf: - items: $ref: '#/components/schemas/ValidationErrorItem' type: array - type: 'null' title: Errors type: object required: - type - title - status - detail - request_id title: Problem Metric: properties: id: type: string format: uuid title: Id event_id: type: string format: uuid title: Event Id metric_type: $ref: '#/components/schemas/MetricType' value: anyOf: - type: number - type: integer - type: string - type: 'null' title: Value attributes: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Attributes quotes: items: $ref: '#/components/schemas/Quote' type: array title: Quotes updated_at: type: string format: date-time title: Updated At type: object required: - id - event_id - metric_type - updated_at title: Metric ValidationErrorItem: properties: field: type: string title: Field message: type: string title: Message type: object required: - field - message title: ValidationErrorItem JsonValue: anyOf: - type: boolean - type: integer - type: number - type: string - items: $ref: '#/components/schemas/JsonValue' type: array - additionalProperties: $ref: '#/components/schemas/JsonValue' type: object - type: 'null' Quote: properties: quote_type: $ref: '#/components/schemas/QuoteType' fact_id: anyOf: - type: string format: uuid - type: 'null' title: Fact Id text: anyOf: - type: string - type: 'null' title: Text author: anyOf: - type: string - type: 'null' title: Author title: anyOf: - type: string - type: 'null' title: Title table_name: anyOf: - type: string - type: 'null' title: Table Name row_names: items: type: string type: array title: Row Names type: object required: - quote_type title: Quote QuoteType: type: string enum: - TEXT - TABLE - XBRL_FACT title: QuoteType description: >- Public quote-type enum. Owned by the public contract, decoupled from the ORM enum. securitySchemes: HTTPBearer: type: http scheme: bearer bearerFormat: JWT ````