These docs are for v1.0. Click to read the latest docs for v3.0.

Reports

Create Reports

Asleep.createReports()

var config: Asleep.Config?
var reports: Asleep.Reports?

if let config {
    reports = Asleep.createReports(config: config)
}
Property NameTypeDescription
configAsleep.ConfigAsleep.Config 객체를 입력

Get a Single Report

Asleep.Reports.report()

var reports: Asleep.Reports?
let sessionId: String

// Closure
reports?.report(sessionId: sessionId, completionBlock: { (report: Asleep.Report?, error: Asleep.AsleepError?) in
    if let error {
        print(error)
        return
    }
    
    if let report {
    }
})

// Async
Task {
    do {
        let report = try await reports?.report(sessionId: sessionId)
    } catch {
        print(error)
    }
}
Property NameTypeDescription
sessionIdStringSleep Tracking을 정지할 때 받을 수 있는 sessionId의 값
completionBlockAsleep.Model.Report?nil이면 에러 발생
Asleep.AsleepError?Error Codes

Get Multiple Reports

Asleep.Reports.reports()

var reports: Asleep.Reports?
let fromDate: String = "2023-05-01"
let toDate: String = "2023-05-07"

// Closure
reports?.reports(fromDate: fromDate, toDate: toDate, completionBlock: { (reportSessions: [Asleep.Model.SleepSession]?, error: Asleep.AsleepError?) in
    if let error {
        print(error)
        return
    }
    
    if let reportSessions {
    }
})

// Async
Task {
    do {
        let reportSessions = try await reports?.reports(fromDate: fromDate, toDate: toDate)
    } catch {
        print(error)
    }
}
Property NameTypeDescription
fromDateString (YYYY-MM-DD)조회 시작 날짜
toDateString (YYYY-MM-DD)조회 마지막 날짜
orderByAsleep.Model.OrderBy.descending: 내림차순 정렬
.ascending: 오름차순 정렬
offsetInt스킵할 Report 개수 (default: 0)
limitInt최대 받을 Report 개수 (0~100, default: 20)
completionBlockArray<Asleep.Model.SleepSession>?nil이면 에러 발생
Asleep.AsleepError?Error Codes

Get Average Stats

Asleep.Reports.getAverageReport()

var reports: Asleep.Reports?
let fromDate: String = "2023-05-01"
let toDate: String = "2023-05-07"

// Closure
reports?.getAverageReport(fromDate: fromDate, toDate: toDate, completionBlock: { (averageReport: Asleep.Model.AverageReport?, error: Asleep.AsleepError?) in
    if let error {
        print(error)
        return
    }
    
    if let averageReport {
    }
})

// Async
Task {
    do {
        let averageReport = try await reports?.getAverageReport(fromDate: fromDate, toDate: toDate)
    } catch {
        print(error)
    }
}
Property NameTypeDescription
fromDateString (YYYY-MM-DD)평균을 확인하고자 하는 기간의 시작 시간
toDateString (YYYY-MM-DD)평균을 확인하고자 하는 기간의 종료 시간
completionBlockAsleep.Model.AverageReport?nil이면 에러 발생
Asleep.AsleepError?Error Codes

Delete Report

❗️

데이터 삭제 주의
세션 데이터 삭제 요청에 따라 에이슬립 서버에서 세션 데이터가 삭제된 경우, 추후 과금 사용량 분석 시 삭제된 세션에 대한 구체적인 근거 제공이 어렵습니다.

Asleep.Reports.deleteReport()

var reports: Asleep.Reports?
let sessionId: String

// Closure
reports?.deleteReport(sessionId: sessionId, completionBlock: { (error: Asleep.AsleepError?) in
    if let error {
        print(error)
        return
    }
})

// Async
Task {
    do {
        try await deleteReport?.deleteReport(sessionId: sessionId)
    } catch {
        print(error)
    }
}
Property NameTypeDescription
sessionIdString삭제할 sessionId의 값
completionBlockAsleep.AsleepError?Error Codes

