Skip to main content

Withings

By integrating the ROOK API, you gain access to Withings data, enabling you to retrieve body, physical, and sleep information from your linked users. Our API collects raw data from Withings, transforms it into structured data, and delivers it in JSON format via webhooks or API queries.

Withings.png

Withings Available Data​

This is the data available from Withings that ROOK extracts:

Body Health​

{
    "body_blood_pressure_event": [
      "blood_pressure_avg_object"
    ],
    "body_metrics_event": [
      "weight_kg_float"
    ],
    "body_heart_rate_event": [],
    "physical_heart_rate_event": [
      "hr_avg_bpm_int"
    ],
    "body_oxygenation_event": [
      "saturation_avg_percentage_int"
    ],
    "body_temperature_event": [
      "temperature_avg_object"
    ]
}

Physical Health​

{
    "physical_activity_event": [
      "swimming_num_laps_int",
      "swimming_pool_length_meters_float",
      "activity_duration_seconds_int",
      "rest_seconds_int",
      "steps_int",
      "hr_avg_bpm_int",
      "walked_distance_meters_float",
      "activity_start_datetime_string",
      "hr_minimum_bpm_int",
      "hr_maximum_bpm_int",
      "activity_end_datetime_string",
      "calories_net_active_kcal_float"
    ],
    "physical_summary": [
      "calories_expenditure_kcal_float",
      "vigorous_intensity_seconds_int",
      "hr_avg_bpm_int",
      "walked_distance_meters_float",
      "active_seconds_int",
      "moderate_intensity_seconds_int",
      "low_intensity_seconds_int",
      "hr_minimum_bpm_int",
      "hr_maximum_bpm_int",
      "calories_net_active_kcal_float"
    ],
}

Sleep Health​

{
    "sleep_summary": [
      "deep_sleep_duration_seconds_int",
      "time_in_bed_seconds_int",
      "sleep_date_string",
      "rem_sleep_duration_seconds_int",
      "sleep_start_datetime_string",
      "sleep_efficiency_1_100_score_int",
      "light_sleep_duration_seconds_int",
      "sleep_end_datetime_string",
      "hr_avg_bpm_int",
      "time_awake_during_sleep_seconds_int",
      "sleep_duration_seconds_int",
      "hr_minimum_bpm_int",
      "hr_maximum_bpm_int"
    ]
}
note

The data you receive depends on the permissions granted by the user when linking their data source.

Data Delivery​

Our Withings 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 Withings Data​

To begin extracting health data from Withings, follow these steps:

Step 1: Enable Data Source​

Integrate Withings into your application or digital solution through the endpoint provided by ROOK.

Switch Withings.png

Step 2: Set Up Your Connections Page​

Enable the Withings data source on the connections page to allow your users to connect.

Connect Withings.png

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": {},
}