> ## 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 metric types

> List the metric-type catalog — display name, description, allowed headline
units, and whether the type carries a typed extension.



## OpenAPI

````yaml /openapi.json get /v1/metric-types
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/metric-types:
    get:
      tags:
        - metrics
      summary: List metric types
      description: >-
        List the metric-type catalog — display name, description, allowed
        headline

        units, and whether the type carries a typed extension.
      operationId: listMetricTypes
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricTypeListResponse'
        '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'
      security:
        - HTTPBearer: []
components:
  schemas:
    MetricTypeListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MetricTypeInfo'
          type: array
          title: Data
      type: object
      required:
        - data
      title: MetricTypeListResponse
    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
    MetricTypeInfo:
      properties:
        metric_type:
          $ref: '#/components/schemas/MetricType'
        display_name:
          type: string
          title: Display Name
        description:
          type: string
          title: Description
        units:
          items:
            $ref: '#/components/schemas/MetricUnit'
          type: array
          title: Units
        has_extension:
          type: boolean
          title: Has Extension
      type: object
      required:
        - metric_type
        - display_name
        - description
        - units
        - has_extension
      title: MetricTypeInfo
    ValidationErrorItem:
      properties:
        field:
          type: string
          title: Field
        message:
          type: string
          title: Message
      type: object
      required:
        - field
        - message
      title: ValidationErrorItem
    MetricType:
      type: string
      enum:
        - 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
      title: MetricType
      description: Discriminator for the metric single-table hierarchy.
    MetricUnit:
      type: string
      enum:
        - RATIO
        - PERCENT
        - USD_MILLIONS
        - USD_BILLIONS
        - USD_PER_SHARE
        - USD_PER_BOE
        - USD_PER_MONTH
        - PRIORITY_ORDER
        - COUNT
        - BASIS_POINTS
        - METRIC_TON
        - KILOTON
        - POUND
        - KILOGRAM
        - SHORT_TON
        - GALLON
        - LITER
        - BARREL
        - CUBIC_METER
        - BOE_PER_DAY
        - MBOE_PER_DAY
        - BBL_PER_DAY
        - MBBL_PER_DAY
        - MCF_PER_DAY
        - MMCF_PER_DAY
        - MCFE_PER_DAY
        - BOE
        - MBOE
        - MMBOE
        - OTHER
      title: MetricUnit
      description: >-
        Unit qualifying a metric's headline ``value``.


        A row's headline number is always ``metric.value`` interpreted in this

        unit; a second, genuinely different fact lives as a typed column on the

        type's extension table. The financial units are dimensionless or USD;
        the

        physical units conform the legacy ``ChemicalsVolumeUnit`` and

        ``ProductionVolumeUnit`` so that physical-volume metrics keep their
        native

        figure as the headline value rather than pushing it onto an extension.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````