Skip to main content
GET
/
organizations
/
{org_id}
/
metrics
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metric_type": "free_cashflow_margin",
      "period": "2023-12-25",
      "period_type": "monthly",
      "value": 123,
      "value_type": "real",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_items": 1
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Path Parameters

​
org_id
string<uuid>
required

Query Parameters

​
period_type
enum<string> | null
Available options:
monthly,
quarterly,
yearly
​
date_from
string<date> | null
​
date_to
string<date> | null
​
metric_type
enum<string> | null
Available options:
free_cashflow_margin,
current_ratio,
quick_ratio,
debt_ratio,
debt_to_equity_ratio,
gross_margin,
return_on_assets,
return_on_equity,
asset_turnover,
inventory_turnover,
operating_cashflow_ratio,
dscr,
interest_coverage,
cash_conversion_cycle

Response

Successful Response

​
items
OrganizationMetric · object[]
required
​
total_items
integer
required
Required range: x >= 0