Skip to main content

Oura Rest Mode Period Export Format

  • Updated

The Oura Rest Mode Period Export contains information about rest mode periods, including the start, end time, and details of the rest mode period. 

  • File Prefix: `OuraRestModePeriod`
  • Rest Mode Period Episodes File Prefix (CSV Format Only): `OuraRestModePeriodEpisodes`

For a complete list of all the export file types possible, see the Oura Export Overview.

Data Fields

Field Description
RestModePeriodKey The unique key for this rest mode period record, formatted as `ParticipantID_ID`. Used to reference rest mode period episode values to their parent 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 the activity summary 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)
StartDay

Start date of rest mode, in YYYY-MM-DD format.
StartTime

Timestamp when rest mode period started, in ISO 8601 format.
EndDay

End date of rest mode, in YYYY-MM-DD format.

 
EndTime

Timestamp when rest mode period ended, in ISO 8601 format.
Episodes Collection of episodes during rest mode period, consisting of tags and a timestamp, in ISO 8601 format. In JSON format only.
ParentKey The parent RestModePeriodKey this item belongs to, in CSV format only.
EpisodeIndex Index of episodes for rest mode period episodes, in CSV format only.
TagIndex Index of tags for rest mode period episodes, in CSV format only.
Tag

Tags selected for the episode, in CSV format only.
EpisodeTimestamp Timestamp indicating when the episode occurred, in CSV format only.

Sample CSV Export

Oura Rest Mode Period

RestModePeriodKey,ParticipantID,ParticipantIdentifier,InsertedDate,ID,StartDay,StartTime,EndDay,EndTime
a466ec83-9092-45be-b11a-0f3baf76fc3c_57388218-bc25-4762-af38-c758c3bb746c,a466ec83-9092-45be-b11a-0f3baf76fc3c,271981b0-9504-4a8f-9d36-a2c2022a1f2f,2025-03-10T18:49:08Z,57388218-bc25-4762-af38-c758c3bb746c,2024-12-12,2024-12-12T07:02:44-05:00,2024-12-15,2024-12-15T07:34:12-05:00
a466ec83-9092-45be-b11a-0f3baf76fc3c_ef88858c-0d68-4322-ad10-4f8d638e8dba,a466ec83-9092-45be-b11a-0f3baf76fc3c,271981b0-9504-4a8f-9d36-a2c2022a1f2f,2025-03-10T18:49:08Z,ef88858c-0d68-4322-ad10-4f8d638e8dba,2025-01-10,2025-01-10T07:07:00-05:00,2025-01-18,2025-01-18T10:27:22-05:00

Oura Rest Mode Period Episodes

ParentKey,EpisodeIndex,TagIndex,Tag,EpisodeTimestamp
a466ec83-9092-45be-b11a-0f3baf76fc3c_57388218-bc25-4762-af38-c758c3bb746c,0,0,tag_generic_covid19_vaccine,2024-12-12T07:02:44.646-05:00
a466ec83-9092-45be-b11a-0f3baf76fc3c_57388218-bc25-4762-af38-c758c3bb746c,0,1,abc,2024-12-12T07:02:44.646-05:00
a466ec83-9092-45be-b11a-0f3baf76fc3c_57388218-bc25-4762-af38-c758c3bb746c,1,0,def,2024-12-13T07:02:44.646-05:00

Sample JSON Export

{
    "RestModePeriodKey": "a466ec83-9092-45be-b11a-0f3baf76fc3c_57388218-bc25-4762-af38-c758c3bb746c",
    "ParticipantID": "a466ec83-9092-45be-b11a-0f3baf76fc3c",
    "ParticipantIdentifier": "271981b0-9504-4a8f-9d36-a2c2022a1f2f",
    "InsertedDate": "2025-03-10T18:49:08Z",
    "ID": "57388218-bc25-4762-af38-c758c3bb746c",
    "StartDay": "2024-12-12",
    "StartTime": "2024-12-12T07:02:44-05:00",
    "EndDay": "2024-12-15",
    "EndTime": "2024-12-15T07:34:12-05:00",
    "Episodes": [
        {
        "Tags": ["tag_generic_covid19_vaccine", "abc"],
        "Timestamp": "2024-12-12T07:02:44.646-05:00"
        },
        {
        "Tags": ["def"],
        "Timestamp": "2024-12-13T07:02:44.646-05:00"
        }
    ]
}

Was this article helpful?