Sleep Breathing Disturbance

Retrieve breathing disturbances detected during sleep for a user from connected wearables and health providers using the Junction timeseries API.

GET /v2/timeseries/{user_id}/sleep_breathing_disturbance/grouped

cURL

curl --request GET \
     --url {{BASE_URL}}/v2/timeseries/{user_id}/sleep_breathing_disturbance/grouped?start_date={{START_DATE}}&end_date={{END_DATE}} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

Example

{
  "groups": {
    "oura": [
      {
        "data": [
          {
            "end": "2023-02-13T14:57:24+00:00",
            "start": "2023-02-13T14:30:52+00:00",
            "timestamp": "2023-02-13T14:30:52+00:00",
            "type": "elevated",
            "unit": "count",
            "value": 12
          }
        ],
        "source": {
          "provider": "oura",
          "type": "ring"
        }
      }
    ]
  }
}

View Full Response Schema »

The Response section on the page still needs work. Click here to check out the complete schema.

cURL

curl --request GET \
     --url {{BASE_URL}}/v2/timeseries/{user_id}/sleep_breathing_disturbance/grouped?start_date={{START_DATE}}&end_date={{END_DATE}} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

Example

{
  "groups": {
    "oura": [
      {
        "data": [
          {
            "end": "2023-02-13T14:57:24+00:00",
            "start": "2023-02-13T14:30:52+00:00",
            "timestamp": "2023-02-13T14:30:52+00:00",
            "type": "elevated",
            "unit": "count",
            "value": 12
          }
        ],
        "source": {
          "provider": "oura",
          "type": "ring"
        }
      }
    ]
  }
}

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Path Parameters

user_id · string<uuid> · required

Query Parameters

cursor · string | null · deprecated

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

next_cursor · string | null

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

provider · string · default: ""

Provider oura/strava etc

start_date · string · 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

end_date · string | null

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

200

application/json

Successful Response

groups · Groups · object · required

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

Show child attributes

next · string | null · deprecated

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

next_cursor · string | null

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