Sleep Cycle
Summary
Sleep
Sleep Cycle
Meal
Workouts
Profile
Activity
Body
Menstrual Cycle
Electrocardiogram
Vitals Timeseries
- GETAfib Burden
- GETBlood Oxygen
- GETBlood Pressure
- GETCholesterol
- GETGlucose
- GETHeart Rate
- GETHeart Rate Variability
- GETHeart Rate Alert
- GETInsulin Injection
- GETIgg
- GETIge
- GETRespiratory Rate
- GETVo2 Max
- GETForced Expiratory Volume 1
- GETForced Vital Capacity
- GETPeak Expiratory Flow Rate
- GETInhaler Usage
- GETHeart Rate Recovery One Minute
Body Timeseries
Activity Timeseries
Workout Stream Timeseries
Wellness Timeseries
Diary Timeseries
Nutrition Timeseries
Sleep Cycle
Summary
Get sleep cycle for user_id
GET
/
v2
/
summary
/
sleep_cycle
/
{user_id}
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep_cycle/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"sleep_cycle": [
{
"created_at": "2023-02-27T20:31:24+00:00",
"id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
"session_end": "2022-01-01T08:00:00",
"session_start": "2022-01-01T00:00:00",
"sleep_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
"source": {
"provider": "oura",
"type": "ring"
},
"source_provider": "oura",
"source_type": "ring",
"stage_end_offset_second": [
300,
600,
900,
1200
],
"stage_start_offset_second": [
0,
300,
600,
900
],
"stage_type": [
1,
2,
3,
1
],
"time_zone": "America/Los_Angeles",
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b"
}
]
}
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep_cycle/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
Start date in YYYY-MM-DD
End date (inclusive) in YYYY-MM-DD
Provider oura/strava etc
Response
200
application/json
Successful Response
The response is of type object
.
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep_cycle/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"sleep_cycle": [
{
"created_at": "2023-02-27T20:31:24+00:00",
"id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
"session_end": "2022-01-01T08:00:00",
"session_start": "2022-01-01T00:00:00",
"sleep_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
"source": {
"provider": "oura",
"type": "ring"
},
"source_provider": "oura",
"source_type": "ring",
"stage_end_offset_second": [
300,
600,
900,
1200
],
"stage_start_offset_second": [
0,
300,
600,
900
],
"stage_type": [
1,
2,
3,
1
],
"time_zone": "America/Los_Angeles",
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b"
}
]
}