Please note that the Apple HealthKit Workouts Export Format has been deprecated in favor of the Apple HealthKitV2 Workouts Export Format. This article should only be used for legacy exports, created prior to 11-April-2022.
Workouts in HealthKit have a unique data structure for capturing information specific to the participant’s workout.
Field | Description |
---|---|
HealthKitWorkoutKey |
A unique, auto-generated key for this workout. |
ParticipantIdentifier |
The identifier of the participant this task was for. Can be used to cross reference with Participants. |
ActivityType |
The type of activity undertaken during the workout. |
StartDate |
The start date of the workout, in ISO 8601 format. Includes timezone offset information. May be empty if no start date was recorded. |
Date |
The end date of the workout, in ISO 8601 format. Includes timezone offset information. |
Duration |
The duration of the workout, in seconds (if recorded). |
TotalDistance |
The distance traveled during the workout, in meters (if recorded). |
TotalEnergyBurned |
The energy burned during the workout, in kcal (if recorded). |
TotalFlightsClimbed |
The flights of stairs climbed during the workout (if recorded). |
TotalSwimmingStrokeCount |
The number of swimming strokes during the workout (if recorded). |
SourceIdentifier |
Uniquely identifies the iOS App which generated the reading. “com.apple.health.* ” indicates a reading from an Apple Device like the iPhone or Apple Watch. |
SourceName |
The name of the source app which generated the reading. In the case of a “com.apple.health.* ” SourceIdentifier , this is the name of the Apple Device used to generate the reading (e.g. “John’s iPhone”). |
SourceVersion |
The version of the source app which generated the reading. In the case of a “com.apple.health.* ” SourceIdentifier , this is the version of iOS or WatchOS on the device used to generate the reading. |
DeviceName |
The user-facing name for the device, if applicable. |
DeviceModel |
Model of the device used the generate the reading, if applicable. |
DeviceManufacturer |
Manufacturer of the device used the generate the reading, if applicable. |
DeviceHardwareVersion |
An arbitrary string representing the hardware version of the device, if applicable. |
DeviceSoftwareVersion |
An arbitrary string representing the version of the software running on the device, if applicable. |
DeviceFirmwareVersion |
An arbitrary string representing the current version of the firmware running on the device, if applicable. |
DeviceLocalIdentifier |
An identifier that uniquely identifies the device object on the hardware running this code, if applicable. |
DeviceFDAIdentifier |
The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI), if applicable. |
Metadata |
Additional XML metadata inserted by the source application. |
InsertedDate |
The creation date of the entry, in ISO 8601 format. Is always in UTC. |
Sample CSV Export
HealthKitWorkoutKey,ParticipantIdentifier,ActivityType,StartDate,Date,Duration,TotalDistance,TotalEnergyBurned,TotalFlightsClimbed,TotalSwimmingStrokeCount,SourceIdentifier,SourceName,SourceVersion,DeviceName,DeviceModel,DeviceManufacturer,DeviceHardwareVersion,DeviceSoftwareVersion,DeviceFirmwareVersion,DeviceFDAIdentifier,DeviceLocalIdentifier,Metadata,InsertedDate f0f972f4-b954-e811-8162-e6c7223c41fa,9205a702-423c-e811-815e-eba90450b141,Running,2018-04-06T12:10:12-04:00,2018-04-06T12:45:26-04:00,2114.32899594307,863.642877342056,102.917,,,com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476,Sample’s Apple Watch,4.1,,,,,,,,,"{""HKTimeZone"":""America\/Detroit""}",2018-05-11T01:23:53Z f1f972f4-b954-e811-8162-e6c7223c41fa,9205a702-423c-e811-815e-eba90450b141,Rowing,2018-04-05T15:37:53-04:00,2018-04-05T15:39:40-04:00,107.115283966064,,6.077,,,com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476,Sample’s Apple Watch,4.1,,,,,,,,,"{""HKTimeZone"":""America\/Detroit""}",2018-05-11T01:23:53Z f2f972f4-b954-e811-8162-e6c7223c41fa,9205a702-423c-e811-815e-eba90450b141,Running,2018-04-05T15:41:02-04:00,2018-04-05T15:43:39-04:00,151.452096939087,0,3.237,,,com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476,Sample’s Apple Watch,4.1,,,,,,,,,"{""HKTimeZone"":""America\/Detroit""}",2018-05-11T01:23:53Z
Sample JSON Export
{ "HealthKitWorkoutKey": "F0F972F4-B954-E811-8162-E6C7223C41FA", "ParticipantIdentifier": "9205a702-423c-e811-815e-eba90450b141", "ActivityType": "Running", "StartDate": "2018-04-06T12:10:12-04:00", "Date": "2018-04-06T12:45:26-04:00", "Duration": "2114.32899594307", "TotalDistance": "863.642877342056", "TotalEnergyBurned": "102.917", "Source": { "Identifier": "com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476", "Name": "Sample’s Apple Watch", "Version": "4.1" }, "Metadata": { "HKTimeZone": "America/Detroit" }, "InsertedDate": "2018-05-11T01:23:53Z" } { "HealthKitWorkoutKey": "F1F972F4-B954-E811-8162-E6C7223C41FA", "ParticipantIdentifier": "9205a702-423c-e811-815e-eba90450b141", "ActivityType": "Rowing", "StartDate": "2018-04-05T15:37:53-04:00", "Date": "2018-04-05T15:39:40-04:00", "Duration": "107.115283966064", "TotalEnergyBurned": "6.077", "Source": { "Identifier": "com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476", "Name": "Sample’s Apple Watch", "Version": "4.1" }, "Metadata": { "HKTimeZone": "America/Detroit" }, "InsertedDate": "2018-05-11T01:23:53Z" } { "HealthKitWorkoutKey": "F2F972F4-B954-E811-8162-E6C7223C41FA", "ParticipantIdentifier": "9205a702-423c-e811-815e-eba90450b141", "ActivityType": "Running", "StartDate": "2018-04-05T15:41:02-04:00", "Date": "2018-04-05T15:43:39-04:00", "Duration": "151.452096939087", "TotalDistance": "0", "TotalEnergyBurned": "3.237", "Source": { "Identifier": "com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476", "Name": "Sample’s Apple Watch", "Version": "4.1" }, "Events": [ { "HealthKitWorkoutEventKey": "43FC72F4-B954-E811-8162-E6C7223C41FA", "Date": "2018-04-05T15:41:05-04:00", "Type": "Pause", "Metadata": {} }, { "HealthKitWorkoutEventKey": "45FC72F4-B954-E811-8162-E6C7223C41FA", "Date": "2018-04-05T15:41:09-04:00", "Type": "Resume", "Metadata": {} }, { "HealthKitWorkoutEventKey": "44FC72F4-B954-E811-8162-E6C7223C41FA", "Date": "2018-04-05T15:41:46-04:00", "Type": "Pause", "Metadata": {} }, { "HealthKitWorkoutEventKey": "46FC72F4-B954-E811-8162-E6C7223C41FA", "Date": "2018-04-05T15:41:48-04:00", "Type": "Resume", "Metadata": {} } ], "Metadata": { "HKTimeZone": "America/Detroit" }, "InsertedDate": "2018-05-11T01:23:53Z" }