Skip to main content

Project Device Data Export

  • Updated

If your project utilizes device data points aside from the standard device data offerings (e.g., Apple Health, Fitbit, Garmin, Google Fit), you may wish to enable the ProjectDeviceData export. The data in this export corresponds to the data available via the device data API. 

You will need to contact us in order to have the ProjectDeviceData export enabled for your project.

Table of Contents

Data Fields

Field Description
DeviceDataKey A unique, auto-generated key for the project device data file.
Identifier

String used to name a device data point.
DeviceDataContextID
 		Identifier for a group of device data points, which share some context. Will be null if the device data point isn’t grouped.
ParticipantID The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).
ParticipantIdentifier The MyDataHelps identifier of the participant. Can be used to cross reference with Participants.
Type The general category this device data point belongs in, or what the device data represents. This field is a freeform string controlled by the source system based on its chosen categories.
Value

The value of the recorded data point.
Units

The units, if any, that the data was recorded in.
Properties An object whose key-value pairs represent metadata associated with this device data point. The metadata will vary depending on the source application.
StartDate The date at which this device data point began being recorded (for data that is recorded over time), in ISO 8601 format.
ObservationDate The date at which this device data point was completely recorded, in ISO 8601 format.
InsertedDate Date when the record was created, in ISO 8601 format. Is always in UTC.
ModifiedDate Date when the record was last modified, in ISO 8601 format. Is always in UTC.

Sample CSV Export

DeviceDataKey,Identifier,DeviceDataContextID,ParticipantID,ParticipantIdentifier,Type,Value,Units,Properties,StartDate,ObservationDate,InsertedDate,ModifiedDate
24E63F16-34E7-EC11-AAAD-85DD36217E6F,NULL,NULL,FB63D8DC-F4DC-EC11-AAAD-85DD36217E6F,3a12884d-b9aa-401d-a222-81d119df2929,CustomType1,0,NULL,{"CustomProperty1":"100","CustomProperty2":"200"},2022-04-09T00:00:00+00:00,2022-04-10T00:00:00+00:00,2022-06-08T14:05:44Z,2022-06-08T14:05:44Z

Sample JSON Export

{
    "DeviceDataKey": "24E63F16-34E7-EC11-AAAD-85DD36217E6F",
    "ParticipantID": "FB63D8DC-F4DC-EC11-AAAD-85DD36217E6F",
    "ParticipantIdentifier": "3a12884d-b9aa-401d-a222-81d119df2929",
    "Type": "CustomType1",
    "Value": "0",
    "Properties": {
        "CustomProperty1":"100",
        "CustomProperty2":"200"
    },
    "StartDate": "2022-04-09T00:00:00+00:00",
    "ObservationDate": "2022-04-10T00:00:00+00:00",
    "InsertedDate": "2022-06-08T14:05:44Z",
    "ModifiedDate": "2022-06-08T14:05:44Z"
}

Was this article helpful?