Garmin
By integrating the ROOK API, you gain access to Garmin data, enabling you to retrieve body, physical, and sleep information from your linked users. Our API collects raw data from Garmin, transforms it into structured data, and delivers it in JSON format via webhooks or API queries.
Garmin Available Data
This is the data available from Garmin that ROOK extracts:
Body Health
{
"body_metrics_event": [
"bone_composition_percentage_int",
"bmi_float",
"weight_kg_float",
"water_composition_percentage_int",
"muscle_composition_percentage_int"
]
}
Physical Health
{
"physical_activity_event": [
"pace_avg_min_per_km_float",
"activity_type_name_string",
"cadence_avg_rpm_float",
"steps_granular_data_array",
"cadence_granular_data_array",
"pace_maximum_min_per_km_float",
"power_granular_data_array",
"cadence_maximum_rpm_float",
"speed_maximum_meters_per_second_float",
"speed_granular_data_array",
"hr_maximum_bpm_int",
"calories_net_active_kcal_float",
"elevation_loss_actual_altitude_meters_float",
"activity_duration_seconds_int",
"traveled_distance_meters_float",
"elevation_gain_actual_altitude_meters_float",
"speed_avg_meters_per_second_float",
"activity_start_datetime_string",
"hr_granular_data_array",
"activity_end_datetime_string",
"position_start_object",
"traveled_distance_granular_data_array",
"steps_int",
"hr_avg_bpm_int",
"position_granular_data_array"
],
"physical_summary": [
"stress_maximum_level_int",
"hr_minimum_bpm_int",
"high_stress_duration_seconds_int",
"stress_duration_seconds_int",
"stress_at_rest_duration_seconds_int",
"vigorous_intensity_seconds_int",
"steps_int",
"hr_maximum_bpm_int",
"calories_net_active_kcal_float",
"stress_avg_level_int",
"traveled_distance_meters_float",
"hr_granular_data_array",
"floors_climbed_float",
"low_stress_duration_seconds_int",
"medium_stress_duration_seconds_int",
"hr_avg_bpm_int",
"active_seconds_int",
"moderate_intensity_seconds_int",
"calories_basal_metabolic_rate_kcal_float",
"hr_resting_bpm_int"
]
}
Sleep Health
{
"sleep_summary": [
"deep_sleep_duration_seconds_int",
"saturation_minimum_percentage_int",
"rem_sleep_duration_seconds_int",
"sleep_date_string",
"sleep_start_datetime_string",
"saturation_granular_data_array",
"breaths_minimum_per_min_int",
"breathing_granular_data_array",
"hrv_avg_rmssd_float",
"light_sleep_duration_seconds_int",
"sleep_end_datetime_string",
"breaths_minimum_per_min_int",
"breaths_avg_per_min_int",
"time_awake_during_sleep_seconds_int",
"saturation_avg_percentage_int",
"sleep_duration_seconds_int",
"hrv_rmssd_granular_data_array",
"saturation_maximum_percentage_int"
]
}
The data you receive depends on the permissions granted by the user when linking their data source.
Data Delivery
Our Garmin integration delivers notifications within minutes after a user completes an event and syncs their app. ROOK retrieves, processes, and delivers the data through our SDKs, providing you with user insights efficiently.
Start Extracting Garmin Data
To begin extracting health data from Garmin, follow these steps:
Step 1: Enable Data Source
Integrate Garmin into your application or digital solution through the endpoint provided by ROOK.
Step 2: Set Up Your Connections Page
Enable the Garmin data source on the connections page to allow your users to connect.
Step 3: Receive Your Users' Data
Once users connect to the data source, you will start receiving their data. Utilize this data to its full potential.
{
"version":[],
"data_structure": "",
"client_uuid": "",
"user_id": "",
"body_health": {},
"physical_health": {},
"Sleep_health": {},
}