Data Types

Asleep.Model.Report

struct Report {
    let timezone: String
    let peculiarities: [Peculiarity]
    let missingDataRatio: Float
    let session: Session
    let stat: Stat?
}

enum Peculiarity {
    case inProgress
    case neverSlept
    case tooShortForAnalysis
    case tooLongForAnalysis
    case tooManyDefectsInSleepStages
    case noBreathingStability
    case noRealtimePolling
}
Property NameTypeDescription
timezoneString분석 결과의 시간대를 해당 timezone으로 변경해서 반환 (예: UTC, Asia/Seoul)
peculiaritiesAsleep.Model.Peculiarity해당 수면 세션의 특이사항을 설명하는 필드. 여러 개의 라벨 포함 가능.
missingDataRatioFloat오디오 업로드 누락 등의 이유로 인한 수면 분석 결과 오류율 (0~1.0)
sessionAsleep.Model.Session세션 분석 정보
statAsleep.Model.Stat분석 통계 정보

Asleep.Model.Session

struct Session {
    let id: String
    let state: State
    let startTime: Date
    let endTime: Date?
    let unexpectedEndTime: Date?
    let createdTimezone: String
    let sleepStages: [Int]?
    let snoringStages: [Int]?
}

enum State {
    case open
    case closed
    case complete
}
Property NameTypeDescription
idString세션 Id
stateAsleep.Model.State세션의 상태 (OPEN: 진행 중, CLOSED: 종료, COMPLETE: 분석 완료)
startTimeDate세션 시작 시각
endTimeDate?세션 종료 시각
unexpectedEndTimeDate?비정상 세션 종료 시각 (앱 크래시 등으로 인한 비정상 종료 시 기록됨)
createdTimezoneString세션이 생성된 타임존 (Timezone List)
sleepStagesArray<Int>수면 단계 리스트 (-1: error, 0: wake, 1: light, 2: deep, 3: rem)
snoringStagesArray<Int>코골이 리스트 (-1: error, 0: no snoring, 1: snoring)

Asleep.Model.Stat

