Metrics

List Metrics

Returns a paginated collection of metrics.

get/metrics

Query parameters

company_idstring uuid required

ID of your company or fund

pageinteger

Page number

portfolio_company_profile_idstring uuid

Portfolio company profile ID (filter[portfolio_company_profile_id]={id})

Filter by portfolio company profile ID (Investor product only)

Response

Successfully retrieved metrics

Example response

{
  "metrics": [
    {
      "id": "ec5252fe-9abc-4096-85e9-1374e70a3182",
      "name": "Revenue",
      "frequency": "monthly",
      "unit": "USD",
      "portfolio_company_profile_id": "ec5252fe-9abc-4096-85e9-1374e70a3182",
      "company_id": "cad09a10-73e8-4205-ae67-4e6156f37be8"
    }
  ],
  "meta": {
    "total": 2,
    "total_pages": 1,
    "page": 1
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.