API ReferenceReadings Sleep Mat Duration

Record Sleep Mat Duration Reading

Records a sleep mat duration reading based on the provided request. Either a device ID, device identifier, or patient ID is required.

Headers

Impilo-API-KeystringRequired

Request

This endpoint expects an object.
bodyTurnOverintegerRequired
Number of times the subject rolled over during the recorded period.
deepSleepintegerRequired
Number of minutes of detected deep sleep.
durationstringRequired
Duration of sleep during tracked period.
heartRateintegerRequired
Average heart rate per minutes during recorded period.
lightSleepintegerRequired
Number of minutes of detected light sleep.
readingTimestampstringRequiredformat: "date-time"
The UTC timestamp at which the reading was taken.
remintegerRequired
Number of minutes of detected rem sleep.
respirationintegerRequired
Respiratory rate per minute during sleep.
deviceIdlongOptional
The id of the device that took the reading.
deviceIdentifierstringOptional
The device identifier of the device that took the reading.
deviceTimeZoneOffsetintegerOptional
The offset of the device's timezone from UTC in seconds. Null if unavailable.
manualbooleanOptional
True if the reading value was entered manually, false or null otherwise.
patientIdlongOptional
The id of the patient that took the reading.

Response

OK
readingTimestampstringformat: "date-time"
The UTC timestamp at which the reading was taken.
bodyTurnOverinteger or null
deepSleepinteger or null
deviceobject or null
A device is an instance of an item. Impilo creates device records for items that are serialized, i.e., items where each individual unit is identified by a serial number, IMEI, or other identifier.
deviceTimeZoneOffsetinteger or null
The offset of the device's timezone from UTC in seconds. Null if unavailable.
durationstring or null
heartRateinteger or null
idlong or null
Unique identifier for the reading.
itemobject or null

An item is any of the supplies handled by Impilo. Examples include medical devices like a blood pressure monitor or weight scale, but the term ‘item’ also refers to non-medical supplies like AAA batteries and package inserts. A customer catalog is a subset of all items supported by Impilo. This is set during onboarding and may be modified by your account manager at any time. A customer may view the items in their catalog.

lightSleepinteger or null
manualboolean or null
True if the reading value was entered manually, false or null otherwise.
patientobject or null
The Patient resource represents a patient in the Impilo system. It includes personal information, contact details, and enrollment status.
patientTimeZoneOffsetinteger or null
The offset of the patient's timezone from UTC in seconds. Null if unavailable.
reminteger or null
respirationinteger or null