Skip to main content
GET
/
api
/
v1
/
users
/
{user_id}
/
summaries
/
sleep
Get Sleep Summary
curl --request GET \
  --url https://api.example.com/api/v1/users/{user_id}/summaries/sleep \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "date": "2023-12-25",
      "source": {
        "provider": "apple_health",
        "device": "Apple Watch Series 9"
      },
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "duration_minutes": 450,
      "time_in_bed_minutes": 480,
      "efficiency_percent": 89.5,
      "stages": {
        "awake_minutes": 123,
        "light_minutes": 123,
        "deep_minutes": 123,
        "rem_minutes": 123
      },
      "interruptions_count": 123,
      "nap_count": 1,
      "nap_duration_minutes": 30,
      "avg_heart_rate_bpm": 123,
      "avg_hrv_sdnn_ms": 123,
      "avg_respiratory_rate": 123,
      "avg_spo2_percent": 123
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0cyI6MTcwNDA2NzIwMH0",
    "previous_cursor": "<string>",
    "total_count": 150
  },
  "metadata": {
    "resolution": "raw",
    "sample_count": 123,
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Open-Wearables-API-Key
string | null

Path Parameters

user_id
string<uuid>
required

Query Parameters

start_date
string
required
end_date
string
required
cursor
string | null
limit
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

data
SleepSummary · object[]
required
pagination
Pagination · object
required
metadata
TimeseriesMetadata · object
required