Sessions
1. Sessions Tab
1.1 Introduction
The Sessions tab is a vital tool that offers in-depth information and analysis about an individual user's sleep session. Within this tab, one can effortlessly browse specific data related to a single sleep session of a user. This is especially handy for experts and CS teams, as it allows them to meticulously comprehend the results of a user's sleep analysis and swiftly grasp the necessary details for troubleshooting.
Such session-specific insights prove to be invaluable when conducting CS tasks, especially when addressing user issues or responding to particular user queries. This is due to the ease with which one can compare and analyze a user's sleep patterns, anomalies, and events on a session-by-session basis.
Furthermore, the Sessions tab facilitates the rapid identification of any issues or abnormalities concerning a user. This empowers the team to devise appropriate response strategies. A thorough analysis of this data significantly contributes to improving service quality and enhancing user satisfaction, supporting effective CS activities.
![Sessions 탭](https://files.readme.io/49d1bc3-Asleep_Docs_Image_-_Sessions_32.jpg)
Sessions Tab
1.2 Session Search
By searching for a user's Session ID, one can view that particular user's sleep trends.
![Session 검색 기능](https://files.readme.io/a611a7d-Asleep_Docs_Image_-_Sessions_22.jpg)
Session Search
1.3 Filters
Utilizing the filters below, you can pinpoint and examine user data based on your specific criteria.
- API Key: For those using multiple API Keys, you can either consolidate data for viewing or inspect them separately.
- Date: Choose the period for which you want to view the sessions.
- Status: You can select the status of the session you wish to view.
- Open: Refers to sessions where sleep measurement is still ongoing.
- Closed: Indicates sessions that have ended, and the analysis of sleep audio is underway.
- Completed: Pertains to sessions that have concluded or where the sleep analysis is complete.
- Environment: You can distinguish and view sessions from the Test environment and the Live environment separately.
- Start Time: Sessions are sorted based on their creation date. You can choose either the most recent or the oldest.
![Session 테이블 필](https://files.readme.io/e5fcd57-Asleep_Docs_Image_-_Sessions_24.jpg)
Session Filters
1.4 Time Zone
You can modify the time zone applied to the dashboard. Currently, two time zones, Seoul and UTC, are supported.
![대시보드 시간대 설](https://files.readme.io/2964b28-Asleep_Docs_Image_-_Sessions_23.jpg)
Dashboard Timezone
3. Session Detailed Chart Page
3.1 Meta Data
This section displays fundamental information about the session.
You can find detailed information for each item on the Data API - Get Single Session page.
- Session ID: A unique identifier for the sleep session.
- User ID: The ID of the user who initiated this session.
- Status (Stat): The current status of the session.
- OPEN: An in-progress session, with audio uploads available
- CLOSED: The session terminated by sending an end session request. Unable to upload audio files. Analysis of uploaded sleep audio is still in progress
- COMPLETE: All sleep analysis completed after the end of the session
- Service: The service parameter used by the user when invoking the session creation API.
- Start time: Displays the start time of the sleep session.
- End time: Indicates when the sleep session concluded.
- Unexpected end time: The time recorded when a user sets the unexpected flag to 1 in the session ending API.
- API Key: The API key employed to create this session.
- User agent: Information about the client that initiated the session, often including details like the web browser or application version.
- Peculiarities: Indicates the unique status of the session.
- IN_PROGRESS: If the session is OPEN, CLOSED
- NEVER_SLEPT: If it is determined that there was no sleep at all during the session measurement time
- TOO_SHORT_FOR_ANALYSIS: When the measurement time is too short to conduct a valid analysis
- TOO_LONG_FOR_ANALYSIS: Analysis has been conducted successfully, but the session measurement time is excessively long, making it difficult to trust
- TOO_MANY_DEFECTS_IN_SLEEP_STAGES: When the error rate is high, resulting in insufficient sleep analysis results.
- NO_BREATHING_STABILITY: When the customer's contract conditions do not support breathing stability analysis.
- NO_REALTIME_POLLING: When, according to the customer's contract, real-time access to sleep information is not available.
- Created timezone: This is the timezone in which the session was created.
![Session - Meta Data](https://files.readme.io/46fef52-Asleep_Docs_Image_-_Sessions_25.jpg)
Session - Meta Data
3.2 Sleep Data Table
You can easily glance at the sleep analysis results of the particular session in a table format.
- For a comprehensive explanation of each data point, please refer to Asleep Data Metrics.
![Session - Sleep Data Table](https://files.readme.io/b724bf8-Asleep_Docs_Image_-_Sessions_31.jpg)
Session - Sleep Data Table
3.3 Sleep Stage
3.3.1 Sleep Stage Pattern
This graph illustrates the changes in sleep stages over time.
In the {sleep_stages} list, both the pink Wake and the orange Wake values are set to '0'.
- (Pink) Wake: Represents the sleep_latency, which is the time taken to fall asleep, and the wakeup_latency, the time taken to fully wake up. These durations are not part of the sleep_period and are excluded from the sleep stage ratio calculations.
- (Orange) Wake: Represents arousals that occur during the sleep_period, which spans from the point the user falls asleep (sleep_time) to the last waking moment (wake_time). Arousals within this period might be perceived by the user or might go unnoticed.
- REM: Indicates REM sleep phases.
- Light: Stands for Light sleep phases.
- Deep: Refers to Deep sleep phases.
![Session - Sleep Stage Patten](https://files.readme.io/2d8e408-Asleep_Docs_Image_-_Sessions_27.jpg)
Session - Sleep Stage Patten
- The Y-axis represents the sleep stages, while the X-axis indicates time.
- For convenience, the Sleep Latency and Wake Latency values are included under the Wake phase.
3.3.2 Sleep Stage Ratio
This displays the proportion of each sleep phase:
- Wake: Represents the percentage of time awake amidst the sleep phases.
- REM: Indicates the proportion of REM sleep.
- Light: Shows the proportion of Light sleep.
- Deep: Demonstrates the proportion of Deep sleep.
![Session - Sleep Stage Ratio](https://files.readme.io/cdf4da1-Asleep_Docs_Image_-_Sessions_18.jpg)
Session - Sleep Stage Ratio
- The X-axis represents the percentage.
The Wake in this graph doesn't include the Sleep Latency and Wake Latency durations.
If a session registers no sleep, this chart will not be displayed.
3.4 Breathing Stability
3.4.1 Breathing Stability Pattern
This chart visualizes the transitions in breathing conditions over time:
- Label: Represents levels of breathing instability
- Stable Breath
- Mildly Stable Breath
- Moderately Stable Breath
- Severely Stable Breath
- Unstable: Marks intervals when breathing was unstable.
- Stable: Highlights periods of stable breathing.
![Session - Breathing Stability Pattern](https://files.readme.io/596cca4-Asleep_Docs_Image_-_Sessions_29.jpg)
Session - Breathing Stability Pattern
- The Y-axis signifies the breathing conditions, and the X-axis denotes time.
3.4.2 Breathing Stability Ratio
This showcases the ratio of breathing conditions during sleep:
- Unstable: Indicates the proportion of time with unstable breathing amidst sleep.
- Stable: Represents the proportion of time with stable breathing during sleep.
![Session - Breathing Stability Ratio](https://files.readme.io/e03b7f1-Asleep_Docs_Image_-_Sessions_30.jpg)
Session - Breathing Stability Ratio
- The Y-axis stands for the breathing conditions, and the X-axis displays time.
- For sessions registering no sleep, this chart will not be visible.
Updated 10 months ago