📘

Summary:

addition of new sleep data, new statistics api, 'unexpected_end_time' field, update of dashboard session page sleep data table, added guidelines for sleep measurement on android

Hello, this is Asleep.

We are pleased to inform you about our latest update, which includes addition of new sleep data, new statistics api, 'unexpected_end_time' field, update of dashboard session page sleep data table, added guidelines for sleep measurement on android. For more details, please see below!

✨ New & Updated

🔹API

1. New Sleep Data Including Wake Counts, Sleep Cycles, and More!

8 new sleep data metrics have been added to the V3 Data API!
Utilize these new metrics to provide richer sleep analysis results.

These data metrics, introduced on 2023/10/31, can be viewed in V3 Data API responses and the dashboard.

• Check the Key Concepts - Data Metrics
• Check the Get Single Session - Stat Object

[⭐️Note⭐️]
The term 'WASO' stands for 'Wake after sleep onset'. It refers to awakenings after the onset of sleep. In Asleep data, it signifies periods with a value of 0 in the sleep_stages list between sleep_time and wake_time.

[New Data]

1. waso_count:
   Refers to the number of times wake occurred during sleep.
   Continuous wake counts as one occurrence.
   A higher wake count can indicate poorer sleep quality.
   1. Example: 8(times)
2. longest_waso:
   Denotes the longest duration of wake during sleep.
   Data is provided in seconds, and it's recommended to use the data in minutes.
   1. Example: 180(seconds)
3. rem_latency:
   Refers to the time from the beginning of sleep until the onset of REM sleep.
   Data is provided in seconds, and it's recommended to use the data in minutes.
   1. Example: 5400(seconds)
4. deep_latency:
   Indicates the time taken from sleep onset to the onset of deep sleep.
   Data is provided in seconds, and it's recommended to use the data in minutes.
   1. Example: 1800(seconds)
5. light_latency:
   Refers to the time from sleep onset until the light sleep stage begins. As the initial phase of a typical sleep session is light sleep, the light_latency data value is typically 0.
   Data is provided in seconds, and it's recommended to use the data in minutes.
   1. Example: 0(seconds)
6. unstable_breath_count:
   Indicates the number of times unstable breathing occurred during sleep.
   Continuous unstable breath instances count as one occurrence.
   1. Example: 32(times)
7. [Beta] sleep_cycle:
   Represents the average duration of a single sleep cycle. A sleep cycle refers to the repetitive pattern of various sleep stages throughout the night. On average, one cycle lasts about 90-120 minutes, consisting of Non-REM and REM sleep.
   1. Example: 6000(seconds)
   2. sleep_cycle is a beta feature. Conditions might change during its beta phase.
8. [Beta] sleep_cycle_count:
   Indicates the number of sleep cycles experienced in one night.
   On average, an individual goes through 4-6 sleep cycles per night.
   1. Example: 5(times)

2. New Statistics API: Simplifying Retrieval of Average Data and Multi-Day Session Information!

Looking to provide your users with average sleep data over a week/month or reports spanning multiple days? The newly released statistics API makes using average data and multi-day reports even more convenient!

Discover the various features and example responses of the new API!

• Check out the Get User's Average Stats

[API Features]

1. Get Average data: Set your desired period to obtain the average of Slept Sessions (sessions where sleep occurred) within that timeframe. You can query up to 100 days.
2. Get Never Slept Session List: Easily view sessions within the query period where no sleep occurred.
3. Get Slept Session Data: Conveniently view Slept Session Objects.

3. New Addition of 'unexpected_end_time' Field

In the Data API V3, the unexpected_end_time field has been introduced. This field indicates the time when a session ended unexpectedly. If this value is null, it means the session ended normally. Conversely, if there's a value, it indicates an unexpected session termination. Sessions that end unexpectedly can be classified as valid or invalid sessions based on peculiarities.

Potential reasons for an unexpected session end could be internet connectivity issues, app crashes, among other factors.

This feature was updated on October 25, 2023.

• Check the Get Single Session - Session Object
• View the List Multiple Sessions - Sleep Session Object

🔹Dashboard

1. Session Page Sleep Data Table Update

Updates to the Sleep Data Table on the Session page now allow users to see newly added sleep information and data that was previously only available through API responses.

This data will be sequentially updated in the Users and Analysis tabs of the dashboard.

1. Data previously available only through the API:
   time_in_sleep_period, sleep_ratio, breathing_index
2. New Data:
   waso_count, longest_waso, rem_latency, deep_latency, light_latency, unstable_breath_count,
3. Beta Open Data:
   sleep_cycle, sleep_cycle_count

• Check the Dashboard - Sessions

🔹SDK

1. Added Guidelines for Sleep Measurement on Android

When using a sleep monitoring app with the Android SDK, the sleep measurement will not function properly if another recording/video recording app is running simultaneously. Guidelines regarding this condition have been added, and you can find the details on the following page.

• Check the Android SDK - Get Started

🔹User Guide & Guideline

1. Introduction about Sleep - Updated Explanation of Sleep Cycle

An introduction to the newly launched beta feature, Sleep Cycle, has been added.
Find out what the Sleep Cycle means and its significance!

• View the Introduction about Sleep - Sleep Cycle

2. Addition of Sleep Environment Guideline

When using a sleep monitoring app with the Android SDK, the sleep measurement won't work correctly if another recording/video recording app is operating at the same time. Guidelines concerning this situation have been provided, and more details can be found on the page below.

• Check the Sleep Environment Guideline

If you need further explanations on any part of the document or have any inquiries about Asleep, please feel free to contact us. We are committed to continuously striving for your convenience as we move forward as Asleep.

For technical/development inquiries: contact [email protected] or post your questions on [Q&A page]

For business/partnership inquiries: Ask Asleep Business Experts

Thank you.