Oura Sleep Export Format
- Updated
The Oura Sleep Export returns sleep data for the specified Oura wearer within a given timeframe. A wearer can have multiple sleep periods per day.
- File Prefix: `OuraSleep`
- Sleep Heart Rate File Prefix (for CSV Format): `OuraSleepHeartRate`
- Sleep Hrv File Prefix (for CSV Format): `OuraSleepHrv`
For a complete list of all the export file types possible, see the Oura Export Overview.
Oura Sleep Data Fields
Field | Description |
---|---|
SleepKey |
The unique key for this sleep record, formatted as `ParticipantID_ID`. Used to reference heart rate and hrv values to their parent activity record in CSV format export. |
ParticipantID |
The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID). |
ParticipantIdentifier |
The identifier of the participant this record is for. Can be used to cross reference with Participants. |
InsertedDate |
The creation date of the entry, in ISO 8601 format. Is always in UTC. |
ID |
string(id) |
Day |
Day that the sleep belongs to, in YYYY-MM-DD format. |
AverageBreath |
Average breathing rate during sleep as breaths/second. |
AverageHeartRate |
Average heart rate during sleep as beats/minute. |
AverageHrv |
Average heart rate variability during sleep. |
AwakeTime |
Duration spent awake in seconds. |
BedtimeEnd |
Bedtime end of the sleep, in ISO 8601 format. |
BedtimeStart |
Bedtime start of the sleep, in ISO 8601 format. |
DeepSleepDuration |
Duration spent in deep sleep in seconds. |
Efficiency |
Sleep efficiency rating in range [1, 100]. |
Latency |
Sleep latency in seconds. This is the time it took for the wearer to fall asleep after going to bed. |
LightSleepDuration |
Duration spent in light sleep in seconds. |
LowBatteryAlert |
Flag indicating if a low battery alert occurred. |
LowestHeartRate |
Lowest heart rate during sleep. |
Movement30Sec |
30-second movement classification for the period where every character corresponds to:
|
Period |
ECore sleep period identifier. |
HeartRateInterval |
Interval in seconds between the heart rate samples, in JSON format only. |
HeartRateItems |
The wearer's heart rate, in beats per minute, at the specified `HeartRateInterval` during the session, in JSON format only. |
HeartRateTimestamp |
Timestamp when the heart rate recording started, in JSON format only, in ISO 8601 format. |
HrvInterval |
Interval in seconds between the heart rate variability records, in JSON format only. |
HrvItems |
The wearer's heart rate variability, at the specified `HrvInterval` during the session, in JSON format only. |
HrvTimestamp |
Timestamp when the heart rate variability sample recording started, in JSON format only, in ISO 8601 format. |
Readiness |
Object containing the readiness details for this sleep. As opposed to the daily readiness object which represents the readiness for the entire day. |
ReadinessScore |
Daily readiness score. |
ReadinessTemperatureDeviation |
Temperature deviation in degrees Celsius. |
ReadinessTemperatureTrendDeviation |
Temperature trend deviation in degrees Celsius. |
ReadinessContributorsActivityBalance |
Contribution of cumulative activity balance in range [1, 100]. |
ReadinessContributorsBodyTemperature |
Contribution of body temperature in range [1, 100]. |
ReadinessContributorsHrvBalance |
Contribution of heart rate variability balance in range [1, 100]. |
ReadinessContributorsPreviousDayActivity |
Contribution of previous day's activity in range [1, 100]. |
ReadinessContributorsPreviousNight |
Contribution of previous night's sleep in range [1, 100]. |
ReadinessContributorsRecoveryIndex |
Contribution of recovery index in range [1, 100]. |
ReadinessContributorsRestingHeartRate |
Contribution of resting heart rate in range [1, 100]. |
ReadinessContributorsSleepBalance |
Contribution of sleep balance in range [1, 100]. |
ReadinessScoreDelta |
Effect on readiness score caused by this sleep period. |
RemSleepDuration |
Duration spent in REM sleep in seconds. |
RestlessPeriods |
Number of restless periods during sleep. |
SleepPhase5Min |
5-minute sleep phase classification for the period where every character corresponds to:
|
SleepScoreDelta |
Effect on sleep score caused by this sleep period. |
SleepAlgorithmVersion |
Version of the sleep algorithm used to calculate the sleep data. |
TimeInBed |
Duration spent in bed in seconds. |
TotalSleepDuration |
Total sleep duration in seconds. |
Type |
Enum: "deleted" "sleep" "long_sleep" "late_nap" "rest"
|
ParentKey |
The parent SleepKey this item belongs to, in CSV format only. |
StartDateTime |
The start date and time of this heart rate or hrv item recording, in in ISO 8601 format, in CSV format only. |
EndDateTime |
The end date and time of this heart rate or hrv item recording, in in ISO 8601 format, in CSV format only. |
Value |
The recorded sample heart rate or hrv item, in CSV format only. |
Sample CSV Exports
Oura Sleep
SleepKey,ParticipantID,ParticipantIdentifier,InsertedDate,ID,Day,AverageBreath,AverageHeartRate,AverageHrv,AwakeTime,BedtimeEnd,BedtimeStart,DeepSleepDuration,Efficiency,Latency,LightSleepDuration,LowBatteryAlert,LowestHeartRate,Movement30Sec,Period,ReadinessScore,ReadinessTemperatureDeviation,ReadinessTemperatureTrendDeviation,ReadinessContributorsActivityBalance,ReadinessContributorsBodyTemperature,ReadinessContributorsHrvBalance,ReadinessContributorsPreviousDayActivity,ReadinessContributorsPreviousNight,ReadinessContributorsRecoveryIndex,ReadinessContributorsRestingHeartRate,ReadinessContributorsSleepBalance,ReadinessScoreDelta,RemSleepDuration,RestlessPeriods,SleepPhase5Min,SleepScoreDelta,SleepAlgorithmVersion,TimeInBed,TotalSleepDuration,Type
6e2626f8-e891-ed11-98ad-f4ce23710c45_a7e52291-8166-46fd-addd-b271d1baf7fe,6e2626f8-e891-ed11-98ad-f4ce23710c45,46ce54ac-e891-ed11-98ad-f4ce23710c45,2025-03-13T23:12:07Z,a7e52291-8166-46fd-addd-b271d1baf7fe,2025-02-01,12.125,58.25,41,4320,2025-02-01T07:12:01-05:00,2025-01-31T23:16:01-05:00,3480,85,3000,15180,False,50,,0,81,0.23,0.15,90,86,73,86,73,60,100,86,0,5580,215,,0,v2,28560,24240,long_sleep
6e2626f8-e891-ed11-98ad-f4ce23710c45_56bad3e0-8180-4a3e-8174-a1297e2fc50a,6e2626f8-e891-ed11-98ad-f4ce23710c45,46ce54ac-e891-ed11-98ad-f4ce23710c45,2025-03-13T23:12:07Z,56bad3e0-8180-4a3e-8174-a1297e2fc50a,2025-02-02,12.375,60,26,11280,2025-02-02T08:18:01-05:00,2025-02-01T22:44:01-05:00,210,67,1110,18540,False,53,,0,77,-0.07,0.02,87,100,68,72,53,100,78,86,0,4410,185,,0,v2,34440,23160,long_sleep
6e2626f8-e891-ed11-98ad-f4ce23710c45_0d6dba14-b547-41c6-8118-64dde3126eb9,6e2626f8-e891-ed11-98ad-f4ce23710c45,46ce54ac-e891-ed11-98ad-f4ce23710c45,2025-03-13T23:12:07Z,0d6dba14-b547-41c6-8118-64dde3126eb9,2025-02-02,12.375,60,34,721,2025-02-02T15:28:32-05:00,2025-02-02T14:19:31-05:00,1350,83,540,2040,False,61,,1,47,,0.02,87,,77,72,1,13,9,55,,30,4,,,v2,4141,3420,sleep
6e2626f8-e891-ed11-98ad-f4ce23710c45_cc4cff63-6729-4fe4-800f-27f85c5eadef,6e2626f8-e891-ed11-98ad-f4ce23710c45,46ce54ac-e891-ed11-98ad-f4ce23710c45,2025-03-13T23:12:07Z,cc4cff63-6729-4fe4-800f-27f85c5eadef,2025-02-03,12.125,60.125,35,5280,2025-02-03T06:57:01-05:00,2025-02-02T22:54:01-05:00,3330,82,3060,16080,False,55,,0,78,0.03,0.13,93,100,79,73,63,100,61,86,0,4290,147,,0,v2,28980,23700,long_sleep
Oura Sleep Heart Rate
ParentKey,StartDateTime,EndDateTime,Value
6e2626f8-e891-ed11-98ad-f4ce23710c45_a7e52291-8166-46fd-addd-b271d1baf7fe,2025-01-31T23:16:01-05:00,2025-01-31T23:21:01-05:00,54
6e2626f8-e891-ed11-98ad-f4ce23710c45_a7e52291-8166-46fd-addd-b271d1baf7fe,2025-01-31T23:21:01-05:00,2025-01-31T23:26:01-05:00,54
6e2626f8-e891-ed11-98ad-f4ce23710c45_a7e52291-8166-46fd-addd-b271d1baf7fe,2025-01-31T23:26:01-05:00,2025-01-31T23:31:01-05:00,55
Oura Sleep Hrv
ParentKey,StartDateTime,EndDateTime,Value
6e2626f8-e891-ed11-98ad-f4ce23710c45_a7e52291-8166-46fd-addd-b271d1baf7fe,2025-01-31T23:16:01-05:00,2025-01-31T23:21:01-05:00,59
6e2626f8-e891-ed11-98ad-f4ce23710c45_a7e52291-8166-46fd-addd-b271d1baf7fe,2025-01-31T23:21:01-05:00,2025-01-31T23:26:01-05:00,31
6e2626f8-e891-ed11-98ad-f4ce23710c45_a7e52291-8166-46fd-addd-b271d1baf7fe,2025-01-31T23:26:01-05:00,2025-01-31T23:31:01-05:00,48
Sample JSON Export
{
"SleepKey": "6e2626f8-e891-ed11-98ad-f4ce23710c45_a7e52291-8166-46fd-addd-b271d1baf7fe",
"ParticipantID": "6e2626f8-e891-ed11-98ad-f4ce23710c45",
"ParticipantIdentifier": "46ce54ac-e891-ed11-98ad-f4ce23710c45",
"InsertedDate": "2025-03-13T23:12:07Z",
"ID": "a7e52291-8166-46fd-addd-b271d1baf7fe",
"Day": "2025-02-01",
"AverageBreath": 12.125,
"AverageHeartRate": 58.25,
"AverageHrv": 41,
"AwakeTime": 4320,
"BedtimeEnd": "2025-02-01T07:12:01-05:00",
"BedtimeStart": "2025-01-31T23:16:01-05:00",
"DeepSleepDuration": 3480,
"Efficiency": 85,
"HeartRate": {
"Interval": 300.0,
"Items": [
null, null, null, null, null, null, null, null, null, null,
54.0, 54.0, 55.0, 55.0, 53.0, 52.0, 53.0, 57.0, 56.0, 58.0,
56.0, 58.0, 60.0, 59.0, 56.0, 56.0, 58.0, 58.0, 58.0, 57.0,
58.0, 57.0, 57.0, 57.0, 57.0, 58.0, 59.0, 60.0, 59.0, 56.0,
55.0, 56.0, 54.0, 58.0, 58.0, 58.0, 58.0, 58.0, 58.0, 58.0,
59.0, 55.0, 50.0, 53.0, 59.0, 62.0, 59.0, 60.0, 59.0, 59.0,
59.0, 57.0, 54.0, 54.0, 55.0, 55.0, 56.0, 56.0, 56.0, 56.0,
55.0, 53.0, 55.0, 55.0, 55.0, 58.0, 58.0, 58.0, 58.0, 58.0,
58.0, 56.0, 59.0, 57.0, 57.0, 57.0, 58.0, 56.0, 57.0, 54.0,
54.0, 55.0, 55.0, null, null, null
],
"Timestamp": "2025-01-31T23:16:01-05:00"
},
"Hrv": {
"Interval": 300.0,
"Items": [
null, null, null, null, null, null, null, null, null, null,
59.0, 31.0, 48.0, 55.0, 40.0, 89.0, 53.0, 39.0, 44.0, 33.0,
44.0, 27.0, 44.0, 26.0, 63.0, 69.0, 50.0, 71.0, 26.0, 32.0,
34.0, 51.0, 56.0, 33.0, 46.0, 51.0, 49.0, 21.0, 22.0, 42.0,
56.0, 21.0, 69.0, 30.0, 39.0, 38.0, 34.0, 34.0, 39.0, 39.0,
36.0, 76.0, 121.0, 44.0, 37.0, 24.0, 43.0, 37.0, 47.0, 57.0,
33.0, 32.0, 54.0, 39.0, 22.0, 20.0, 20.0, 20.0, 20.0, 21.0,
59.0, 69.0, 32.0, 64.0, 64.0, 48.0, 42.0, 48.0, 55.0, 50.0,
44.0, 41.0, 41.0, 24.0, 25.0, 23.0, 21.0, 70.0, 47.0, 57.0,
30.0, 21.0, 26.0, null, null, null
],
"Timestamp": "2025-01-31T23:16:01-05:00"
},
"Latency": 3000,
"LightSleepDuration": 15180,
"LowBatteryAlert": false,
"LowestHeartRate": 50,
"Period": 0,
"Readiness": {
"Contributors": {
"ActivityBalance": 90,
"BodyTemperature": 86,
"HrvBalance": 73,
"PreviousDayActivity": 86,
"PreviousNight": 73,
"RecoveryIndex": 60,
"RestingHeartRate": 100,
"SleepBalance": 86
},
"Score": 81,
"TemperatureDeviation": 0.23,
"TemperatureTrendDeviation": 0.15
},
"ReadinessScoreDelta": 0,
"RemSleepDuration": 5580,
"RestlessPeriods": 215,
"SleepScoreDelta": 0,
"SleepAlgorithmVersion": "v2",
"TimeInBed": 28560,
"TotalSleepDuration": 24240,
"Type": "long_sleep"
}
Was this article helpful?