VIvisible
Data Points

List Data Points

Changed on

Returns a paginated collection of data points for one or more metrics. Each data point stores a metric value for a reporting period. The date is always an ISO 8601 calendar date and represents the start of that period. For investor portfolio metrics using fiscal periods, interpret date using the portfolio company's fiscal_year_end_month.

get/data_points

Request

  • Base URL
    https://api.visible.vc
  • URL
    https://api.visible.vc/data_points
  • Auth
    HTTP bearer

Query parameters

string uuid required
OR
string[] required

ID of a metric or an array of metric IDs

pageinteger

Page number

page_sizeinteger

Number of data points per page (between 1 and 100)

start_datestring date

Beginning of date range (ISO 8601 date)

end_datestring date

End of date range (ISO 8601 date)

exclude_blank'true' | 'false'

When set to 'true', excludes data points without a value

include_source'true' | 'false'

Experimental. When set to 'true', includes a source object on each data point derived from its latest changelog version.

Response

Successfully retrieved data points

Example response

{
  "data_points": [
    {
      "id": "ec5252fe-9abc-4096-85e9-1374e70a3182",
      "date": "2021-02-01",
      "value": "100.99",
      "metric_id": "cad09a10-73e8-4205-ae67-4e6156f37be8"
    }
  ],
  "meta": {
    "total": 2,
    "total_pages": 1,
    "page": 1
  }
}

Changes

  • d63a3bb6d361Revision changes
    • info

      added the new optional query request parameter include_source

    • info

      added the optional property // to the response with the status