Skip to main content
GET
/
v1
/
metrics
List metrics
curl --request GET \
  --url https://api.passu.ai/v1/metrics \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "value": 123,
      "attributes": {},
      "quotes": [
        {
          "text": "<string>",
          "author": "<string>",
          "title": "<string>",
          "table_name": "<string>",
          "row_names": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

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:
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,
TOP_MARKDOWNS,
RETURN_ON_EQUITY
​
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
​
cursor
string | null

Opaque cursor for pagination.

​
limit
integer
default:50

Maximum number of records to return.

Required range: 1 <= x <= 200

Response

Successful Response

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