Additional information can be found in the Withings API Documentation.
Please consult this document first, then contact us, if there are any unkown variables that are not outlined below. Also note, all metrics may not be present in each dataset as additional variables have been introduced by Withings over time.
id: Unique SNAPI.space identifier for each record.participant_id: Unique SNAPI.space identifier for the participant.lab_id: Research identifier assigned to the participant.w_hash_deviceid: Withings identifier for the device used to collect the data.w_id: Withings identifier for sle sleep session.w_model: Withings identifier for the device model used.w_model_id: Another Withings identifier related to the device model.w_created: Timestamp indicating when the record was created.w_enddate: End timestamp of the sleep analysis.w_startdate: Start timestamp of the sleep analysis.w_modified: Timestamp of the most recent modification or data upload.w_date: Date of the sleep analysis, corresponding with enddate.w_timezone: The timezone of the recording, based on the Withings local time/location.w_nb_rem_episodes: Count of the REM sleep phases.w_sleep_efficiency: Ratio of the total sleep time over the time spent in bed.w_sleep_latency: Time spent in bed before falling asleep.w_total_sleep_time: Total time spent asleep. Sum of light, deep and rem durations.w_total_timeinbed: Total time spent in bed.w_wakeup_latency: Time spent in bed after waking up.w_waso: Time spent awake in bed after falling asleep for the 1st time during the night.w_apnea_hypopnea_indexa: Medical grade AHI. Only available for devices purchased in Europe and Australia, with the sleep apnea detection feature activated. Average number of hypopnea and apnea episodes per hour, that occured during sleep time.w_breathing_disturbances_intensitya: Wellness metric, available for all Sleep and Sleep Analyzer devices.0 included to 30 excluded: Low breathing disturbances30 included to 60 excluded: Medium breathing disturbances60: High breathing disturbancesw_asleepduration: Duration of sleep when night comes from external source (light, deep and rem sleep durations are null in this case).w_deepsleepduration: Duration in state deep sleep (in seconds).w_hr_average: Average heart rate.w_hr_max: Maximal heart rate.w_hr_min: Minimal heart rate.w_lightsleepduration: Duration in state light sleep (in seconds).w_mvt_active_durationb: Duration of movement in bed.w_mvt_score_avgb: Movement score average for the full sleep duration.w_night_events: Summary of sleep events that happened during the sleep activity.1: got in bed2: fell asleep3: woke up4: got out of bed5: start of asleep period that was manually input6: start of awake period that was manually inputw_out_of_bed_count: Number of times the user got out of bed during the night.w_remsleepduration: Duration in state REM sleep (in seconds).w_rr_average: Average respiration rate.w_rr_max: Maximal respiration rate.w_rr_min: Minimal respiration rate.w_sleep_score: Proprietary Withings sleep score.w_snoring: Duration of time spent snoring (in seconds).w_snoringepisodecount: Numbers of snoring episodes of at least one minute.w_wakeupcount: Number of times the user woke up while in bed. Does not include the number of times the user got out of bed.w_wakeupduration: Time spent awake (in seconds).state: The sleep.0: Awake1: Light2: Deep3: REM4: Manual5: Unspecifiedhr: Heart rate.rr: Respiration rate.snoring: Precence of snoring (0 = no snoring, 100 = snoring)sdnn_1: Heart rate variability - Standard deviation of the NN over 1 minutermssd: Heart rate variability - Root mean square of the successive differences over "a few seconds"mvt_scoreb: Intensity of movement in bed on a minute-by-minute basis.a: A value of -1 means there was insufficient sleep duration to calculate this metric. 5 hours of total sleep time seems to be the minimum.
b: Only available for EU devices and devices under prescription.