Key Concepts
🙋♀️ User
User is defined as a specific person you’d like to record sleep. You can use the SDK or API to generate a user uuid that you want to record your sleep. This allows you to manage sleep sessions on a per-user basis.
🛌 Sleep Session
A sleep session is a concept that corresponds to one’s sleep(lying in bed until waking up). You can create a sleep session for a specific user, upload the data you want to analyze, and end the session.
The session has a total of three states: OPEN, CLOSED, and COMPLETE.
- OPEN: Session has been created and audio data can be uploaded for analysis
- CLOSED: No more audio can be uploaded at the end of the session, waiting for the analysis to complete
- COMPLETE: All analysis is completed
📇 Mel Spectrogram
Audio data measured on a smartphone or smart device is converted to the form of a Mel spectrogram through the SDK's preprocessing algorithm and sent to the server.
Mel Spectrogram
📊 Data Metrics
Asleep Data Visualization
| No. | Data Name | Definition | Type | Value | Example |
|---|---|---|---|---|---|
| 1 | start_time | When sleep measurement began | string | YYYY-MM-DDThh:mm:ss | 2022-08-01T00:00:00+09:00 |
| 2 | end_time | When the sleep measurement ended | string | YYYY-MM-DDThh:mm:ss | 2022-08-01T08:00:17+09:00 |
| 3 | sleep_time | The time you started falling asleep | string | YYYY-MM-DDThh:mm:ss | 2022-08-01T00:30:00+09:00 |
| 4 | wake_time | time you woke up | string | YYYY-MM-DDThh:mm:ss | 2022-08-01T07:30:00+09:00 |
| 5 | sleep_latency | The time it takes to fall asleep after the start of sleep measurement | int | seconds | 1800 |
| 6 | wakeup_latency | The time it takes to wake up and end your sleep measurement | int | seconds | 1800 |
| 7 | sleep_efficiency | The percentage of time you actually slept during sleep measurement | float | 0 or greater than 0; 1 or less than 1 | 0.84 |
| 8 | time_in_bed | The time from the start of the sleep measurement to the end of the sleep measurement | int | seconds | 28800 |
| 9 | time_in_sleep_period | During sleep measurement time, excluding the time it took from the start of the sleep measurement to fall asleep and the time it took from the wake to the end of the sleep measurement(time_in_bed-sleep_latency-wakeup_latency) | int | seconds | 27000 |
| 10 | time_in_sleep | During sleep measurement time, the time you were actually sleeping is divided into three stages: deep, light, and rem | int | seconds | 24300 |
| 11 | time_in_wake | Wake during sleep | int | seconds | 2700 |
| 12 | time_in_rem | Total time the sleep stage progressed to REM | int | seconds | 13500 |
| 13 | time_in_light | Total time the sleep stage progressed to Light | int | seconds | 5400 |
| 14 | time_in_deep | Total time the sleep stage progressed to Deep | int | seconds | 5400 |
| 15 | sleep_ratio | The percentage of time you sleep without waking up during the sleep stage | float | 0 or greater than 0; 1 or less than 1 | 0.9 |
| 16 | wake_ratio | Rate of wake in the middle during sleep stage | float | 0 or greater than 0; 1 or less than 1 | 0.1 |
| 17 | rem_ratio | Rate of REM sleep during sleep stage | float | 0 or greater than 0; 1 or less than 1 | 0.5 |
| 18 | light_ratio | Rate of Light sleep during sleep stage | float | 0 or greater than 0; 1 or less than 1 | 0.2 |
| 19 | deep_ratio | Rate of deep sleep during sleep stage | float | 0 or greater than 0; 1 or less than 1 | 0.2 |
| 20 | time_in_unstable_breath | Total time of breath instability | int | seconds | 2700 |
| 21 | time_in_stable_breath | Total time in the breathing stable section | int | seconds | 24300 |
| 22 | unstable_breath_ratio | The percentage of time during the sleep stage that there was a breathing instability section | float | 0 or greater than 0; 1 or less than 1 | 0.1 |
| 23 | stable_breath_ratio | The percentage of time that was a breathing stable section during the sleep stage | float | 0 or greater than 0; 1 or less than 1 | 0.9 |
| 24 | estimated_ahi | Values for determining respiratory instability levels | float | 29.71 | |
| 25 | breathing_pattern | Stages of breathing stability | string | enum - STABLE - VERY_STABLE - UNSTABLE - VERY_UNSTABLE | STABLE |
| 26 | sleep_stages | List of sleep stages | int | <2 stages> - -1: error - 0: wake - 1: sleep <4 stages> - -1: error - 0: wake - 1: light sleep - 2: deep sleep - 3: REM sleep | 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 |
| 27 | osa_stages | List of breathing stability | int | -1: error - 0: stable - 1: unstable | 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 |
Medical Device Regulation Notice
Using terms like sleep apnea, apnea, hypopnea, AHI, on service and marketing materials could violate medical device regulations. To ensure compliance, we label it as 'Breathing Stability' at Asleep products.
Updated 11 months ago