x-api-key

String

O

API Key

x-user-id

String

O

Issued user id

timezone

String

X

UTC

Change the timezone of the analysis results to the corresponding timezone and return
UTC, Asia/Seoul

timezone

String

Timezone (Timezone List)

peculiarities

List

A field for describing any specific details or peculiarities of the sleep session. This field can include multiple labels below.

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 (currently less than 5 minutes)
TOO_LONG_FOR_ANALYSIS: Analysis has been conducted successfully, but the session measurement time is excessively long, making it difficult to trust (currently exceeding 24 hours)
TOO_MANY_DEFECTS_IN_SLEEP_STAGES: When the error rate is high due to factors like missing audio uploads, 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.

missing_data_ratio

float(0~1 range, decimal points)

The error rate in sleep analysis results due to reasons such as missing audio uploads

session

Session Object

Session Report Information

stat

Stat Object?

Session Report Information

id

String

session id

state

String (OPEN,CLOSED,COMPLETE)

Status of 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

start_time

String (YYYY-MM-DDThh:mm:ss+-hh:mm)

Session start time
Example) 2022-08-01T01:31: 17+09: 00 (If the request timezone is Asia/Seoul)

end_time

String (YYYY-MM-DDThh:mm:ss+-hh:mm)?

Session end time
Example) 2022-08-01T01:31: 17+09: 00 (If the request timezone is Asia/Seoul)

unexpected_end_time

String (YYYY-MM-DDThh:mm:ss+-hh:mm)?

If a session fails to proceed and terminate properly due to app crashes or similar issues, and the client later ends the session with an unexpected parameter set to 1, the time at which this happens is recorded. In this case, the "end_time" is calculated based on the sequence number of the last uploaded audio file. Therefore, if "end_time" is not null, it indicates an abnormal session.

created_timezone

String

Timezone of session creation (Timezone List)

sleep_stages

[Sleep Stages]?

Sleep Stages List

snoring_stages

[Snoring Stages]?

Snoring Stages List

sleep_time

String (YYYY-MM-DDThh:mm:ss+-hh:mm)?

The time it takes to fall asleep after the start of sleep staging

2022-08-01T00:30:00+09:00

wake_time

String (YYYY-MM-DDThh:mm:ss+-hh:mm)?

Wake time

2022-08-01T07:30:00+09:00

sleep_index

Int(50 <= sleep_index <= 100)?

(Beta) Test Operation Sleep Data

87

sleep_latency

Int (seconds)?

Time to fall asleep

1800

wakeup_latency

Int (seconds)?

The time it takes to wake up and end your sleep measurement

1800

light_latency

Int(seconds)?

The time it takes to the first Light after the start of sleep.

deep_latency

Int(seconds)?

The time it takes to the first Deep after the start of sleep.

rem_latency

Int(seconds)?

The time it takes to the first REM after the start of sleep.

time_in_bed

Int (seconds)

The time from the start of the sleep measurement to the end of the sleep measurement

28800

time_in_sleep_period

Int (seconds)

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)

27000

time_in_sleep

Int (seconds)

During sleep measurement time, the time you were actually sleeping
This time is divided into three stages: deep,light,and rem

24300

time_in_wake

Int (seconds)

Wake time during sleep

2700

time_in_light

Int (seconds)?

Total time the sleep phase progressed to light

5400

time_in_deep

Int (seconds)?

Total time the sleep phase progressed to deep

5400

time_in_rem

Int (seconds)?

Total time the sleep phase progressed to rem

13500

time_in_snoring

Int?

Total time of snoring

5400

time_in_no_snoring

Int?

Total time of no snoring

23400

sleep_efficiency

float (0~1 range, decimal points)

The percentage of time you actually slept during sleep measurement

0.84

sleep_ratio

float (0~1 range, decimal points)?

During sleep stage, sleep ratio, not wake

0.9

wake_ratio

float (0~1 range, decimal points)?

Rate of waking time in the middle during sleep phase

0.1

light_ratio

float (0~1 range, decimal points)?

Rate of light sleep during sleep phase

0.2

deep_ratio

float (0~1 range, decimal points)?

Rate of deep sleep during sleep phase

0.2

rem_ratio

float (0~1 range, decimal points)?

rem sleep ratio

0.5

snoring_ratio

float (0~1 range, decimal points)?

The percentage of time during the sleep phase that there was a snoring section

0.3

no_snoring_ratio

float (0~1 range, decimal points)?

The percentage of time during the sleep phase that there was no snoring.

0.7

waso_count

Int?

The number of times 'wake' occurred during the sleep period

10

longest_waso

Int(seconds)?

The duration of the longest 'wake' during the sleep period

300

sleep_cycle_count

Int?

The number of sleep cycles.

4

sleep_cycle

Int(seconds)?

The average duration of one sleep cycle.

6600

sleep_cycle_time

List of String(YYYY-MM-DDThh:mm:ss+-hh:mm)

Transition time for sleep cycles
[First sleep cycle onset time, first sleep cycle end time, second sleep cycle end time, ..., last sleep cycle end time]

["2023-09-05T16:15:00+00:00", "2023-09-05T18:03:00+00:00", "2023-09-05T20:32:30+00:00"]

snoring_count

Int?

The number of times snoring occurred.