struct Stat {
    let sleepEfficiency: Float?
    let sleepLatency: Int?
    let sleepTime: Date?
    let wakeupLatency: Int?
    let wakeTime: Date?
    let lightLatency: Int?
    let deepLatency: Int?
    let remLatency: Int?
    let timeInWake: Int?
    let timeInSleepPeriod: Int?
    let timeInSleep: Int?
    let timeInBed: Int?
    let timeInRem: Int?
    let timeInLight: Int?
    let timeInDeep: Int?
    let timeInSnoring: Int?
    let timeInNoSnoring: Int?
    let wakeRatio: Float?
    let sleepRatio: Float?
    let remRatio: Float?
    let lightRatio: Float?
    let deepRatio: Float?
    let snoringRatio: Float?
    let noSnoringRatio: Float?
    let sleepCycle: Int?
    let sleepCycleCount: Int?
    let sleepCycleTime: [Date]?
    let wasoCount: Int?
    let longestWaso: Int?
    let sleepIndex: Int?
    let snoringCount: Int?
}
Property NameTypeDescription
sleepEfficiencyFloat?수면 측정 시간 중 실제로 잠든 시간의 비율
sleepLatencyInt?잠들때까지 걸린 시간
sleepTimeDate?수면 측정 시작 후 잠들기까지 걸린 시간
wakeupLatencyInt?잠에서 깨어난 후 수면 측정을 종료하기까지 걸린 시간
wakeTimeDate?잠에서 깨어난 시각
lightLatencyInt?첫 수면 시작으로부터 첫 번째 light가 발생하기까지의 시간
deepLatencyInt?첫 수면 시작으로부터 첫 번째 deep이 발생하기까지의 시간
remLatencyInt?첫 수면 시작으로부터 첫 번째 rem이 발생하기까지의 시간
timeInWakeInt?수면 도중에 깬 시간
timeInSleepPeriodInt?수면 측정 시간 중 수면 측정 시작으로부터 잠들기 까지 걸린 시간과 잠에서 깨어난 후로부터 수면 측정을 종료하기까지 걸린 시간을 제외한 시간
timeInSleepInt?수면 측정 시간 중 실제로 수면 중이었던 시간 (이 시간이 deep, light, rem의 3단계로 구분됨)
timeInBedInt?수면 측정 시작 시각부터 수면 측정 종료 시각 까지의 시간
timeInRemInt?수면 단계가 rem 으로 진행된 총 시간
timeInLightInt?수면 단계가 light 로 진행된 총 시간
timeInDeepInt?수면 단계가 deep로 진행된 총 시간
timeInSnoringInt?코골이가 발생한 총 시간
timeInNoSnoringInt?코골이가 발생하지 않은 총 시간
wakeRatioFloat?수면 단계 도중 중간에 깬 시간의 비율
sleepRatioFloat?수면 단계 도중 깨지 않고 잔 시간의 비율
remRatioFloat?수면 단계 도중 REM 수면의 비율
lightRatioFloat?수면 단계 도중 light 수면의 비율
deepRatioFloat?수면 단계 도중 deep 수면의 비율
snoringRatioFloat?수면 단계 도중 코골이었던 시간의 비율
noSnoringRatioFloat?수면 단계 도중 코골이가 아니었던 시간의 비율
sleepCycleInt?수면 주기 1회당 평균 시간
sleepCycleCountInt?수면 주기의 횟수
sleepCycleTime[Date]?수면 주기 전환 기준 시각 (예: [첫번째 수면 주기 시작 시각, 첫번째 수면 주기 종료 시각, 두번째 수면 주기 종료 시각, ..., 마지막 수면 주기 종료 시각])
wasoCountInt?수면 구간 중 wake가 발생한 횟수
longestWasoInt?수면 구간 중 가장 긴 wake의 시간
sleepIndexInt?수면 데이터 분포를 학습하여 정의된 수면의 질을 종합적으로 대표하는 지표 (수면 점수)
snoringCountInt?코골이 구간의 발생한 횟수

Asleep.Model.SleepSession

struct SleepSession {
    let sessionId: String
    let state: State
    let sessionStartTime: Date
    let sessionEndTime: Date?
    let createdTimezone: String
    let unexpectedEndTime: Date?
    let lastReceivedSeqNum: Int
    let timeInBed: Int
}

enum State {
    case open
    case closed
    case complete
}
Property NameTypeDescription
sessionIdString수면 세션 ID
stateAsleep.Model.State세션의 상태 (OPEN: 진행 중, CLOSED: 종료, COMPLETE: 분석 완료)
sessionStartTimeDate세션 시작 시각
sessionEndTimeDate?세션 종료 시각
createdTimezoneString세션이 생성된 타임존 (Timezone List)
unexpectedEndTimeDate?비정상 세션 종료 시각 (앱 크래시 등으로 인한 비정상 종료 시 기록됨)
lastReceivedSeqNumInt마지막으로 업로드한 오디오 파일의 순서 번호
timeInBedInt수면 측정 시작 시각부터 수면 측정 종료 시각 까지의 시간

Asleep.Model.AverageReport

struct AverageReport {
    let period: Period
    let peculiarities: [Peculiarity]
    let averageStats: AverageStats?
    let neverSleptSessions: [NeverSleptSession]
    let sleptSessions: [SleptSession]
}
Property NameTypeDescription
periodAsleep.Model.Period타임존 (Timezone List)
peculiaritiesArray<Asleep.Model.Peculiarity>수면 세션들의 평균을 구할 때 특이사항. (NO_BREATHING_STABILITY: 호흡 안정 분석 미지원)
averageStatsAsleep.Model.AverageStats?slept_sessions의 수면 메트릭들의 평균들을 가지는 객체
neverSleptSessionsArray<Asleep.Model.NeverSleptSession>세션 측정시간 동안 전혀 잠을 자지 않았다고 판단 되는 세션들의 목록
sleptSessionsArray<Asleep.Model.SleptSession>세션 측정시간 동안 잠을 잤다고 판단 되는 세션들의 목록

