Migration Guide

1. Version 1.0 to 2.0

1.1 Changes to the Report Structure

๐Ÿ“˜

Note

iOS: Reports

Android: Reports

Add List

Variable nameTypeDescription
PeculiaritiesEnumThis field describes any peculiarities of the sleep session and can contain multiple labels.

IN_PROGRESS
NEVER_SLEPT
TOO_SHORT_FOR_ANALYSIS
TOO_LONG_FOR_ANALYSIS
TOO_MANY_DEFECTS_IN_SLEEP_STAGES
NO_BREATHING_STABILITY
NO_REALTIME_POLLING
missing_data_ratioFloatSegments with Missing Analysis Results
breathing_indexFloatValue to Determine Respiratory Instability Level
breath_stages[Int]Respiratory Stability

Remove List

Variable nameTypeDescription
ValidityEnumThis field represents the validity of the analysis for the specific sleep session.
If some of the uploaded audio files are invalid or if there is a significant loss rate, the accuracy of the analysis results may be compromised, and this field indicates that.

IN_PROGRESS
INVALID:TOO_MANY_DEFECTS_IN_SLEEP_STAGES
INVALID:TOO_MANY_DEFECTS_IN_OSA_STAGES
VALID
estimated_ahiFloatValue for Assessing Respiratory Instability Level
osa_stages[Int]Respiratory Stability

Change List

1.x.x2.x.x
Breathing PatternVERY_STABLE,
STABLE,
UNSTABLE,
VERY_UNSTABLE
STABLE_BREATH,
MILDLY_UNSTABLE_BREATH,
MODERATELY_UNSTABLE_BREATH,
SEVERELY_UNSTABLE_BREATH

1.2 Changes to the Error Codes (Android)

Add List

ErrorCodeDescription
ERR_ANALYSE_UNAUTHORIZED31401Unauthorized
ERR_REPORT_UNAUTHORIZED32401Unauthorized

Remove List

ErrorCodeDescription
ERR_ANALYSE_UNPROCESSABLE31422The format of the sleep session id is not valid.
ERR_REPORT_UNPROCESSABLE32422The format of the sleep session id is not valid.