Vital home pagelight logo
Sleep
Summary
GET

/v2/summary/sleep/{user_id}

x-vital-api-key*
curl --request GET \
  --url https://api.tryvital.io/v2/summary/sleep/{user_id} \
  --header 'x-vital-api-key: <x-vital-api-key>'
curl --request GET \
     --url {{BASE_URL}}/v2/summary/sleep/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

{
  "sleep": [
    {
      "id": "6f9d156f-a497-47b2-b940-d13771c7c937",
      "calendar_date": "2022-08-04",
      "bedtime_start": "2022-08-04T12:42:45.724597+00:00",
      "bedtime_stop": "2022-08-04T12:42:45.724600+00:00",
      "timezone_offset": 2400,
      "duration": 28800,
      "total": 28800,
      "awake": 2400,
      "light": 2400,
      "rem": 2400,
      "deep": 2400,
      "hr_lowest": 43,
      "hr_average": 50,
      "efficiency": 0.97,
      "latency": 1000,
      "temperature_delta": -0.2,
      "average_hrv": 78,
      "respiratory_rate": 14,
      "source": {
        "name": "Oura",
        "slug": "oura",
        "logo": "https://logo_url.com"
      },
      "user_id": "1ede2505-5ba1-41d2-a1a5-ed6887198fa4"
    }
  ]
}

​
Path Parameters

user_idrequired
string

User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api.

​
Query Parameters

providerDefault: ""
string

Provider oura/strava etc

start_daterequired
string

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

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

sleeprequired
array