Asleep.Model.Period

struct Period {
    let timezone: String
    let startDate: Date
    let endDate: Date
}
Property NameTypeDescription
timezoneString요청한 타임존 (예: UTC, Asia/Seoul)
startDateDate요청한 시작 시간
endDateDate요청한 종료 시간

Asleep.Model.AverageStats

struct AverageStats {
    let startTime: String
    let endTime: String
    let sleepTime: String
    let wakeTime: String
    let sleepLatency: Int
    let wakeupLatency: Int
    let timeInBed: Int
    let timeInSleepPeriod: Int
    let timeInSleep: Int
    let timeInWake: Int
    let timeInLight: Int?
    let timeInDeep: Int?
    let timeInRem: Int?
    let timeInSnoring: Int?
    let timeInNoSnoring: Int?
    let sleepEfficiency: Double
    let wakeRatio: Double
    let sleepRatio: Double
    let lightRatio: Double?
    let deepRatio: Double?
    let remRatio: Double?
    let snoringRatio: Double?
    let noSnoringRatio: Double?
    let wasoCount: Int
    let longestWaso: Int
    let sleepCycleCount: Int?
    let snoringCount: Int?
}
Property NameTypeDescription
startTimeString (hh:mm:ss)세션 시작 시각
endTimeString (hh:mm:ss)세션 종료 시각
sleepTimeString (hh:mm:ss)잠들때까지 걸린 시각
wakeTimeString (hh:mm:ss)잠에서 깨어난 시각
sleepLatencyInt잠들때까지 걸린 시각
wakeupLatencyInt잠에서 깨어난 후 수면 측정을 종료하기까지 걸린 시간
timeInBedInt수면 측정 시작 시각부터 수면 측정 종료 시각 까지의 시간
timeInSleepPeriodInt수면 측정 시간 중 수면 측정 시작으로부터 잠들기 까지 걸린 시간과 잠에서 깨어난 후로부터 수면 측정을 종료하기까지 걸린 시간을 제외한 시간
timeInSleepInt수면 측정 시간 중 실제로 수면 중이었던 시간 (이 시간이 deep, light, rem의 3단계로 구분됨)
timeInWakeInt수면 도중에 깬 시간
timeInLightInt?수면 단계가 light 로 진행된 총 시간
timeInDeepInt?수면 단계가 deep로 진행된 총 시간
timeInRemInt?수면 단계가 rem 으로 진행된 총 시간
timeInSnoringInt?코골이가 발생한 총 시간
timeInNoSnoringInt?코골이가 발생하지 않은 총 시간
sleepEfficiencyDouble수면 측정 시간 중 실제로 잠든 시간의 비율
wakeRatioDouble수면 단계 도중 중간에 깬 시간의 비율
sleepRatioDouble수면 단계 도중 깨지 않고 잔 시간의 비율
lightRatioDouble?수면 단계 도중 light 수면의 비율
deepRatioDouble?수면 단계 도중 deep 수면의 비율
remRatioDouble?rem sleep 비율
snoringRatioDouble?수면 단계 도중 코골이었던 시간의 비율
noSnoringRatioDouble?수면 단계 도중 코골이가 아니었던 시간의 비율
wasoCountInt수면 구간 중 wake가 발생한 횟수
longestWasoInt수면 구간 중 가장 긴 wake의 시간
sleepCycleCountInt?수면 주기의 횟수
snoringCountInt?코골이 구간의 발생한 횟수

Asleep.Model.NeverSleptSession

struct NeverSleptSession {
    let id: String
    let startTime: Date
    let endTime: Date
    let completedTime: Date
}
Property NameTypeDescription
idStringsession id
startTimeDate세션 시작 시각
endTimeDate세션 종료 시각
completedTimeDate세션 분석 완료 시각

