List Data Points

GET /data_points
Bearer auth

Returns a paginated collection of data points for a metric. Data points store the actual value of a metric for each time period.

Query parameters

  • metric_id string(uuid) | array[string(uuid)] Required

    ID of a metric or an array of metric IDs

  • page integer

    Page number

    Minimum value is 1. Default value is 1.

  • page_size integer

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

    Minimum value is 1, maximum value is 100. Default value is 25.

  • start_date string(date)

    Beginning of date range (ISO 8601 date)

  • end_date string(date)

    End of date range (ISO 8601 date)

  • exclude_blank string

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

    Values are true or false. Default value is false.

Responses

  • 200 application/json

    Successfully retrieved data points

    Hide response attributes Show response attributes object
    • data_points array[object]
      Hide data_points attributes Show data_points attributes object
      • id string(uuid) Required

        Unique identifier for the data point

      • date string(date) Required

        Date for this data point (ISO 8601 format)

      • value string Required

        Value of the metric for this date (stored as string for precision)

      • metric_id string(uuid) Required

        ID of the associated metric

    • 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 /data_points 
curl \
 --request GET 'https://api.visible.vc/data_points?metric_id=cad09a10-73e8-4205-ae67-4e6156f37be8' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "meta": {
    "page": 1,
    "total": 2,
    "total_pages": 1
  },
  "data_points": [
    {
      "id": "ec5252fe-9abc-4096-85e9-1374e70a3182",
      "date": "2021-02-01",
      "value": "100.99",
      "metric_id": "cad09a10-73e8-4205-ae67-4e6156f37be8"
    },
    {
      "id": "56a1bed4-9ac4-4bd1-8533-077f3ae465c3",
      "date": "2021-01-01",
      "value": "100000.00",
      "metric_id": "cad09a10-73e8-4205-ae67-4e6156f37be8"
    }
  ]
}
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"
    }
  ]
}