Page Comparison

Purchasing & General Information

...

We recommend participants sync their device at least once a day at the end of the day. That way we can collect the highest step count from participants for that day. Most Fitbit devices record minute-by-minute data for seven days (Fitbit Alta records minute-by-minute data for five days. Fitbit devices can store daily totals for up to 30 days so if participants wait a few days to sync, W2H will still be able to capture the missing data. 

Pausing Data Collection

We added a “Paused” status to devices in September of 2023. When looking at the configuration of a Fitbit device in the participant profile/devices tab, there will be a blue button that says Pause Data Collection. When this is clicked, W2H will not try to pull down data for that device. When it is unpaused (by clicking Resume Data Collection) the data for the period during which it was paused will backfill. That’s all this feature does - stops data from flowing into W2H until such a time as we turn the tap back on.

Step Data (Updated 2/20)

• goal_steps (migration to rename fitbit_goal to goal_steps)

• goal_calories_out

• goal_floors

• goal_distance

• calories_out

• calories_bmr

• marginal_calories

• activity_calories

• elevation

• floors

...

• activity_name

• log_type

• source_type

• source_name

• distance (?miles)

• speed (?mph)

• distance_unit (probably applies to above two fields, confirm its mile even though API example uses kilometers)

• duration (seconds)

• active_duration

• calories

• steps

• start_time (store this as the as_of for the form submission)

• last_modified

• manual_step_value (boolean)

• manual_distance_value (boolean)

• manual_calorie_value (boolean)

• average_heart_rate

• heart_rate_minutes_out_of_range

• heart_rate_minutes_fat_burn

• heart_rate_minutes_cardio

• heart_rate_minutes_cardio

• Confirm if below are consistent across activities 

  • minutes_sedentary

  • minutes_lightly_active

  • minutes_fairly_active

  • minutes_very_active

• activity_id

• activity_parent_id

• calories

• description

• distance

• duration

• has_start_time

• is_favorite

• log_id (could potentially be used in combination with option a)

• name

• start_time

• steps

Sleep data

We will soon be upgrading our Fitbit Sleep API integration to use version 1.2 since version 1 has been deprecated (https://dev.fitbit.com/build/reference/web-api/sleep/#version-1)

Data fields (API version 1) 

• start_time: The time the sleep period started

• end_time: The time the sleep period ended

• minutes_to_fall_asleep: Minutes in bed spent awake prior to first sleep cycle

• minutes_asleep: Total minutes spent in a sleep stage during the sleep period

• minutes_awake: Total minutes spent awake during the sleep period

• minutes_after_wakeup: Minutes in bed spent awake after last sleep cycle

• minutes_in_bed: Total Minutes spent in bed, this is equal to the duration of the sleep period

• awake_count: How many sleep cycles were spent 'awake' during the sleep period

• awake_duration: Total time spent in the 'awake' stage during the sleep period

• restless_count: How many sleep cycles were spent in the 'restless' stage during the sleep period

• restless_duration: Total time spent in the 'restless' stage during the sleep period

• efficiency: An arbitrary number fitbit calculates using the following formula: time asleep / (total time in bed - time to fall asleep).
                   Will probably be removed at some point since fitbit deprecated this field

• main_sleep: A true/false value: true if fitbit considers this sleep period the main sleep for that person (one main sleep per day)

...

• start_time: The time the sleep period started

• end_time: The time the sleep period ended

• minutes_to_fall_asleep: Minutes in bed spent awake prior to first sleep cycle

• minutes_asleep: Total minutes spent in a sleep stage during the sleep period

• minutes_awake: Total minutes spent awake during the sleep period

• minutes_after_wakeup: Minutes in bed spent awake after last sleep cycle

• minutes_in_bed: Total Minutes spent in bed, this is equal to the duration of the sleep period

• efficiency: An arbitrary number fitbit calculates using the following formula: time asleep / (total time in bed - time to fall asleep)
  

• main_sleep: A true/false value: true if fitbit considers this sleep period the main sleep for that person (one main sleep per day)

• type: value of either classic or stages (see Fitbit Sleep API docs for more detail)

  • classic fields

    • awake_count: How many sleep cycles were spent in the 'awake' level during the sleep period

    • awake_duration: Total time (minutes) spent in the 'awake' level during the sleep period

    • restless_count: How many sleep cycles were spent in the 'restless' level during the sleep period

    • restless_duration: Total time (minutes) spent in the 'restless' level during the sleep period

    • asleep_count: How many sleep cycles were spent n the 'asleep' level during the sleep period

    • asleep_duration: Total time (minutes) spent in the 'asleep' level during the sleep period

  • stages fields

    • wake_count: How many sleep cycles were spent in the 'wake' level during the sleep period

    • wake_duration: Total time (minutes) spent in the 'wake' level during the sleep period

    • light_count: How many sleep cycles were spent in the 'light' level during the sleep period

    • light_duration: Total time (minutes) spent in the 'light' level during the sleep period

    • deep_count: How many sleep cycles were spent in the 'deep' level during the sleep period

    • deep_duration: Total time (minutes) spent in the 'deep' level during the sleep period

    • rem_count: How many sleep cycles were spent in the 'rem' level during the sleep period

    • rem_duration: Total time (minutes) spent in the 'rem' level during the sleep period

...