Skip to content
  • There are no suggestions because the search field is empty.

Data Scopes Export Format

Data Scopes contains a list of the provider-specific authorization scopes for providers in the "Device Manufacturer" category. These authorization scopes determine which types of participant device data may be retrieved from the provider. 

Data Fields

Field Description
ExternalAccountID

Integer identifier specific to the account.

ParticipantID

The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).

ParticipantIdentifier

The identifier of the participant that connected the external account. Can be used to cross reference with Participants.

Status

The status field can contain the following values:

Unauthorized: The connection credentials are incorrect (and the participant should reconnect).

Error: There was an error with the most recent data fetch.

FetchComplete: The most recent data fetch was successful.

LastRefreshDate

The timestamp for the most recent fetch of data from the account connection, in UTC.

ProviderID

Integer identifier specific to the provider. This data field is automatically set.

ProviderName

Name of the provider. This data field is automatically set.

ProviderCategory

Category such as Device Manufacturer.

ConnectionDate

The timestamp for when the provider account was first connected by the participant, in UTC.

ProviderUserID

The external account provider’s internal identifier corresponding to this participant.

DataScopes Provider-specific authorization scopes. For example: "ACTIVITY_EXPORT, HEALTH_EXPORT"

Sample CSV Export

ExternalAccountID,ParticipantID,ParticipantIdentifier,Status,LastRefreshDate,ProviderID,ProviderName,ProviderCategory,ConnectionDate,ProviderUserID,DataScopes
1,28596c6c-03c8-4b32-9234-231a53556936,MDH-1234,FetchComplete,2023-01-02T03:04:05,2,Fitbit,Device Manufacturer,2023-01-02T03:04:05,6709dc13-ca3e-4969-886a-fe0889eb8256,profile sleep oxygen_saturation respiratory_rate temperature electrocardiogram settings weight activity heartrate nutrition cardio_fitness

Sample JSON Export

{
""ExternalAccountID"": 1,
""ParticipantID"": ""28596c6c-03c8-4b32-9234-231a53556936"",
""ParticipantIdentifier"": ""MDH-1234"",
""Status"": ""FetchComplete"",
""LastRefreshDate"": ""2023-01-02T03:04:05"",
""Provider"":
{
""ID"": 2,
""Name"": ""Fitbit"",
""Category"": ""Device Manufacturer""
}
""ConnectionDate"": ""2023-01-02T03:04:05""
""ProviderUserID"": ""6709dc13-ca3e-4969-886a-fe0889eb8256""
""DataScopes"": ""profile sleep oxygen_saturation respiratory_rate temperature electrocardiogram settings weight activity heartrate nutrition cardio_fitness""
}