Put your health front and center with iHealth mobile products

Request for data of Sleep Report

GET /openapiv2/user/ user-id/sleep/Get data of SleepReport.
GET /openapiv2/application/sleep/ Get All Sleep Report Data.

GET `/openapiv2/user/`user-id`/sleep/`

Response(JSON)
Response(XML)

https://api.ihealthlabs.com:8443/openapiv2/user/05dffbe0dd*****/sleep.json/?client_id=ddb9cbc759*****&client_secret=4738f9d00e*****&redirect_uri=http%3a%2f%2f+yourcallback.com%2f%3fthis%3dthat&access_token=xpoBt0ThQQ*****&page_index=1&sc=d63493704c*****&sv=68d3f571e6*****

The Request Content:
Important,
In the URL, 05dffbe0dd***** means the UserID retrieved by AccessToken, which is required; otherwise, the user information cannot be accessed.
In the URL, the value of sleep.json is the format of the data you want to fetch, we can support two different kinds of file packages, .json and .xml.

**Required Parameters:**
Parameter	Description
Client_id	The ID for the client request
client_secret	The key for the request
access_token	The token for access
sc	The serial number for the user
sv	This is type of one on one value based on sv

**Optional Parameters:**
Parameter	Default	Description
start_time	Date time minus 3 months	The Unix time of when the sleep data starts, ex:1572331655（starting from 1970-01-01 0:0:0 until the present date and time, the unit is second）
page_index	First page	The page index of data, which starts from 1
locale	Default (example in Appendix)	Set the locale / units returned
end_time	Date time plus 1 day	The Unix time of when the sleep data ends, it must be later than start_time. ex: 1572418091

The Response Content

**The returned values:**
Parameter	Description
SRDataList	The data detail of Sleep Awaken: Number of times awoken DataID: the unique identity Fallsleep: Time until asleep HoursSlept: The length of the sleep SleepEfficiency: Sleep efficiency Lat: the latitude of the testing place Lon: the longitude of the testing place StartTime: Start time of sleep EndTime: End time of sleep Note: the note of this data LastChangeTime: Time of last change (UTC) DataSource: Provides the data source. “Manual” is from manual data entries. “FromDevice” is for data acquired from iHealth devices TimeZone: Time zone of measurement location
CurrentRecordCount	The count of current page
NextPageUrl	The url of next page
PageLength	The length of one page
PageNumber	The current page
PrevPageUrl	The url of previous page
RecordCount	The total number of data records

https://api.ihealthlabs.com:8443/openapiv2/application/sleep.json/?client_id=ddb9cbc759*****&client_secret=4738f9d00e*****&redirect_uri=http%3a%2f%2f+yourcallback.com%2f%3fthis%3dthat&access_token=xpoBt0ThQQ*****&page_index=1&sc=d63493704c*****&sv=68d3f571e6*****

The Request Content:
Important,
In the URL, the value of sleep.json is the format of the data you want to fetch, we can support two different kinds of file packages, .json and .xml.

**Required Parameters:**
Parameter	Description
Client_id	The ID for the client request
client_secret	The key for the request
access_token	The token for access
sc	The serial number for the user
sv	This is type of one on one value based on sv

**Optional Parameters:**
Parameter	Default	Description
start_time	Date time minus 3 months	The Unix time of when the sleep data starts, ex:1572331655（starting from 1970-01-01 0:0:0 until the present date and time, the unit is second）
page_index	First page	The page index of data, which starts from 1
locale	Default (example in Appendix)	Set the locale / units returned
end_time	Date time plus 1 day	The Unix time of when the sleep data ends, it must be later than start_time. ex: 1572418091

The Response Content

**The returned values:**
Parameter	Description
SRDataList	The data detail of Sleep Awaken: Number of times awoken DataID: the unique identity Fallsleep: Time until asleep HoursSlept: the length of the sleep SleepEfficiency: sleep efficiency Lat: the latitude of the testing place Lon: the longitude of the testing place StartTime: Start time of sleep EndTime: End time of sleep MDate: measurement datetime userid: unique identity of user Note: the note of this data LastChangeTime: Time of last change (UTC) DataSource: Provides the data source. “Manual” is from manual data entries. “FromDevice” is for data acquired from iHealth devices TimeZone: Time zone of measurement location
CurrentRecordCount	The count of current page
NextPageUrl	The url of next page
PageLength	The length of one page
PageNumber	The current page
PrevPageUrl	The url of previous page
RecordCount	The total number of data records