WIwithings
sleep

Sleep v2 - Get

Returns sleep data captured at high frequency, including sleep stages.<br/><br/> Notes If your input startdate and enddate are separated by more than 24h, only the first 24h after startdate will be returned.<br/><br/> IMPORTANT: Please refer to this page to check the availability of metrics based on the sleep tracking device used. Some data types are regulated in the EU and US and may not be available in your region.

posthttps://wbsapi.withings.net/v2/sleep

Request

  • Base URL
    https://wbsapi.withings.net
  • Auth
    none declared. Required headers: Authorization

Query parameters

actionstring required

Service action name. Must take the string value get.

startdateinteger required

Data start date as a unix timestamp.

enddateinteger required

Data end date as a unix timestamp.

data_fieldsstring

List of requested data fields, separated by a comma.<br>Available data fields are listed below.<br><u>Ex</u>: data_fields=hr,rr,snoring<br><br>hr<br>> Heart Rate (beats per minute). <br><br>rr<br>> Respiration Rate (breaths per minute). <br><br>snoring<br>> Total snoring time (seconds).<br><br>sdnn_1<br>> Heart rate variability - Standard deviation of the NN over 1 minute (in miliseconds).<br><br>rmssd<br>> Heart rate variability - Root mean square of the successive differences over "a few seconds" (in miliseconds).<br><br>hrv_quality<br>> Heart rate variability - quality score.<br><br>mvt_score<br>> Track the intensity of movement in bed on a minute-by-minute basis. The score ranges from 0 to 255, representing the intensity of movement. This metric is only available for Sleep Analyzer devices in the EU and prescription-based devices in the US (Sleep Rx).<br><br>chest_movement_rate<br>> Chest movement rate (events per minute). <br><br>withings_index<br>> Withings Sleep Rx (FDA Cleared) allows to estimate gaps in breathing sounds and to generate an index. This index corresponds to the number of breathing events per hour.

<table><thead><tr><td>Value</td><td>Description</td></tr></thead><tbody><tr><td>0-15 (events per hour on average)</td><td>No/Mild</td></tr><tr><td>15-30 (events per hour on average)</td><td>Moderate</td></tr><tr><td>> 30 (events per hour on average)</td><td>Severe</td></tr></tbody></table>

Note: 5 hours of sleep are required in order to calculate the Withings Index.<br><br>breathing_sounds<br>> Total time when breathing sounds were tracked. (seconds) <br><br>

meastypesunknown

List of requested measure types (separated by a comma).<br>Ex: meastypes=1,4,12

Headers

Authorizationstring required

Used to pass your access token. Must take value: Bearer {your access_token} Replace {your access_token} with the access_token

Response

(Click to unfold)

statusinteger

Response status. See <a href='#tag/response_status'>Status</a> section for details.

Example response

{
  "body": {
    "model": 32,
    "series": {
      "startdate": 1594159200,
      "enddate": 1594202400,
      "state": 1,
      "model": "Aura Sensor V2",
      "model_id": 63
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.