sleep

Sleep v2 - Getsummary

Returns sleep activity summaries, which are an aggregation of all the data captured at high frequency during the sleep activity. Use the Sleep v2 - Get service to get the high frequency data used to build these summaries. 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 getsummary.

startdateymdstring required

DO NOT USE WITH FOLLOWING PARAMS: [lastupdate] Start date. Required if no lastupdate.

enddateymdstring required

DO NOT USE WITH FOLLOWING PARAMS: [lastupdate] End date. Required if startdateymd is provided.

lastupdateinteger required

DO NOT USE WITH FOLLOWING PARAMS: [startdateymd, enddateymd] Timestamp for requesting data that were updated or created after this date. Useful for data synchronization between systems. Use this instead of startdateymd + enddateymd.

data_fieldsstring

List of requested data fields, separated by a comma. Available data fields are listed below. Ex: data_fields=total_timeinbed,total_sleep_time,asleepduration Standard sleep medicine metrics total_timeinbed > Total time spent in bed (seconds). total_sleep_time > Total time spent asleep. Sum of light, deep and rem durations (seconds). asleepduration > Duration of sleep when night comes from external source (seconds). Light, Deep and Rem sleep durations are null in this case. lightsleepduration > Duration in state light sleep (seconds). remsleepduration > Duration in state REM sleep (seconds). deepsleepduration > Duration in state deep sleep (seconds). sleep_efficiency > Ratio of the total sleep time over the time spent in bed. sleep_latency > Time spent in bed before falling asleep (seconds). wakeup_latency > Time spent in bed after waking up (seconds). wakeupduration > Time spent awake (seconds). wakeupcount > Number of times the user woke up while in bed. Does not include the number of times the user got out of bed. waso > Time spent awake in bed after falling asleep for the 1st time during the night (seconds). nb_rem_episodes > Count of the REM sleep phases. Sleep apnea and breathing disturbances breathing_disturbances_intensity > Intensity of <a href='/api-reference/#section/Glossary'>breathing disturbances</a>. Available for all Sleep and Sleep Analyzer devices (wellness metric). apnea_hypopnea_index > Medical grade AHI. Average number of hypopnea and apnea episodes per hour, that occured during sleep time. Only available for devices purchased in Europe and Australia, with the sleep apnea detection feature activated. withings_index > 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. Other sleep datapoints and vitals durationtosleep > Time to sleep (seconds). (deprecated) durationtowakeup > Time to wake up (seconds). (deprecated) out_of_bed_count > Number of times the user got out of bed during the night. hr_average > Average heart rate. (beats per minute). hr_min > Minimal heart rate (beats per minute). hr_max > Maximal heart rate (beats per minute).. rr_average > Average respiration rate (breaths per minute). rr_min > Minimal respiration rate (breaths per minute). rr_max > Maximal respiration rate (breaths per minute). breathing_quality_assessment > Intensity of <a href='/api-reference/#section/Glossary'>breathing disturbances</a>. Available for all Sleep and Sleep Analyzer devices (wellness metric). snoring > Total snoring time (seconds). snoringepisodecount > Numbers of snoring episodes of at least one minute. sleep_score > Sleep score night_events > Summary of sleep events that happened during the sleep activity.

It is structured as a dictionary, where keys are the type of event, and the value is an array of time offsets in seconds.

Within each array, the first offset is counted from the activity startdate, and every following offset is counted from the previous event of the same type. To obtain absolute timestamps, accumulate the offsets of each array separately, starting from startdate.

For example, with a startdate of 1758000000, "4":[4860,11640] describes two events: the first at 1758004860, the second at 1758016500 (4860 + 11640 = 16500 seconds after startdate).

Types of events can be one of the following :

<table><thead><tr><td>Value</td><td>Description</td></tr></thead><tbody><tr><td>1</td><td>got in bed</td></tr><tr><td>2</td><td>fell asleep</td></tr><tr><td>3</td><td>woke up</td></tr><tr><td>4</td><td>got out of bed</td></tr><tr><td>5</td><td>start of asleep period that was manually input</td></tr><tr><td>6</td><td>start of awake period that was manually input</td></tr></tbody></table>

mvt_score_avg > Track the average movement score in bed throughout the night. 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). mvt_active_duration > Track the duration (in seconds) of movement in bed. Only available for Sleep Analyzer devices (EU) and devices under prescriptions in the US (Sleep Rx) rmssd_start_avg > Heart rate variability - Start average rmssd_end_avg > Heart rate variability - End average chest_movement_rate_wellness_average > Average respiration rate (breaths per minute). chest_movement_rate_wellness_min > Minimal respiration rate (breaths per minute). chest_movement_rate_wellness_max > Maximal respiration rate (breaths per minute). breathing_sounds > Total time when breathing sounds were tracked. (seconds) breathing_sounds_episode_count > Numbers of breathing sounds episodes of at least one minute. chest_movement_rate_average > Average chest movement rate (events per minute). chest_movement_rate_min > Minimal chest movement rate (events per minute). chest_movement_rate_max > Maximal chest movement rate (events per minute). core_body_temperature_min > Minimal core body temperature (in celsius degrees). core_body_temperature_max > Maximal core body temperature (in celsius degrees). core_body_temperature_avg > Average core body temperature (in celsius degrees). core_body_temperature_status > Status of the temperature. (Use 'data_fields' to request this data) Value can be: 'unknown', 'usual' or 'elevated'.

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": {
    "series": [
      {
        "id": 12345,
        "timezone": "Europe/Paris",
        "model": 16,
        "model_id": 51,
        "startdate": 1594245600,
        "enddate": 1594257200,
        "date": "2020-07-09",
        "created": 1594257200,
        "modified": 1594257200,
        "hash_deviceid": "892359876fd8805ac45bab078c4828692f0276b1",
        "completed": true
      }
    ]
  }
}

Changes

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