文档
测试

获取睡眠报告

GET
GetSleepReport

接口描述

获取睡眠报告

请求参数

参数名
类型
描述
必填
dataJson
object
数据参数
必填
member_id
number
会员ID 示例:100000
必填
client_key
string
密钥 示例:A5D22FF169993B30EFD2F2AE2A1875B572AA1835D2DBA51C588E601FA684CF4C
必填
sleep_id
string
睡眠ID
必填
mac
string
mac地址
必填

响应参数

参数名
类型
描述
必填
ret
number
示例:0
必填
msg
string
示例:ok
必填
err_code
number
示例:0
必填
data
object
数据字典
必填
sleep_id
string
睡眠ID
必填
mac
string
Wifi-MAC 示例:C4:DE:E2:28:50:64
必填
left
object
右边数据 数据字典
必填
bed_duration
number
在床时长 单位(分钟)示例:71
必填
sleep_duration
number
睡眠时长 单位(分钟) 示例:51
必填
deep_sleep_duration
number
深睡时长 单位(分钟)示例:10
必填
rem_sleep_duration
number
快速眼动睡眠时长(中睡眠) 单位(分钟) 示例:30
必填
light_sleep_duration
number
浅睡时长 单位(分钟) 示例:11
必填
sleep_score
number
睡眠评分 示例:51
必填
score_evaluate
string
睡眠评分评语 示例:槽勒个糕
必填
start_sleep_time
string
开始睡眠时间 字符串 示例:12:10
必填
end_sleep_time
string
结束睡眠时间 字符串 示例:13:22
必填
date
string
日期 字符串 示例:2019年09月25日
必填
day_of_week
string
星期几 字符串(英文) 示例:Wednesday
必填
source_type
number
来源 注:没用到 现只有床垫
必填
turn_count
number
翻身次数 示例:46
必填
snore_duration
number
打鼾时长 单位(分钟)示例:-1
必填
snore_count
number
打鼾次数 示例:-1
必填
breath_rate
number
呼吸率 示例:13
必填
heart_rate
number
心率 示例:63
必填
sleep_onset_time
number
入睡时间 单位(分钟) 示例:10
必填
sleep_age
number
睡眠年龄 示例:93
必填
sleep_report
array
睡眠 数据列表
必填
value
number
时长单位(分) 示例:10
必填
state
number
睡眠状态 【1深睡 2中睡 3浅睡 4清醒 5离床】示例:4
必填
str
string
时间范围 字符串 示例:12:10-12:20
必填
start_time
string
起始时间 示例:2019-09-25 12:10:54
必填
end_time
string
结束时间 示例:2019-09-25 12:20:54
必填
other_data
object
其它 【体动 呼吸 心率】 数据字典
必填
turn
array
体动 数据列表
必填
heartrate
array
心率 数据列表
必填
breathrate
array
呼吸 数据列表
必填
humidity
array
湿度 数据列表
必填
snoring
array
鼾声 数据列表
必填
snoring_wave
array
鼾声波 数据列表
必填
temperature
array
温度 数据列表
必填
times
array
时间 数据列表
必填
snoring_intervene_wave
array
鼾声干预波 数据列表
必填
sleep_assessment_tags
array
睡眠评估结果标签 数据列表
必填
tag_text
string
示例:正常
必填
sleep_assessment
string
睡眠评估结果 示例:黄金睡眠充足
必填
advice
string
个性化建议 示例:好好保持,多了解更多睡眠相关知识。如果您觉得监测不够准确,请延长单次监测时间6小时以上,并连续监测一周。
必填
questions
array
相关问答 数据列表
必填
questions_text
string
示例:正常睡眠时间是什么?
必填
questions_answer
string
示例:https://res.3zsleep.cn/ask/answers/a4c176f29f2abd38863a49bd237b19fc.htm?ad=off
必填
device_info
object
数据字典
必填
title
string
标题 示例:你本次睡眠的床垫
必填
url
string
跳转url
必填
brand_name
string
品牌 示例:顾梦斯KUMONS
必填
producer
string
监制 示例:维也纳(香港)国际睡眠研发中心
必填
model
string
型号 示例:三大睡感系列--禅悦
必填
sleep_feeling
string
睡感 示例:韧弹悬浮感
必填
hotel_naem
string
酒店名称
必填
hotel_room_number
string
酒店房间号
必填
goods_info
object
数据字典
必填
title
string
示例:
必填
content
string
示例:
必填
items
array
数据列表
必填
name
string
示例:
必填
qr_url
string
示例:
必填
ad_info
object
数据字典
必填
title
string
标题 示例:睡得不舒服?
必填
content
string
内容 示例:免费试睡三大睡感系列床垫:
必填
items
array
标签项 列表
必填
name
string
标签名 示例:柔软呵护感
必填
url
string
跳转url
必填
avg_humidity
number
平均湿度
必填
avg_temperature
number
平均温度
必填
is_officia
bool
必填
max_humidity
number
最大湿度
必填
max_temperature
number
最大温度
必填
min_humidity
number
平均湿度
必填
min_temperature
number
平均温度
必填
no_sleeptime
string
必填
snroe_intervene
number
鼾声干预次数
必填
user_avatar
string
用户头像
必填
user_level
number
用户等级
必填
user_name
string
用户昵称
必填
radar
object
数据字典
必填
indicator
array
数据列表
必填
name
string
示例:入睡时刻
必填
max
int
示例:100
必填
data
array
数据列表
必填
value
array
数据列表
必填
result
array
数据列表
必填
name
string
示例:睡眠综合评估
必填
apnea_info
object
呼吸暂停信息 数据字典
可选
event_count
int
呼吸暂停次数 示例:7
必填
ahi
float
AHI值 示例:0.88
必填
severity
string
严重性评价 示例:Healthy
必填
event_positions
array
呼吸暂停事件例表 数据列表
必填
event_id
int
事件序号 示例:1
必填
duration_sec
int
时长 示例:12
必填
start_sample
int
开始位置 示例:83640
必填
end_sample
int
结束位置 示例:83880
必填
right
object
左边数据 参考 left
必填
sn
string
序例号
必填

