Garmin Health API Data - Stress, Body Battery & Respiration Summaries


This Guide will help you setup the Garmin Account to start collecting Garmin Health summary data and retrieve the data from the mEMA Website.


Setup Garmin Companion


In order to be able to see Garmin Data summary, first you need to follow the steps bellow in order connect mEMA participant account with a Garmin account.


  • Step 1: Create participant account
    • Before you begin, make sure you have a mobile code created for your participant
  • Step 2: Register with Garmin Companion
    • Go to "My mEMA" dropdown menu
    • Select "Garmin Companion Registration"

  • Step 3: Input Mobile Code
    • Enter the mobile code for the participant. (This has to be done one participant/mobile code at a time)
    • Click on "Submit" button
    • You will be redirect to the Garmin Website
  • Step 4: Garmin Connect Login
    • On the Garmin website, input the participant's Garmin Connect login credentials. (if they have not created their credentials, follow Steps 5 and 6)
  • Step 5: Create a Free Garmin Account (if necessary)
    • Participants can use a temporary email generator website to create a temporary email address. This website is a good option for this: https://temp-mail.org/en/
    • Use this email to create a free Garmin account on the Garmin Connect app.
  • Step 6: Link Mobile Code to Garmin Connect App
    • Ensure the participant has created their free account on the Garmin Connect app on their phone.
    • Once done, input their credentials on the Garmin Connect website to link their mobile code to the app.
    • Connect your Garmin Device with the Garmin Connect app and finish the Onboarding process



IMPORTANT NOTE!

  • If on Step 3 you are not presented with the Login Form, then you must stop the process, go to Garmin Connect website and log out from the account you're currently logged in. If you continue the process then you might end up linking multiple participant accounts (mobile codes) with the same Garmin account, which will cause for misleading data.


Retrieve Stress Summary Data


After you finished connecting the mEMA participant account (Mobile code) with Garmin Connect you can go on the Garmin Health API Data page on the mEMA website and download the Stress level data for your participant.


Steps:

1. Under "My mEMA" dropdown Select Garmin Health API Data

2. From the "Type of Data" dropdown select "Stress Level"

3. From the list of participants select the participant(s) you wish to view the Stress Level data

  • By Default all available mobile codes will be selected
  • Mobile codes that are Grayed out are not connected through the Garmin Companion Registration therefore there's no data to be retrieved from them

4. Input your Date Range

5. Click on Generate Report

6. If there's data available a CSV file will be generated and will be available to be downloaded


In the CSV file, for each participant, you will see the Summary Stress level throughout the day in 3 minutes interval time:

Note: The data for the previous day becomes available at the start of the following day.

Important: Duplicate times will appear only if there are different values are recorded for those times. Each time the participant does a Sync on Garmin Connect, new data but also recalculated data is sent to the server. If you ever have 2 (or more) rows with different values but same time, the latest row should be the most accurate.


Each Stress Level Summary data may contain the following information:


Property
Type
Description
Respondent ID
IntegermEMA participant ID
Mobile CodeIntegermEMA participant Mobile Code
Stress Level ValueInteger
Participant summary of stress value occurs 3 minutes interval
Time LocalInteger
The calendar date this summary would be displayed on in Garmin Connect. The date format is ‘yyyy-mm-dd’.
Time UTCInteger
The calendar date this summary would be displayed on in Garmin Connect. The date format is ‘yyyy-mm-dd’, in UTC time.
TimestampIntegerStart time of the summary in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).



Retrieve Body Battery Data


After you finished connecting the mEMA participant account (Mobile code) with Garmin Connect you can go on the Garmin Health API Data page on the mEMA website and download the Body Battery data for your participant.


Steps:

1. Under "My mEMA" dropdown Select Garmin Health API Data

2. From the "Type of Data" dropdown select "Body Battery"

3. From the list of participants select the participant(s) you wish to view the Body Battery data

  • By Default all available mobile codes will be selected
  • Mobile codes that are Grayed out are not connected through the Garmin Companion Registration therefore there's no data to be retrieved from them

4. Input your Date Range

5. Click on Generate Report

6. If there's data available a CSV file will be generated and will be available to be downloaded


In the CSV file, for each participant, you will see the Body Battery Summary throughout the day in 3 minutes interval time:

Note: The data for the previous day becomes available at the start of the following day.

Important: Duplicate times will appear only if there are different values are recorded for those times. Each time the participant does a Sync on Garmin Connect, new data but also recalculated data is sent to the server. If you ever have 2 (or more) rows with different values but same time, the latest row should be the most accurate.


Each Body Battery data may contain the following information:


Property
Type
Description
Respondent ID
IntegermEMA participant ID
Mobile CodeIntegermEMA participant Mobile Code
Body Battery ValueInteger
Participant summary of Body Battery value occurs 3 minutes interval
Time LocalInteger
The calendar date this summary would be displayed on in Garmin Connect. The date format is ‘yyyy-mm-dd’.
Time UTCInteger
The calendar date this summary would be displayed on in Garmin Connect. The date format is ‘yyyy-mm-dd’, in UTC time.
TimestampIntegerStart time of the summary in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).




Retrieve Respiration Summaries Data


After you finished connecting the mEMA participant account (Mobile code) with Garmin Connect you can go on the Garmin Health API Data page on the mEMA website and download the Respiration data for your participant.


Steps:

1. Under "My mEMA" dropdown Select Garmin Health API Data

2. From the "Type of Data" dropdown select "Respiration"

3. From the list of participants select the participant(s) you wish to view the Respiration data

  • By Default all available mobile codes will be selected
  • Mobile codes that are Grayed out are not connected through the Garmin Companion Registration therefore there's no data to be retrieved from them

4. Input your Date Range

5. Click on Generate Report

6. If there's data available a CSV file will be generated and will be available to be downloaded


In the CSV file, for each participant, you will see the Respiration Rate throughout the day:


Note: The data for the previous day becomes available at the start of the following day.

Important

- Respiration Summaries are recorded each minute, however if you see gaps in the data is because either the participant took the watch off, if you see large gaps, or if you see smaller gaps this is because: "During an activity or movement, the ability to read and record HRV from the optical heart rate sensor on the watch may be impacted. When this occurs, respiration data may not be captured or the data captured may be inaccurate."

Duplicate times will appear only if there are different values are recorded for those times. Each time the participant does a Sync on Garmin Connect, new data but also recalculated data is sent to the server. If you ever have 2 (or more) rows with different values but same time, the latest row should be the most accurate.


Each Respiration Summaries data may contain the following information:


Property
Type
Description
Respondent ID
IntegermEMA participant ID
Mobile CodeIntegermEMA participant Mobile Code
Breaths Per Minute ValueFloat
Summary of Respiration Rate during 1 minute interval
Time LocalInteger
The calendar date this summary would be displayed on in Garmin Connect. The date format is ‘yyyy-mm-dd’.
Time UTCInteger
The calendar date this summary would be displayed on in Garmin Connect. The date format is ‘yyyy-mm-dd’, in UTC time.
TimestampIntegerStart time of the summary in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).