List Metrics

GET /metrics

Bearer auth

Returns a paginated collection of metrics.

Query parameters

company_id string(uuid) Required

ID of your company or fund
page integer

Page number

Minimum value is 1. Default value is 1.
filter object

Filter by portfolio company profile ID (Investor product only)
Hide filter attribute Show filter attribute object
- portfolio_company_profile_id string(uuid)
  
  Portfolio company profile ID (filter[portfolio_company_profile_id]={id})

Responses

200 application/json

Successfully retrieved metrics
Hide response attributes Show response attributes object
- metrics array[object]
  
  Hide metrics attributes Show metrics attributes object
  
  id string(uuid) Required
  
  Unique identifier for the metric
  
  name string Required
  
  Name of the metric
  
  frequency string Required
  
  Frequency of the metric reporting
  
  Values are daily, weekly, monthly, or quarterly.
  
  unit string Required
  
  Unit of measurement (number, percent, or ISO4217 currency code)
  
  portfolio_company_profile_id string | null
  
  ID of the associated portfolio company profile
  
  company_id string(uuid) Required
  
  ID of the company or fund
  
  created_at string(date-time)
  
  When the metric was created
- meta object
  
  Hide meta attributes Show meta attributes object
  
  total integer Required
  
  Total number of items across all pages
  
  total_pages integer Required
  
  Total number of pages
  
  page integer Required
  
  Current page number
400 application/json

Bad Request - The request is invalid or malformed
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Single error item. Different error types can include different fields.
  
  Hide errors attributes Show errors attributes object
  
  type string
  
  Machine-readable error type
  
  field string
  
  The related field, if applicable
  
  message string
  
  Human-readable error message
401 application/json

Unauthorized - Invalid or missing authentication token
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Single error item. Different error types can include different fields.
  
  Hide errors attributes Show errors attributes object
  
  type string
  
  Machine-readable error type
  
  field string
  
  The related field, if applicable
  
  message string
  
  Human-readable error message
429 application/json

Too Many Requests - Rate limit exceeded
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Single error item. Different error types can include different fields.
  
  Hide errors attributes Show errors attributes object
  
  type string
  
  Machine-readable error type
  
  field string
  
  The related field, if applicable
  
  message string
  
  Human-readable error message

GET /metrics

curl \
 --request GET 'https://api.visible.vc/metrics?company_id=cad09a10-73e8-4205-ae67-4e6156f37be8' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

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

Response examples (400)

{
  "errors": [
    {
      "type": "parameter_invalid",
      "field": "filter",
      "message": "must be an object"
    }
  ]
}

Response examples (401)

{
  "errors": [
    {
      "type": "unauthorized"
    }
  ]
}

Response examples (429)

{
  "errors": [
    {
      "type": "rate_limit_exceeded"
    }
  ]
}