Apple HealthKitV2 Statistics Export Format
- Updated
Statistics in HealthKit have a unique data structure for capturing information specific to the participant.
One file will be created per type of data (e.g., "DailySteps"). The file name will correspond to the type of data (e.g., "HealthKitV2Statistics_DailySteps_20211101-20211217").
Table of Contents
Data Fields
| Field | Description |
|---|---|
HealthKitStatisticKey |
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. |
ParticipantID |
The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID). |
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. |
Value |
The category value for this sample. |
Units |
The units of the characteristic value. |
InsertedDate |
The creation date of the entry, in ISO 8601 format. Is always in UTC. |
If a participant re-syncs their device, you may observe duplicate samples. HealthKit samples are immutable, so when doing data analysis, your team will need to remove any samples that have the same HealthKitStatisticKey and ParticipantIdentifier as another sample.
Sample CSV Export
HealthKitStatisticKey,ParticipantIdentifier,StartDate,Date,Value,Units,InsertedDate
37c75c56-f60b-5966-88c0-67175e835300,256263d8-3ffc-eb11-aaae-0afb9334277d,2021-08-06T00:00:00-04:00,2021-08-07T00:00:00-04:00,4813,count,2021-12-09T20:17:02Z
7a071f59-c1f8-5a23-9999-79fbf8306117,256263d8-3ffc-eb11-aaae-0afb9334277d,2021-09-20T00:00:00-04:00,2021-09-21T00:00:00-04:00,9678,count,2021-12-09T20:17:02Z
20561f76-6599-54b5-bbde-34ba2886158a,256263d8-3ffc-eb11-aaae-0afb9334277d,2021-10-31T00:00:00-04:00,2021-11-01T00:00:00-04:00,14436,count,2021-12-09T20:17:02Z
692dd8da-9b74-59dd-bc19-15d2a26be9e8,256263d8-3ffc-eb11-aaae-0afb9334277d,2021-11-09T00:00:00-05:00,2021-11-10T00:00:00-05:00,11791,count,2021-12-09T20:17:02Z
Sample JSON Export
{
"HealthKitStatisticKey":"eba660a6-18ae-5070-a629-c44edc8157c5",
"ParticipantIdentifier":"256263d8-3ffc-eb11-aaae-0afb9334277d",
"StartDate":"2021-12-07T00:00:00-05:00",
"Date":"2021-12-08T00:00:00-05:00",
"Value":"13385",
"Units":"count",
"InsertedDate":"2021-12-09T22:18:05Z"
}
{
"HealthKitStatisticKey":"032bfe45-cdc0-5cc8-b4ba-8ba06aa082c8",
"ParticipantIdentifier":"256263d8-3ffc-eb11-aaae-0afb9334277d",
"StartDate":"2021-09-16T00:00:00-04:00",
"Date":"2021-09-17T00:00:00-04:00",
"Value":"13255",
"Units":"count",
"InsertedDate":"2021-12-09T20:17:02Z"
}
Was this article helpful?