Skip to main content
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": {
        "device_id": "550e8400-e29b-41d4-a716-446655440000",
        "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

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
user_id
string<uuid>
required

Query Parameters

​
start_date
string<date>
required

Start date in YYYY-MM-DD

​
end_date
string<date> | null

End date (inclusive) in YYYY-MM-DD

​
provider
string
default:""

Provider oura/strava etc

Response

Successful Response

​
sleep_cycle
Sleep Cycle · object[]
required