Asleep.Model.SleptSession

struct SleptSession {
    let id: String
    let createdTimezone: String
    let startTime: Date
    let endTime: Date
    let completedTime: Date
    let sleepEfficiency: Double
    let sleepLatency: Int?
    let wakeupLatency: Int?
    let lightLatency: Int?
    let deepLatency: Int?
    let remLatency: Int?
    let sleepTime: Date?
    let wakeTime: Date?
    let timeInWake: Int
    let timeInSleepPeriod: Int
    let timeInSleep: Int
    let timeInBed: Int
    let timeInRem: Int?
    let timeInLight: Int?
    let timeInDeep: Int?
    let timeInSnoring: Int?
    let timeInNoSnoring: Int?
    let wakeRatio: Double
    let sleepRatio: Double
    let remRatio: Double?
    let lightRatio: Double?
    let deepRatio: Double?    
    let snoringRatio: Double?
    let noSnoringRatio: Double?
    let sleepCycle: Int?
    let sleepCycleCount: Int?
    let wasoCount: Int?
    let longestWaso: Int?
    let snoringCount: Int?
}
Property NameTypeDescription
idStringsession id
createdTimezoneString세션이 생성된 타임존 (Timezone List)
startTimeDate세션 종료 시각
endTimeDate세션 종료 시각
completedTimeDate세션 분석 완료 시각
sleepEfficiencyDouble수면 측정 시간 중 실제로 잠든 시간의 비율
sleepLatencyInt?잠들때까지 걸린 시각
wakeupLatencyInt?잠에서 깨어난 후 수면 측정을 종료하기까지 걸린 시간
lightLatencyInt?첫 수면 시작으로부터 첫 번째 light가 발생하기까지의 시간
deepLatencyInt?첫 수면 시작으로부터 첫 번째 deep이 발생하기까지의 시간
remLatencyInt?첫 수면 시작으로부터 첫 번째 rem이 발생하기까지의 시간
sleepTimeDate?수면 측정 시작 후 잠들기 까지 걸린 시간
wakeTimeDate?잠에서 깨어난 시각
timeInWakeInt수면 도중에 깬 시간
timeInSleepPeriodInt수면 측정 시간 중 수면 측정 시작으로부터 잠들기 까지 걸린 시간과 잠에서 깨어난 후로부터 수면 측정을 종료하기까지 걸린 시간을 제외한 시간
timeInSleepInt수면 측정 시간 중 실제로 수면 중이었던 시간 (이 시간이 deep, light, rem의 3단계로 구분됨)
timeInBedInt수면 측정 시작 시각부터 수면 측정 종료 시각 까지의 시간
timeInRemInt?수면 단계가 rem 으로 진행된 총 시간
timeInLightInt?수면 단계가 light 로 진행된 총 시간
timeInDeepInt?수면 단계가 deep로 진행된 총 시간
timeInSnoringInt?코골이가 발생한 총 시간
timeInNoSnoringInt?코골이가 발생하지 않은 총 시간
wakeRatioDouble수면 단계 도중 중간에 깬 시간의 비율
sleepRatioDouble수면 단계 도중 깨지 않고 잔 시간의 비율
remRatioDouble?rem sleep 비율
lightRatioDouble?수면 단계 도중 light 수면의 비율
deepRatioDouble?수면 단계 도중 deep 수면의 비율
snoringRatioDouble?수면 단계 도중 코골이었던 시간의 비율
noSnoringRatioDouble?수면 단계 도중 코골이가 아니었던 시간의 비율
sleepCycleInt?수면 주기 1회당 평균 시간
sleepCycleCountInt?수면 주기의 횟수
wasoCountInt?수면 구간 중 wake가 발생한 횟수
longestWasoInt?수면 구간 중 가장 긴 wake의 시간
snoringCountInt?코골이 구간의 발생한 횟수