说明 / 示例

## 接口地址 ## 成功返回示例 ```language { "data": { "left": { "age_humidity": 0, "avg_temperature": 0,   "is_official": false,   "max_humidity": 0,   "max_temperature": 0,   "min_humidity": 0,   "min_temperature": 0,   "no_sleeptime": "1.5",   "snroe_intervene": 0,   "user_avatar": "",   "user_level": 0,   "user_name": "", "bed_duration": 519, "sleep_duration": 286, "deep_sleep_duration": 80, "rem_sleep_duration": 0, "light_sleep_duration": 206, "sleep_score": 44, "score_evaluate": "待改善", "start_sleep_time": "23:41", "end_sleep_time": "09:01", "date": "2025年07月20日", "day_of_week": "Monday", "source_type": -1, "turn_count": 425, "snore_duration": 0, "snore_count": 0, "breath_rate": 18, "heart_rate": 69, "sleep_onset_time": 27, "sleep_age": 16, "sleep_report": [{ "value": 27.84, "state": 4, "str": "23:41-00:08", "start_time": "2025-07-20 23:41:03", "end_time": "2025-07-21 00:08:54" }, { "value": 13, "state": 5, "str": "00:08-00:22", "start_time": "2025-07-21 00:08:54", "end_time": "2025-07-21 00:22:53" }, { "value": 10.01, "state": 4, "str": "00:22-00:32", "start_time": "2025-07-21 00:22:53", "end_time": "2025-07-21 00:32:54" }, { "value": 7.77, "state": 3, "str": "00:32-00:40", "start_time": "2025-07-21 00:32:54", "end_time": "2025-07-21 00:40:41" }, { "value": 7, "state": 5, "str": "00:40-00:48", "start_time": "2025-07-21 00:40:41", "end_time": "2025-07-21 00:48:19" }, { "value": 20.02, "state": 4, "str": "00:48-01:08", "start_time": "2025-07-21 00:48:19", "end_time": "2025-07-21 01:08:20" }, { "value": 70.03, "state": 3, "str": "01:08-02:18", "start_time": "2025-07-21 01:08:20", "end_time": "2025-07-21 02:18:22" }, { "value": 10, "state": 4, "str": "02:18-02:28", "start_time": "2025-07-21 02:18:22", "end_time": "2025-07-21 02:28:22" }, { "value": 10, "state": 3, "str": "02:28-02:38", "start_time": "2025-07-21 02:28:22", "end_time": "2025-07-21 02:38:23" }, { "value": 30.06, "state": 1, "str": "02:38-03:08", "start_time": "2025-07-21 02:38:23", "end_time": "2025-07-21 03:08:27" }, { "value": 20.06, "state": 3, "str": "03:08-03:28", "start_time": "2025-07-21 03:08:27", "end_time": "2025-07-21 03:28:30" }, { "value": 30.09, "state": 1, "str": "03:28-03:58", "start_time": "2025-07-21 03:28:30", "end_time": "2025-07-21 03:58:36" }, { "value": 6.34, "state": 4, "str": "03:58-04:04", "start_time": "2025-07-21 03:58:36", "end_time": "2025-07-21 04:04:57" }, { "value": 20, "state": 5, "str": "04:04-04:25", "start_time": "2025-07-21 04:04:57", "end_time": "2025-07-21 04:25:34" }, { "value": 0.01, "state": 3, "str": "04:25-04:25", "start_time": "2025-07-21 04:25:34", "end_time": "2025-07-21 04:25:35" }, { "value": 10.03, "state": 4, "str": "04:25-04:35", "start_time": "2025-07-21 04:25:35", "end_time": "2025-07-21 04:35:37" }, { "value": 10, "state": 3, "str": "04:35-04:45", "start_time": "2025-07-21 04:35:37", "end_time": "2025-07-21 04:45:37" }, { "value": 50.12, "state": 4, "str": "04:45-05:35", "start_time": "2025-07-21 04:45:37", "end_time": "2025-07-21 05:35:45" }, { "value": 20.03, "state": 3, "str": "05:35-05:55", "start_time": "2025-07-21 05:35:45", "end_time": "2025-07-21 05:55:47" }, { "value": 3.28, "state": 4, "str": "05:55-05:59", "start_time": "2025-07-21 05:55:47", "end_time": "2025-07-21 05:59:04" }, { "value": 12, "state": 5, "str": "05:59-06:11", "start_time": "2025-07-21 05:59:04", "end_time": "2025-07-21 06:11:06" }, { "value": 10.03, "state": 3, "str": "06:11-06:21", "start_time": "2025-07-21 06:11:06", "end_time": "2025-07-21 06:21:08" }, { "value": 10.03, "state": 1, "str": "06:21-06:31", "start_time": "2025-07-21 06:21:08", "end_time": "2025-07-21 06:31:10" }, { "value": 10.03, "state": 3, "str": "06:31-06:41", "start_time": "2025-07-21 06:31:10", "end_time": "2025-07-21 06:41:12" }, { "value": 10.03, "state": 4, "str": "06:41-06:51", "start_time": "2025-07-21 06:41:12", "end_time": "2025-07-21 06:51:14" }, { "value": 18.53, "state": 3, "str": "06:51-07:09", "start_time": "2025-07-21 06:51:14", "end_time": "2025-07-21 07:09:46" }, { "value": 5, "state": 5, "str": "07:09-07:15", "start_time": "2025-07-21 07:09:46", "end_time": "2025-07-21 07:15:35" }, { "value": 30.03, "state": 4, "str": "07:15-07:45", "start_time": "2025-07-21 07:15:35", "end_time": "2025-07-21 07:45:38" }, { "value": 30.06, "state": 3, "str": "07:45-08:15", "start_time": "2025-07-21 07:45:38", "end_time": "2025-07-21 08:15:42" }, { "value": 10.03, "state": 1, "str": "08:15-08:25", "start_time": "2025-07-21 08:15:42", "end_time": "2025-07-21 08:25:44" }, { "value": 10.03, "state": 3, "str": "08:25-08:35", "start_time": "2025-07-21 08:25:44", "end_time": "2025-07-21 08:35:46" }, { "value": 25.61, "state": 4, "str": "08:35-09:01", "start_time": "2025-07-21 08:35:46", "end_time": "2025-07-21 09:01:23" }], "other_data": { "turn": [9, 2, 2, 2, 2, 1, 1, 3, 3, 6, 4, 4, 1, 8, 0, 0, 0, 0, 0, 0, 2, 2, 0, 3, 2, 1, 1, 1, 0, 5, 0, 0, 0, 1, 0, 9, 0, 0, 0, 4, 1, 3, 2, 1, 0, 0, 2, 1, 0, 0, 0, 5, 0, 0, 0, 0, 0, 4, 1, 0, 0, 1, 1, 1, 4, 3, 1, 0, 0, 0, 0, 1, 0, 2, 0, 5, 1, 0, 5, 0, 5, 2, 2, 4, 2, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 1, 0, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 4, 3, 0, 0, 0, 0, 0, 0, 2, 2, 0, 1, 3, 3, 4, 2, 3, 2, 0, 1, 3, 2, 1, 5, 1, 2, 4, 1, 1, 5, 5, 8, 1, 1, 5, 8, 8, 5, 3, 5, 5, 7, 8, 2, 5, 5, 7, 0, 0, 0, 0, 5, 0, 0, 1, 5, 1, 1, 4, 0, 0, 0, 1, 0, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 1, 0, 2, 4, 5, 2, 0, 0, 0, 0, 2, 0, 2, 2, 0, 2, 0, 0, 4, 3, 4, 3, 2, 2, 2, 5, 4, 7, 4, 2, 2, 1, 3, 2, 0, 1, 0, 0, 3, 0, 1, 0, 0, 0, 0, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0, 0, 2, 0, 2, 0, 1, 0, 3, 3, 4, 4, 2, 1, 1, 0, 9], "heartrate": [74, 75, 74, 73, 76, 71, 74, 73, 73, 75, 74, 74, 76, 69, 69, 69, 69, 69, 69, 69, 60, 74, 74, 74, 75, 73, 73, 72, 70, 64, 64, 64, 64, 65, 72, 75, 70, 63, 62, 69, 72, 73, 74, 69, 61, 66, 67, 79, 70, 79, 76, 72, 68, 69, 71, 69, 71, 72, 71, 66, 75, 81, 72, 73, 78, 79, 63, 60, 64, 67, 72, 69, 63, 70, 66, 72, 66, 63, 70, 77, 71, 64, 63, 74, 73, 68, 60, 59, 58, 61, 68, 65, 66, 65, 66, 68, 69, 67, 69, 66, 68, 69, 67, 63, 67, 65, 64, 66, 65, 65, 59, 73, 72, 73, 67, 70, 68, 73, 72, 69, 72, 71, 76, 75, 78, 75, 70, 79, 77, 78, 72, 72, 72, 72, 72, 72, 72, 61, 69, 63, 60, 65, 69, 75, 69, 74, 76, 67, 69, 74, 75, 76, 68, 74, 70, 71, 73, 75, 69, 72, 72, 73, 70, 71, 70, 72, 70, 79, 77, 72, 70, 73, 75, 66, 69, 72, 68, 73, 68, 74, 78, 82, 73, 67, 68, 73, 77, 70, 82, 7, 72, 70, 72, 62, 64, 70, 71, 61, 64, 60, 61, 61, 65, 61, 67, 68, 62, 62, 65, 69, 67, 65, 68, 72, 73, 67, 64, 68, 69, 72, 70, 70, 73, 74, 49, 49, 49, 70, 74, 78, 73, 70, 72, 77, 72, 82, 74, 71, 71, 70, 71, 73, 76, 78, 73, 73, 73, 71, 76, 73, 72, 69, 66, 65, 70, 68, 68, 70, 69, 72, 70, 70, 72, 70, 70, 71, 77, 74, 65, 69, 72, 75, 73, 69, 68, 68, 67, 69, 68, 72], "breathrate": [21.25082, 20.32666, 20.07667, 20.44167, 19.94482, 18.30328, 19.50833, 19.26667, 19.57333, 19.83333, 19.56558, 20.14833, 20.73, 18.94501, 18.94501, 18.94501, 18.94501, 18.94501, 18.94501, 18.94501, 21.2, 21.89333, 20.46667, 20.44483, 19.95902, 19.305, 18.44, 19.23966, 17.74833, 17.81428, 17.81428, 17.81428, 17.81428, 20.10909, 18.30714, 21.11333, 18.15082, 15.77667, 15.70689, 20.1, 19.29833, 20.23929, 20.51455, 18.31833, 15.70727, 16.4125, 18.63334, 23.895, 18.72666, 22.83509, 20.88166, 19.87377, 16.1931, 16.745, 17.37796, 18.39108, 18.67541, 19.91695, 17.97541, 17.705, 20.55167, 25.05334, 19.22623, 20.975, 22.28621, 23.73167, 16.11176, 15.32857, 16.24386, 17.16964, 18.605, 17.41833, 15.77719, 17.075, 13.85263, 18.54464, 15.23928, 13.92632, 18.47368, 21.30351, 18.63898, 15.46897, 15.7375, 21.015, 19.2193, 18.68, 14.555, 14.44427, 14.29828, 14.865, 13.77667, 13.88667, 13.81967, 13.835, 13.68833, 13.88, 13.585, 13.77333, 13.90984, 13.77166, 13.79818, 13.68833, 13.81786, 14.01053, 13.55741, 13.77966, 14.0431, 14.2625, 16.82833, 16.30339, 13.93448, 19.57143, 19.12167, 19.30357, 17.08364, 18.36607, 17.18965, 20.1, 19.17414, 17.19167, 19.26429, 19.5459, 20.595, 20.53818, 21.98001, 20.30517, 18.90492, 23.89636, 21.515, 21.99333, 18.15333, 19.30819, 19.30819, 19.30819, 19.30819, 19.30819, 19.30819, 15.83095, 18.98667, 16.26909, 16.00833, 15.93334, 20.15357, 20.33333, 18.94737, 19.69667, 20.92459, 17.12833, 17.21526, 20.94915, 20.425, 20.64407, 18.27627, 20.91929, 17.17895, 19.815, 20.2421, 20.06834, 18.23929, 21.57241, 20.09322, 19.57377, 18.25965, 18.64737, 18.87931, 18.90667, 18.825, 23.76964, 20.135, 18.47368, 18.37833, 19.80175, 19.60339, 16.98667, 17.18333, 20.03, 17.24099, 20.16167, 18.39286, 20.33455, 21.90333, 24.18688, 19.33334, 16.93572, 17.81207, 20.67587, 21.27213, 17.63833, 24.52322, 1.82, 20.14407, 18.73509, 18.85263, 14.97334, 15.59333, 17.455, 17.97869, 14.5678, 14.09667, 14.30517, 14.31167, 14.08361, 14.37, 15.33667, 14.43158, 13.53167, 15.65738, 15.49334, 16.01, 17.9037, 16.97, 16.22833, 17.54545, 19.62728, 18.49818, 15.81, 14.96038, 18.89166, 16.85264, 18.425, 17.695, 18.18689, 19.81167, 21.13729, 12.18667, 12.18667, 12.18667, 21.48636, 19.99833, 22.64828, 19.08667, 18.60833, 20.53333, 22.01833, 19.31579, 25.67833, 20.815, 19.045, 19.29333, 18.29509, 19.07333, 20.65167, 22.15667, 21.25333, 19.72333, 19.93793, 19.16167, 19.52167, 20.74667, 20.29, 17.38334, 16.44667, 14.98667, 16.76667, 18.29836, 16.79833, 18.70166, 17.99666, 18.38667, 18.45574, 17.32034, 18.39333, 18.72667, 18.01333, 17.85902, 19.03167, 22.15, 19.36167, 16.77167, 18, 19.40334, 20.895, 18.995, 17.40833, 16.6356, 16.90667, 16.70351, 18.99, 17.02833, 19.41148],   "humidity":[0], "snoring":[0], "snoring_wave":[0], "temperature":[0], "times":["02:45"], }, "ad_info":{"content":"","title":"", "items":[{"name":"","url":""}]}, "device_info":{"brand_name":"","hotel_naem":"","hotel_room_number":"","model":"","producer":"","sleep_feeling":"","title":"","url":""}, "goods_info":{"title":"","content":"","items":[{"name":"","qr_url":""}]}, "sleep_assessment_tags": [{ "tag_text": "正常" }, { "tag_text": "睡觉太晚" }, { "tag_text": "多次觉醒" }, { "tag_text": "半夜3到5点清醒过长" }, { "tag_text": "睡眠不足" }, { "tag_text": "深度睡眠时间不足" }, { "tag_text": "起床太迟" }], "sleep_assessment": "黄金睡眠充足\r\n上床睡觉时间太迟\r\n觉醒次数过多,存在睡眠不实情况。\r\n如果是经常半夜3:00—5:00醒来,可能要注意您是不是有呼吸系统疾病的问题。\r\n您的睡眠总时间不足6.5小时,存在睡眠不足情况\r\n您的深度睡眠时间不足,存在睡眠表浅情况。不能有效解除疲劳。\r\n起床时间太迟\r\n", "advice": ["好好保持,多了解更多睡眠相关知识。", "通常人体的上床睡觉时间最晚是23点(子时),子时是阴阳交替时间,此时入睡对于阳气的生发和保持肝胆的疏泄功能非常有帮助,有助于正常精神状态的维持和减少肝胆的疾病。如果子时不睡觉,元气无法生成,就会出现口苦、容易叹气、胸痛、脸缺乏光泽(无精打采的倦容)、皮肤干燥等等状况。", "如果半夜起床是因为夜尿频次较多,可能是睡前饮水过多,或者是摄入了利尿功能饮品;如果经常频繁起夜,有可能是高血压、糖尿病等疾病导致,也有可能是前列腺方面的疾病,需要尽快去医院检查治疗。如果排除以上问题,大部分原因是因为精神压力过大或者焦虑引起,请注意调理心态。", "3:00-5:00是肺输布气血到各个地方的时候;肺不好就睡不好,长期睡眠不足,容易导致肺病,建议及时到医院检查治疗。", "总睡眠时间不足和深度睡眠时间不足都会导致脑和躯体功能下降。白日不够清醒、头昏、记忆力下降、注意力不能集中、不能恢复精力充沛、疲乏无力或打瞌睡等,影响生活、工作与学习。建议留足充分的睡眠时间,或者通过减缓压力、减少焦虑等方式,减少失眠情况。", "按照人体正常生物节律,体内激素水平的变化是要遵从自然规律,睡得太晚起得太迟,会导致内分泌紊乱,影响体内的激素分泌水平,建议晚上11点之前睡眠,成人每日睡眠满8小时可以保持精力充沛。", "为获得准确睡眠监测数据,请确保在床睡眠时间达到 6-8小时,并连续监测5-7天。"], "questions": [{ "question_text": "什么样的环境益于睡眠?", "questions_answer": "  。。。。。 " }, { "question_text": "睡眠的生理过程是怎样的?", "questions_answer": " 。。。。。 " }], "radar": { "indicator": [ {"name": "入睡时刻", "max": 100}, {"name": "入睡速度", "max": 100}, {"name": "睡眠时长", "max": 100}, {"name": "深睡", "max": 100}, {"name": "安稳度", "max": 100}, {"name": "睡眠效率", "max": 100} ], "data": [ { "value": [85, 90, 75, 80, 88, 92], "result": ["23:35", "16分钟", "6小时30分", "3小时7分", "良好", "90%"], "name": "睡眠综合评估" } ] } ,"apnea_info": { "event_count": 7, "ahi": 0.88, "severity": "Healthy", "event_positions": [ { "event_id": 1, "duration_sec": 12, "start_sample": 83640, "end_sample": 83880 },... ] } }, "right": { ... 和left的数据结构一样 }, "report_id": 27, "mac": "C4:DE:E2:28:50:64", "sn":"" }, "ret": 0, "err_code": 0, "msg": "ok" } ``` >i 注:ret = 0 为成功 ## 失败返回示例 ```language { "ret": 4, "msg": "参数不能为空", "err_code": 10008 } ``` >d 注:ret > 0 为失败 ## 错误编号(errCode): 6 have no permission 9 解析Json出错 51 报告ID错误 10008 参数不能为空 10016 Key错误