Sign in

v71

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-032076961.5 MB
timeseries

Cholesterol

get/v2/timeseries/{user_id}/cholesterol/grouped

Path parameters

user_idstring uuid required

Query parameters

cursorstring nullable

The cursor for fetching the next page, or null to fetch the first page.

The cursor for fetching the next page, or null to fetch the first page.

next_cursorstring nullable

The cursor for fetching the next page, or null to fetch the first page.

The cursor for fetching the next page, or null to fetch the first page.

providerstring

Provider oura/strava etc

Provider oura/strava etc

start_datestring required

Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

end_datestring nullable

Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59

Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59

Response

Successful Response

groupsobject required

For each matching provider or lab, a list of grouped timeseries values.

nextstring nullable

The cursor for fetching the next page, or null if there is no more data.

next_cursorstring nullable

The cursor for fetching the next page, or null if there is no more data.

Example response

{
  "groups": {
    "oura": [
      {
        "data": [
          {
            "timestamp": "2023-02-13T14:30:52+00:00",
            "type": "cholesterol/ldl",
            "unit": "mmol/L",
            "value": 0.6
          },
          {
            "timestamp": "2023-02-13T14:30:52+00:00",
            "type": "cholesterol/hdl",
            "unit": "mmol/L",
            "value": 0.2
          },
          {
            "timestamp": "2023-02-13T14:30:52+00:00",
            "type": "cholesterol/total",
            "unit": "mmol/L",
            "value": 0.7
          },
          {
            "timestamp": "2023-02-13T14:30:52+00:00",
            "type": "cholesterol/triglycerides",
            "unit": "mmol/L",
            "value": 0.7
          }
        ],
        "source": {
          "provider": "oura",
          "type": "ring"
        }
      }
    ]
  }
}