This article pertains to: LEGACY API (V1) INFORM (V2)
How are Apple Health sleep records processed by the Validic API?
For those who wear the Apple Watch to bed for sleep tracking purposes, watchOS 9 and iOS 16 bring new functionality – sleep stages. Our Apple Health integration is available to sync the following sleep stage details to Validic:
time in bed
total sleep duration
total awake duration
times awoken
total light sleep duration (core and unspecified)
total deep sleep duration
total REM sleep duration
Apple’s guidelines specify that sleep should be defined by in-bed time periods, with sleep stages (light, deep, REM, etc) occurring during an in-bed time range. The Apple Watch follows this approach and Validic’s processing of sleep data assumes that the sleep stages will overlap with an in bed record. Each 3rd party source in Apple Health will report a separate sleep record to Validic. You will be able to tell the original source of the data by looking at the sourcing information in the Validic sleep record.
Please note that Apple allows for a variety of 3rd party sources to report sleep data into the Health app and some sources may not follow Apple’s guidance on sleep reporting. Therefore, you may receive sleep records from some 3rd party sources but not others. If a 3rd party source does not report sleep with in-bed ranges then you will not receive the sleep records from that source.
Important Considerations:
In Apple Health, Sleep samples cannot be edited; they can only be deleted and re-created with different information.
Validic does not currently report any deletion events. Sleep samples that have already been processed will not be deleted from Validic if they are deleted from Apple Health.
In-Bed samples will generate new sleep records in Validic. The In-Bed start and end time will correspond to the start and end time on the Validic sleep record.
Only sleep samples that correspond with an in-bed time will be processed in Validic.