Users
1. Users Tab
1.1 Introduction
In the Users tab, you can view detailed information of individual users, making it useful for analyzing their sleep patterns and trends. Particularly, you can examine a variety of sleep data for each user, such as their sleeping duration, deep sleep stages, and wake-up times. This helps in understanding the sleeping behaviors and habits of specific user groups.
Furthermore, the customer support team can respond more swiftly and accurately to customer inquiries through the Users tab. When a customer raises a query about a particular issue, the team can check the user's pattern in this tab and quickly identify the root cause of the problem. This significantly aids in enhancing customer satisfaction.
The Users tab serves a role beyond just viewing individual user data. By closely examining each user, you can gain key insights into the service, making it an essential tool for providing a better service to users.
![Users 탭](https://files.readme.io/8ca89d5-Asleep_Docs_Image_-_Users_37.jpg)
Users Tab
1.2 User Search
- By searching for the desired user's User ID, you can view that user's sleep trends.
![Users 검색 화면](https://files.readme.io/550e6e8-Asleep_Docs_Image_-_Users_38.jpg)
Users Search
1.3 Filters
You can use the following filters to select and view user data based on your desired criteria.
- API Key: If you are using multiple API Keys, you can either view the combined data of all keys or view them separately.
- Date: You can choose the time period you want to view the users from.
- Environment: You can distinguish and view users from the Test environment and the Live environment.
- Created at: Users are sorted based on their creation date and time. You can select either the most recent or the oldest first.
![Users 테이블 필터](https://files.readme.io/28a629e-Asleep_Docs_Image_-_Users_40.jpg)
Users Filter
1.4 Timezone
You can change the time zone applied to the dashboard. Currently, we support both Seoul and UTC time zones.
![대시보드 시간 설정](https://files.readme.io/a0db694-Asleep_Docs_Image_-_Users_39.jpg)
Dashboard Timezone
3. User Detail Chart Page
3.1 User Information
Basic information about the User is displayed.
- User ID: This is a unique identifier for users within the service.
- API Key: This indicates the API Key from which this User ID was generated.
- Created at: This indicates the date and time when this User ID was created.
![User Information](https://files.readme.io/37f25ce-Asleep_Docs_Image_-_Users_41.jpg)
User Information
- For detailed explanations of each data, you can refer to Asleep Data Metrics.
3.2 Session Information
You can select the session period you want to view and see the list of sessions retrieved.
- Date: You can choose the period you want to query the user. If no adjustment is made, the last month from the current point in time is displayed.
- Custom: You can select and confirm the desired period from the calendar. You can choose dates up to a maximum of one month.
- Period: Refers to the period currently being viewed on the page.
- Sessions: Refers to the number of sessions that exist in the period being queried, and only sessions with a status of Completed are loaded.
- Total: Refers to the total number of Valid and Invalid sessions within the period, and clicking on it links to the session list page.
- Valid: Refers to the number of Valid sessions within the period.
- Invalid: Refers to the number of Invalid sessions within the period.
3.3 Summary of Sleep Analysis
Average
You can view the average values of key sleep data.
- For a detailed description of each data point, refer to [Asleep Data Metrics].
- Sessions where the user did not sleep at all are excluded from the average calculation.
- Data from unused plans is marked with a -.
(Example: If the breathing analysis feature is not used, values in the Unstable breath ratio and Unstable breath count blocks will be marked with a -.) - Hovering the mouse cursor over a block will display a description of what each data point means.
Never Slept Session
List of sessions during the selected period where the user did not sleep at all.
If the user did not sleep at all during the sleep measurement, no other sleep data besides 'time_in_bed' is available, thus these are excluded from all sleep graphs on the User page.
![All Wake up Session List](https://files.readme.io/ef756ab-Asleep_Docs_Image_-_Users_48.jpg)
All Wake up Session List
3.4 Default Sleep Reports
Reports consist of essential and basic sleep data, making it easy to check the trends in sleep metrics.
- To view a specific session in the graph, click on a point in the graph and the session page will open in a new tab.
3.4.1 Sleep Time
- Session Start Time: The time when the measurement started.
- Sleep Time: The time when sleep was first detected after the start of the measurement.
- Wake Time: The start time of the last 'Wake' period, i.e., after 'Awake' was detected and sleep was not detected again.
- Session End Time: The time when the measurement ended.
- The Y-axis represents the absolute time, and the X-axis represents the session.
3.4.2 Sleep Duration
- Time in Wake: The total time of 'Wake' detected during the time in sleep period.
- Time in Sleep: The total time excluding all 'Wake' during the time in bed.
- Time in Bed: The time elapsed from the start to the end of measurement.
- The Y-axis represents time, and the X-axis represents the session.
3.4.3 Sleep Efficiency
- Sleep Efficiency: The ratio of time in sleep to the time in bed.
- The Y-axis represents percentage, and the X-axis represents the session.
3.4.4 Sleep Latency
- Sleep Latency: The time taken for 'Sleep' to be detected after the start of measurement.
- The Y-axis represents minutes, and the X-axis represents the session.
3.4.5 Wake Up Latency
- Wake Up Latency: The time taken for the end of the measurement from the start of the last 'Wake' period.
- The Y-axis represents minutes, and the X-axis represents the session.
3.4.6 Longest WASO
- Longest WASO: The longest 'Wake' duration during the time in sleep period.
- WASO: Wake after sleep onset
- The Y-axis represents minutes, and the X-axis represents the session.
3.4.7 WASO Count
- WASO Count: The number of 'Wake' detected during the time in sleep period.
- WASO: Wake after sleep onset
- The Y-axis represents count, and the X-axis represents the session.
3.5 4 Sleep Stages
Reports consisting of data viewable when using the 4-stage sleep analysis feature.
It shows the trends of 4-stage sleep data.
3.4.1 Sleep Stage Ratio
- Wake: The ratio of 'Awake' time to the time in sleep period.
- REM: The ratio of REM sleep time to the time in sleep period.
- Light: The ratio of light sleep time to the time in sleep period.
- Deep: The ratio of deep sleep time to the time in sleep period.
- The Y-axis represents session, and the X-axis represents percentage.
3.4.2 Sleep Stage Latency
- REM Latency: The time taken for 'REM sleep' to be detected after sleep time.
- Light Latency: The time taken for 'Light sleep' to be detected after sleep time.
- The first detected sleep stage is always 'Light sleep', so 0 is normal.
- Deep Latency: The time taken for 'Deep sleep' to be detected after sleep time.
- The Y-axis represents minutes, and the X-axis represents the session.
3.5.3 Sleep Cycle Beta
Beta
- Sleep Cycle: The average duration of the sleep cycle (alternating periods of 'REM sleep' and 'Non-REM sleep').
- The Y-axis represents minutes, and the X-axis represents the session.
3.5.4 Sleep Cycle Count Beta
Beta
- Sleep Cycle Count: The number of sleep cycles detected during the time in sleep period.
- The Y-axis represents count, and the X-axis represents the session.
3.6 Breath Stages
Reports consisting of data viewable when using the breathing analysis feature.
It shows the trends of breathing stability/instability data.
3.6.1 Breathing Pattern Ratio
- Unstable: The ratio of unstable breathing time to the time in sleep period.
- Stable: The ratio of stable breathing time to the time in sleep period.
- The Y-axis represents session, and the X-axis represents percentage.
3.6.2 Breathing Index
- Breathing Index: An index to indicate the degree of 'Unstable breathing'.
- The Y-axis represents value, and the X-axis represents the session.
3.6.3 Unstable Breath Count
- Unstable Breath Count: The number of 'Unstable breathing' periods detected during the time in sleep period.
- The Y-axis represents count, and the X-axis represents the session.
Updated 9 months ago