Fitbit (Independent Publisher) (Preview)

A way to access the Fitbit Web API

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)

Contact
Name	Ashwin Ganesh Kumar
URL	https://www.blisdigital.com/
Email	a.kumar@blisdigital.com

Connector Metadata
Publisher	Ashwin Ganesh Kumar
Website	https://dev.fitbit.com//
Privacy policy	https://www.fitbit.com/global/nl/legal/privacy-policy
Categories	Data

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Get Activity Goals	Retrieves a user's current daily or weekly activity goals.
Get Activity Log List	Retrieves a list of a user's activity log entries before or after a given day.
Get Activity TCX	The Training Center XML (TCX) is a data exchange format that contains GPS, heart rate, and lap data. This endpoint retrieves the details of a user's location using GPS and heart rate data during a logged exercise.
Get Activity Time Series by Date	Retrieves the activity data for a given resource over a period of time by specifying a date and time period. The response will include only the daily summary values.
Get Activity Type	Retrieves the details for a single activity from the Fitbit activities database in the format requested. If available, activity level details will display.
Get Alarms	Retrieves the alarms enabled for a specific device.
Get All Activity Types	Retrieves a list of all valid Fitbit public activities and the private, user-created activities from the Fitbit activities database in the format requested. If available, activity level details will display.
Get Badges	Retrieves a list of the user’s badges.
Get Body Fat Log	Retrieves a list of all user's body fat log entries for a given date.
Get Body Fat Time Series by Date	Retrieves a list of all user's body fat log entries for a given period.
Get Body Goals	Retrieves a user's body fat and weight goals.
Get Body Time Series by Date	Retrieves a list of all user's bmi, body fat, or weight for a given period.
Get Breathing Rate Summary by Date	This endpoint returns average breathing rate data for a single date. Breathing Rate data applies specifically to a user’s “main sleep,” which is the longest single period of time during which they were asleep on a given date.
Get Daily Activity Summary	Retrieves a summary and list of a user’s activities and activity log entries for a given day.
Get Devices	Retrieves a list of Fitbit devices paired to a user's account.
Get Favorite Activities	Retrieves a list of a user's favorite activities.
Get Frequent Activities	Retrieves a list of a user's frequent activities.
Get Friends Leaderboard	This endpoint returns the user's friend leaderboard
Get HRV Summary by Date	This endpoint returns the Heart Rate Variability (HRV) data for a single date
Get Lifetime Stats	Retrieves the user's activity statistics.
Get Profile	Retrieves the user's profile data.
Get Recent Activity Types	Retrieves a list of a user's recent activities types logged with some details of the last activity log of that type.
Get Sleep Goal	Specify the encoded ID of the user. Use "-" (dash) for current logged-in user.
Get Sleep Log by Date	Returns a list of a user's sleep log entries for a given date
Get Sleep Log by Date Range	Returns a list of a user's sleep log entries for a date range.
Get Sleep Log List	Returns a list of a user's sleep log entries before or after a given date
Get VO2 Max Summary by Date	Returns the Cardio Fitness Score (also known as VO2 Max) data for a single date. VO2 Max values will be shown as a range if no run data is available or a single numeric value if the user uses a GPS for runs. See Additional Information for further context.
Get Weight Log	Retrieves a list of all user's weight log entries for a given date.
Get Weight Time Series by Date	Retrieves a list of all user's weight log entries for a given period.

Get Activity Goals

Operation ID:

GetActivityGoals

Retrieves a user's current daily or weekly activity goals.

Parameters

Name	Key	Required	Type	Description
User id	user-id	True	string	The encoded ID of the user
Period	period	True	string	daily| weekly

Returns

Name	Path	Type	Description
activeMinutes	goals.activeMinutes	integer	Daily active minutes goal. A value is not returned for weekly goals.
activeZoneMinutes	goals.activeZoneMinutes	integer	Daily or weekly active zone minutes goal.
caloriesOut	goals.caloriesOut	integer	Daily calories burned goal. A value is not returned for weekly goals.
distance	goals.distance	float	Daily or weekly distance goal.
floors	goals.floors	integer	Daily or weekly floors climbed goal.
steps	goals.steps	integer	Daily or weekly steps taken goal.

Get Activity Log List

Operation ID:

GetActivityLogList

Retrieves a list of a user's activity log entries before or after a given day.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
After Date	afterDate		string	The after date (yyyy-mm-dd)
Before Date	beforeDate		string	The before date (yyyy-mm-dd)
Sort	sort		string	The sort order of entries by date.
Limit	limit		integer	The number of entries returned.

Returns

Name	Path	Type	Description
activities	activities	array of object	activities
activeDuration	activities.activeDuration	integer	The amount of time (milliseconds) within each activityLevel.
activityLevel	activities.activityLevel	array of object	activityLevel
minutes	activities.activityLevel.minutes	integer	minutes
name	activities.activityLevel.name	string	name
activityName	activities.activityName	string	Name of the recorded exercise.
activityTypeId	activities.activityTypeId	integer	The activityName's identifier number.
calories	activities.calories	integer	Number of calories burned during the exercise.
caloriesLink	activities.caloriesLink	string	Web API endpoint to call to get the specific calories burned for the named exercise.
duration	activities.duration	integer	The length in time (milliseconds) after the exercise was edited. If the exercise was not edited, the duration = originalDuration. This value will contain pauses during the exercise.
elevationGain	activities.elevationGain	float	Elevation gained during the exercise.
lastModified	activities.lastModified	string	The timestamp the exercise was last modified.
logId	activities.logId	integer	The activity log identifier for the exercise.
logType	activities.logType	string	auto_detected | manual | mobile_run | tracker | the name of the 3rd party application
calories	activities.manualValuesSpecified.calories	boolean	A boolean value stating if calories was provided when recording the exercise.
distance	activities.manualValuesSpecified.distance	boolean	A boolean value stating if distance was provided when recording the exercise.
steps	activities.manualValuesSpecified.steps	boolean	A boolean value stating if steps was provided when recording the exercise.
originalDuration	activities.originalDuration	integer	The initial length in time (milliseconds) that the exercise was recorded. This value will contain pauses during the exercise.
originalStartTime	activities.originalStartTime	string	The initial start datetime that the exercise was recorded.
startTime	activities.startTime	string	The start datetime after the exercise was edited. If the exercise was not edited, the startTime = originalStartTime.
steps	activities.steps	integer	Number of steps taken during the exercise.
tcxLink	activities.tcxLink	string	URL to download the TCX file.
afterDate	pagination.afterDate	string	afterDate
limit	pagination.limit	integer	limit
next	pagination.next	string	next
offset	pagination.offset	integer	offset
previous	pagination.previous	string	previous
sort	pagination.sort	string	sort

Get Activity TCX

Operation ID:

GetActivityTCX

The Training Center XML (TCX) is a data exchange format that contains GPS, heart rate, and lap data. This endpoint retrieves the details of a user's location using GPS and heart rate data during a logged exercise.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the use
Log Id	log-id	True	string	The activity's log ID.
Partial TCX	includePartialTCX		boolean	Includes the TCX points when the GPS data is not available.

Returns

Get Activity Time Series by Date

Operation ID:

GetActivityTimeSeriesbyDate

Retrieves the activity data for a given resource over a period of time by specifying a date and time period. The response will include only the daily summary values.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Resource	resource	True	string	The resource of the data to be returned.
Date	date	True	string	The end date of the period specified in the format yyyy-mm-dd
Period	period	True	string	The range for which data will be returned.

Returns

Name	Path	Type	Description
activities-steps	activities-steps	array of object	activities-steps
dateTime	activities-steps.dateTime	string	dateTime
value	activities-steps.value	string	value

Get Activity Type

Operation ID:

GetAcitivityType

Retrieves the details for a single activity from the Fitbit activities database in the format requested. If available, activity level details will display.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Activity Id	activity-id	True	string	Activity Id

Returns

Name	Path	Type	Description
accessLevel	activity.accessLevel	string	PUBLIC | PRIVATE
activityLevels	activity.activityLevels	array of object	activityLevels
id	activity.activityLevels.id	integer	Numerical value representing the corresponding activity level.
maxSpeedMPH	activity.activityLevels.maxSpeedMPH	float	Maximum speed in MPH. Value: -1 means not applicable.
mets	activity.activityLevels.mets	integer	METs score for the activity id.
minSpeedMPH	activity.activityLevels.minSpeedMPH	integer	Minimum speed in MPH. Value: -1 means not applicable.
name	activity.activityLevels.name	string	Name of the activity level.
hasSpeed	activity.hasSpeed	boolean	true | false
id	activity.id	integer	Numerical value representing the corresponding activity.
name	activity.name	string	The name of the activity or exercise.

Get Alarms

Operation ID:

GetAlarms

Retrieves the alarms enabled for a specific device.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Tracker Id	tracker-id	True	string	The ID of the tracker for which the data is returned.

Returns

Name	Path	Type	Description
trackerAlarms	trackerAlarms	array of object	trackerAlarms
alarmId	trackerAlarms.alarmId	integer	Numerical value representing the alarm ID.
deleted	trackerAlarms.deleted	boolean	Indicates if an alarm has been deleted.
enabled	trackerAlarms.enabled	boolean	Indicates if an alarm is enabled.
recurring	trackerAlarms.recurring	boolean	Indicates if an alarm is recurring.
snoozeCount	trackerAlarms.snoozeCount	integer	Indicates the number of times the alarm will snooze.
snoozeLength	trackerAlarms.snoozeLength	integer	Indicates the time in minutes between snooze periods.
syncedToDevice	trackerAlarms.syncedToDevice	boolean	true | false
time	trackerAlarms.time	string	The time and UTC offset for the specified alarm.
vibe	trackerAlarms.vibe	string	Returns the type of vibration configured.
weekDays	trackerAlarms.weekDays	array of string	weekDays

Get All Activity Types

Operation ID:

GetAllActivityTypes

Retrieves a list of all valid Fitbit public activities and the private, user-created activities from the Fitbit activities database in the format requested. If available, activity level details will display.

Returns

Name	Path	Type	Description
categories	categories	array of object	categories
activities	categories.activities	array of object	activities
accessLevel	categories.activities.accessLevel	string	accessLevel
activityLevels	categories.activities.activityLevels	array of object	activityLevels
id	categories.activities.activityLevels.id	integer	id
maxSpeedMPH	categories.activities.activityLevels.maxSpeedMPH	integer	maxSpeedMPH
mets	categories.activities.activityLevels.mets	integer	mets
minSpeedMPH	categories.activities.activityLevels.minSpeedMPH	integer	minSpeedMPH
name	categories.activities.activityLevels.name	string	name
hasSpeed	categories.activities.hasSpeed	boolean	hasSpeed
id	categories.activities.id	integer	id
name	categories.activities.name	string	name
mets	categories.activities.mets	float	mets

Get Badges

Operation ID:

GetBadges

Retrieves a list of the user’s badges.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
badges	badges	array of object	badges
badgeGradientEndColor	badges.badgeGradientEndColor	string	badgeGradientEndColor
badgeGradientStartColor	badges.badgeGradientStartColor	string	badgeGradientStartColor
badgeType	badges.badgeType	string	Type of badge received.
category	badges.category	string	category
cheers	badges.cheers	array of	cheers
dateTime	badges.dateTime	string	Date the badge was achieved.
description	badges.description	string	description
earnedMessage	badges.earnedMessage	string	earnedMessage
encodedId	badges.encodedId	string	encodedId
image100px	badges.image100px	string	image100px
image125px	badges.image125px	string	image125px
image300px	badges.image300px	string	image300px
image50px	badges.image50px	string	image50px
image75px	badges.image75px	string	image75px
marketingDescription	badges.marketingDescription	string	marketingDescription
mobileDescription	badges.mobileDescription	string	mobileDescription
name	badges.name	string	name
shareImage640px	badges.shareImage640px	string	shareImage640px
shareText	badges.shareText	string	shareText
shortDescription	badges.shortDescription	string	shortDescription
shortName	badges.shortName	string	shortName
timesAchieved	badges.timesAchieved	integer	Number of times the user has achieved the badge.
value	badges.value	integer	The badge goal in the unit measurement.

Get Body Fat Log

Operation ID:

GetBodyFattLog

Retrieves a list of all user's body fat log entries for a given date.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Date	date	True	string	The date in the format yyyy-mm-dd.

Returns

Name	Path	Type	Description
fat	fat	array of object	fat
date	fat.date	string	The date the body fat log was recorded.
fat	fat.fat	integer	The body fat percentage.
logId	fat.logId	integer	The body fat log Id.
source	fat.source	string	The location where the body fat data originated.
time	fat.time	string	The timestamp when the body fat log was recorded.

Get Body Fat Time Series by Date

Operation ID:

GetBodyFatTimerSeriesbyDate

Retrieves a list of all user's body fat log entries for a given period.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Date	date	True	string	The end date of the period specified in the format yyyy-mm-dd or today.
Period	period	True	string	The range for which data will be returned.

Returns

Name	Path	Type	Description
fat	fat	array of object	fat
date	fat.date	string	The date the body fat log was recorded.
fat	fat.fat	float	The body fat percentage.
logId	fat.logId	integer	The body fat log Id.
source	fat.source	string	The location where the body fat data originated. See "source" values for more information.
time	fat.time	string	The timestamp when the body fat log was recorded.

Get Body Goals

Operation ID:

GetBodyGoals

Retrieves a user's body fat and weight goals.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Goal type	goal-type	True	string	Goal type

Returns

Name	Path	Type	Description
goalType	goal.goalType	string
startDate	goal.startDate	string	The goal start date.
startWeight	goal.startWeight	float	User's weight when goal was established.
weight	goal.weight	float	The weight goal to achieve.
weightThreshold	goal.weightThreshold	float	The recommended amount of weight to lose each week to achieve and maintain goal.

Get Body Time Series by Date

Operation ID:

GetBodyTimeSeriesbyDate

Retrieves a list of all user's bmi, body fat, or weight for a given period.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Resource	resource	True	string	The body resource to be returned.
Date	date	True	string	The end date of the period specified in the format yyyy-mm-dd or today.
Period	period	True	string	The range for which data will be returned.

Returns

Name	Path	Type	Description
body-weight	body-weight	array of object	body-weight
dateTime	body-weight.dateTime	string	dateTime
value	body-weight.value	string	value

Get Breathing Rate Summary by Date

Operation ID:

GetBreathingRateSummarybyDate

This endpoint returns average breathing rate data for a single date. Breathing Rate data applies specifically to a user’s “main sleep,” which is the longest single period of time during which they were asleep on a given date.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Date	date	True	string	The date in the format yyyy-mm-dd or today.

Returns

Name	Path	Type	Description
br	br	array of object	br
breathingRate	br.value.breathingRate	float	The average number of breaths taken per minute.
dateTime	br.dateTime	string	The sleep log date specified in the format YYYY-MM-DD.

Get Daily Activity Summary

Operation ID:

GetDailyActivitySummary

Retrieves a summary and list of a user’s activities and activity log entries for a given day.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Date	date	True	string	Date

Returns

Name	Path	Type	Description
activities	activities	array of	activities
activeMinutes	goals.activeMinutes	integer	activeMinutes
caloriesOut	goals.caloriesOut	integer	caloriesOut
distance	goals.distance	float	distance
floors	goals.floors	integer	floors
steps	goals.steps	integer	steps
activeScore	summary.activeScore	integer	activeScore
activityCalories	summary.activityCalories	integer	activityCalories
calorieEstimationMu	summary.calorieEstimationMu	integer	calorieEstimationMu
caloriesBMR	summary.caloriesBMR	integer	caloriesBMR
caloriesOut	summary.caloriesOut	integer	caloriesOut
caloriesOutUnestimated	summary.caloriesOutUnestimated	integer	caloriesOutUnestimated
customHeartRateZones	summary.customHeartRateZones	array of object	customHeartRateZones
caloriesOut	summary.customHeartRateZones.caloriesOut	integer	caloriesOut
max	summary.customHeartRateZones.max	integer	max
min	summary.customHeartRateZones.min	integer	min
minutes	summary.customHeartRateZones.minutes	integer	minutes
name	summary.customHeartRateZones.name	string	name
distances	summary.distances	array of object	distances
activity	summary.distances.activity	string	| total | tracker | loggedActivities | veryActive | moderatelyActive | lightlyActive | sedentaryActive
distance	summary.distances.distance	integer	For the specified resource, the distance traveled for the day displayed in the units defined by the Accept-Language header.
elevation	summary.elevation	integer	The elevation traveled for the day displayed in the units defined by the Accept-Language header.
fairlyActiveMinutes	summary.fairlyActiveMinutes	integer	Total minutes the user was fairly/moderately active.
floors	summary.floors	integer	The equivalent floors climbed for the day displayed in the units defined by the Accept-Language header.
heartRateZones	summary.heartRateZones	array of object	heartRateZones
caloriesOut	summary.heartRateZones.caloriesOut	integer	caloriesOut
max	summary.heartRateZones.max	integer	max
min	summary.heartRateZones.min	integer	min
minutes	summary.heartRateZones.minutes	integer	minutes
name	summary.heartRateZones.name	string	Heart Rate scope is required to see this value. Out of Range | Fat Burn | Cardio | Peak
lightlyActiveMinutes	summary.lightlyActiveMinutes	integer	Total minutes the user was lightly active.
marginalCalories	summary.marginalCalories	integer	Total marginal estimated calories burned for the day.
restingHeartRate	summary.restingHeartRate	integer	The Heart Rate scope is required to see this value.
sedentaryMinutes	summary.sedentaryMinutes	integer	Total minutes the user was sedentary.
steps	summary.steps	integer	Total steps taken for the day.
useEstimation	summary.useEstimation	boolean	Boolean value stating if estimations are used in calculations.
veryActiveMinutes	summary.veryActiveMinutes	integer	Total minutes the user was very active.

Get Devices

Operation ID:

GetDevices

Retrieves a list of Fitbit devices paired to a user's account.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
		array of object
battery	battery	string	Returns the battery level of the device
batteryLevel	batteryLevel	integer	Returns the battery level percentage of the device.
deviceVersion	deviceVersion	string	The product name of the device.
features	features	array of	features
id	id	string	The device ID.
lastSyncTime	lastSyncTime	string	Timestamp representing the last time the device was sync'd with the Fitbit mobile application.
mac	mac	string	Mac ID number
type	type	string	TRACKER | SCALE

Get Favorite Activities

Operation ID:

GetFavoriteActivities

Retrieves a list of a user's favorite activities.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
		array of object
activityId	activityId	integer	The recorded activity’s identifier number.
description	description	string	Additional information about the recorded activity.
mets	mets	integer	The metabolic equivalent (METs) of the activity performed.
name	name	string	The name of the recorded activity.

Get Frequent Activities

Operation ID:

GetFrequentActivities

Retrieves a list of a user's frequent activities.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
		array of object
activityId	activityId	integer	The recorded activity’s identifier number.
calories	calories	integer	The number of calories burned associated with the activity.
description	description	string	Additional information about the recorded activity.
distance	distance	integer	Distance traveled associated with the recorded activity.
duration	duration	integer	The length in time (milliseconds) after the exercise was edited. This value will contain pauses during the exercise.
name	name	string	The name of the recorded activity.

Get Friends Leaderboard

Operation ID:

GetFriendsLeaderboard

This endpoint returns the user's friend leaderboard

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
data	data	array of object	data
type	data.type	string	type
id	data.id	string	id
step-rank	data.attributes.step-rank	integer	Ranking among the user's friends.
step-summary	data.attributes.step-summary	integer	Weekly step count.
type	data.relationships.user.data.type	string	type
id	data.relationships.user.data.id	string	id
included	included	array of object	included
type	included.type	string	type
id	included.id	string	id
avatar	included.attributes.avatar	string	Link to user's avatar picture.
child	included.attributes.child	boolean	child
friend	included.attributes.friend	boolean	friend
name	included.attributes.name	string	name

Get HRV Summary by Date

Operation ID:

GetHRVSummarybyDate

This endpoint returns the Heart Rate Variability (HRV) data for a single date

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Date	date	True	string	The date in the format yyyy-MM-dd or today.

Returns

Name	Path	Type	Description
hrv	hrv	array of object	hrv
dailyRmssd	hrv.value.dailyRmssd	float	The Root Mean Square of Successive Differences (RMSSD) between heart beats. It measures short-term variability in the user’s daily heart rate in milliseconds (ms).
deepRmssd	hrv.value.deepRmssd	float	The Root Mean Square of Successive Differences (RMSSD) between heart beats. It measures short-term variability in the user’s heart rate while in deep sleep, in milliseconds (ms).
dateTime	hrv.dateTime	string	The sleep log date specified in the format YYYY-MM-DD.

Get Lifetime Stats

Operation ID:

GetLifetimeStats

Retrieves the user's activity statistics.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
date	best.total.distance.date	string	date
value	best.total.distance.value	float	value
date	best.total.floors.date	string	date
value	best.total.floors.value	float	value
date	best.total.steps.date	string	date
value	best.total.steps.value	integer	value
date	best.tracker.distance.date	string	date
value	best.tracker.distance.value	float	value
date	best.tracker.floors.date	string	date
value	best.tracker.floors.value	float	value
date	best.tracker.steps.date	string	date
value	best.tracker.steps.value	integer	value
activeScore	lifetime.total.activeScore	integer	activeScore
caloriesOut	lifetime.total.caloriesOut	integer	caloriesOut
distance	lifetime.total.distance	float	distance
floors	lifetime.total.floors	integer	floors
steps	lifetime.total.steps	integer	steps
activeScore	lifetime.tracker.activeScore	integer	activeScore
caloriesOut	lifetime.tracker.caloriesOut	integer	caloriesOut
distance	lifetime.tracker.distance	float	distance
floors	lifetime.tracker.floors	integer	floors
steps	lifetime.tracker.steps	integer	steps

Get Profile

Operation ID:

GetProfile

Retrieves the user's profile data.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
aboutMe	user.aboutMe	string	The "About Me" information specified in the user's account settings.
age	user.age	string	The age based on their specified birthday in the user's account settings.
ambassador	user.ambassador	string	ambassador
autoStrideEnabled	user.autoStrideEnabled	string	autoStrideEnabled
avatar	user.avatar	string	avatar
avatar150	user.avatar150	string	avatar150
avatar640	user.avatar640	string	avatar640
averageDailySteps	user.averageDailySteps	string	Average daily steps calculated for the user.
challengesBeta	user.challengesBeta	string	challengesBeta
clockTimeDisplayFormat	user.clockTimeDisplayFormat	string	clockTimeDisplayFormat
country	user.country	string	country
corporate	user.corporate	string	corporate
corporateAdmin	user.corporateAdmin	string	corporateAdmin
dateOfBirth	user.dateOfBirth	string	dateOfBirth
displayName	user.displayName	string	displayName
displayNameSetting	user.displayNameSetting	string	displayNameSetting
distanceUnit	user.distanceUnit	string	distanceUnit
encodedId	user.encodedId	string	encodedId
exerciseGoal	user.features.exerciseGoal	string	exerciseGoal
firstName	user.firstName	string	firstName
foodsLocale	user.foodsLocale	string	foodsLocale
fullName	user.fullName	string	fullName
gender	user.gender	string	gender
glucoseUnit	user.glucoseUnit	string	glucoseUnit
height	user.height	string	The height value specified in the user's account settings.
heightUnit	user.heightUnit	string	heightUnit
isBugReportEnabled	user.isBugReportEnabled	string	isBugReportEnabled
isChild	user.isChild	string	isChild
isCoach	user.isCoach	string	isCoach
languageLocale	user.languageLocale	string	languageLocale
lastName	user.lastName	string	lastName
legalTermsAcceptRequired	user.legalTermsAcceptRequired	string	legalTermsAcceptRequired
locale	user.locale	string	locale
memberSince	user.memberSince	string	memberSince
mfaEnabled	user.mfaEnabled	string	mfaEnabled
offsetFromUTCMillis	user.offsetFromUTCMillis	string	offsetFromUTCMillis
sdkDeveloper	user.sdkDeveloper	string	sdkDeveloper
sleepTracking	user.sleepTracking	string	sleepTracking
startDayOfWeek	user.startDayOfWeek	string	startDayOfWeek
state	user.state	string	state
strideLengthRunning	user.strideLengthRunning	string	strideLengthRunning
strideLengthRunningType	user.strideLengthRunningType	string	strideLengthRunningType
strideLengthWalking	user.strideLengthWalking	string	strideLengthWalking
strideLengthWalkingType	user.strideLengthWalkingType	string	strideLengthWalkingType
swimUnit	user.swimUnit	string	swimUnit
temperatureUnit	user.temperatureUnit	string	temperatureUnit
timezone	user.timezone	string	timezone
topBadges	user.topBadges	string	An array listing the Fitbit badges currently earned by the user.
waterUnit	user.waterUnit	string	waterUnit
waterUnitName	user.waterUnitName	string	waterUnitName
weight	user.weight	string	weight
weightUnit	user.weightUnit	string	weightUnit

Get Recent Activity Types

Operation ID:

GetRecentActivityTypes

Retrieves a list of a user's recent activities types logged with some details of the last activity log of that type.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
		array of object
activityId	activityId	integer	The numerical ID for the activity or exercise.
calories	calories	integer	Number of calories burned during the recorded activity.
description	description	string	Information, if available, about the activity or exercise.
distance	distance	integer	Distance traveled during the recorded activity.
duration	duration	integer	Amount of time (milliseconds) to complete the recorded activity.
name	name	string	The name of the activity or exercise.

Get Sleep Goal

Operation ID:

GetSleepGoal

Specify the encoded ID of the user. Use "-" (dash) for current logged-in user.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user

Returns

Name	Path	Type	Description
flowId	consistency.flowId	integer	0 = A sleep goal is set, but there are not enough sleep logs recorded. 1 = The user either missed their sleep goal or no goal is set, but there are enough sleep logs recorded. 2 = A sleep goal is not set, and there are not enough sleep logs recorded. 3 = The user achieved their sleep goal
minDuration	goal.minDuration	integer	Length of the sleep goal period in minutes.
updatedOn	goal.updatedOn	string	The timestamp that the goal was created/updated.

Get Sleep Log by Date

Operation ID:

GetSleepLogbyDate

Returns a list of a user's sleep log entries for a given date

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Date	date	True	string	yyyy-mm-dd

Returns

Name	Path	Type	Description
sleep	sleep	array of object	sleep
dateOfSleep	sleep.dateOfSleep	string	The date the sleep log ended
duration	sleep.duration	integer	Length of the sleep in milliseconds.
efficiency	sleep.efficiency	integer	Calculated sleep efficiency score. This is not the sleep score available in the mobile application.
endTime	sleep.endTime	string	Time the sleep log ended.
infoCode	sleep.infoCode	integer	An integer value representing the quality of data collected within the sleep log. 0 = Sufficient data to generate a sleep log. 1 = Insufficient heart rate data. 2 = Sleep period was too short (less than 3 hours). 3 = Server-side issue.
isMainSleep	sleep.isMainSleep	boolean	Boolean
data	sleep.levels.data	array of object	data
dateTime	sleep.levels.data.dateTime	string	dateTime
level	sleep.levels.data.level	string	level
seconds	sleep.levels.data.seconds	integer	seconds
shortData	sleep.levels.shortData	array of object	shortData
dateTime	sleep.levels.shortData.dateTime	string	dateTime
level	sleep.levels.shortData.level	string	level
seconds	sleep.levels.shortData.seconds	integer	seconds
count	sleep.levels.summary.deep.count	integer	count
minutes	sleep.levels.summary.deep.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.deep.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.light.count	integer	count
minutes	sleep.levels.summary.light.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.light.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.rem.count	integer	count
minutes	sleep.levels.summary.rem.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.rem.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.wake.count	integer	count
minutes	sleep.levels.summary.wake.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.wake.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
logId	sleep.logId	integer	Sleep log ID.
minutesAfterWakeup	sleep.minutesAfterWakeup	integer	The total number of minutes after the user woke up.
minutesAsleep	sleep.minutesAsleep	integer	The total number of minutes the user was asleep.
minutesAwake	sleep.minutesAwake	integer	The total sum of "wake" minutes only. It does not include before falling asleep or after waking up.
minutesToFallAsleep	sleep.minutesToFallAsleep	integer	The total number of minutes before the user falls asleep. This value is generally 0 for autosleep created sleep logs.
logType	sleep.logType	string	auto_detected | manual
startTime	sleep.startTime	string	Time the sleep log begins.
timeInBed	sleep.timeInBed	integer	Total number of minutes the user was in bed.
type	sleep.type	string	classic | stages
deep	summary.stages.deep	integer	deep
light	summary.stages.light	integer	light
rem	summary.stages.rem	integer	rem
wake	summary.stages.wake	integer	wake
totalMinutesAsleep	summary.totalMinutesAsleep	integer	Total number of minutes the user was asleep across all sleep records in the sleep log.
totalSleepRecords	summary.totalSleepRecords	integer	The number of sleep records within the sleep log.
totalTimeInBed	summary.totalTimeInBed	integer	Total number of minutes the user was in bed across all records in the sleep log.

Get Sleep Log by Date Range

Operation ID:

GetSleepLogbyDateRange

Returns a list of a user's sleep log entries for a date range.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Start Date	startDate	True	string	The date for the first sleep log to be returned (yyyy-mm-dd)
End Date	endDate	True	string	The date for the last sleep log to be returned (yyyy-mm-dd)

Returns

Name	Path	Type	Description
sleep	sleep	array of object	sleep
dateOfSleep	sleep.dateOfSleep	string	The date the sleep log ended.
duration	sleep.duration	integer	Length of the sleep in milliseconds.
efficiency	sleep.efficiency	integer	Calculated sleep efficiency score. This is not the sleep score available in the mobile application.
endTime	sleep.endTime	string	Time the sleep log ended.
infoCode	sleep.infoCode	integer	An integer value representing the quality of data collected within the sleep log. 0 = Sufficient data to generate a sleep log. 1 = Insufficient heart rate data. 2 = Sleep period was too short (less than 3 hours). 3 = Server-side issue.
isMainSleep	sleep.isMainSleep	boolean	Boolean
data	sleep.levels.data	array of object	data
dateTime	sleep.levels.data.dateTime	string	dateTime
level	sleep.levels.data.level	string	level
seconds	sleep.levels.data.seconds	integer	seconds
count	sleep.levels.summary.asleep.count	integer	count
minutes	sleep.levels.summary.asleep.minutes	integer	minutes
count	sleep.levels.summary.awake.count	integer	count
minutes	sleep.levels.summary.awake.minutes	integer	minutes
count	sleep.levels.summary.restless.count	integer	count
minutes	sleep.levels.summary.restless.minutes	integer	minutes
count	sleep.levels.summary.deep.count	integer	count
minutes	sleep.levels.summary.deep.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.deep.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.light.count	integer	count
minutes	sleep.levels.summary.light.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.light.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.rem.count	integer	count
minutes	sleep.levels.summary.rem.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.rem.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.wake.count	integer	count
minutes	sleep.levels.summary.wake.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.wake.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
shortData	sleep.levels.shortData	array of object	shortData
dateTime	sleep.levels.shortData.dateTime	string	dateTime
level	sleep.levels.shortData.level	string	level
seconds	sleep.levels.shortData.seconds	integer	seconds
logId	sleep.logId	integer	Sleep log ID.
minutesAfterWakeup	sleep.minutesAfterWakeup	integer	The total number of minutes after the user woke up.
minutesAsleep	sleep.minutesAsleep	integer	The total number of minutes the user was asleep.
minutesAwake	sleep.minutesAwake	integer	The total sum of "wake" minutes only. It does not include before falling asleep or after waking up.
minutesToFallAsleep	sleep.minutesToFallAsleep	integer	The total number of minutes before the user falls asleep. This value is generally 0 for autosleep created sleep logs.
logType	sleep.logType	string	auto_detected | manual
startTime	sleep.startTime	string	Time the sleep log begins
timeInBed	sleep.timeInBed	integer	Total number of minutes the user was in bed
type	sleep.type	string	classic | stages

Get Sleep Log List

Operation ID:

GetSleepLogList

Returns a list of a user's sleep log entries before or after a given date

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
After Date	afterDate		string	After the date where user's sleep log is returned (yyyy-mm-dd)
Before Date	beforeDate		string	Before the date where user's sleep log is returned (yyyy-mm-dd)
Sort	sort		string	ascending or descending
Limit	limit		integer	The number of sleep logs to be returned. (max 100)

Returns

Name	Path	Type	Description
afterDate	pagination.afterDate	string	afterDate
limit	pagination.limit	integer	limit
next	pagination.next	string	next
offset	pagination.offset	integer	offset
previous	pagination.previous	string	previous
sort	pagination.sort	string	sort
sleep	sleep	array of object	sleep
dateOfSleep	sleep.dateOfSleep	string
duration	sleep.duration	integer	duration
efficiency	sleep.efficiency	integer	efficiency
endTime	sleep.endTime	string	endTime
infoCode	sleep.infoCode	integer	infoCode
isMainSleep	sleep.isMainSleep	boolean	isMainSleep
data	sleep.levels.data	array of object	data
dateTime	sleep.levels.data.dateTime	string	dateTime
level	sleep.levels.data.level	string	level
seconds	sleep.levels.data.seconds	integer	seconds
shortData	sleep.levels.shortData	array of object	shortData
dateTime	sleep.levels.shortData.dateTime	string	dateTime
level	sleep.levels.shortData.level	string	level
seconds	sleep.levels.shortData.seconds	integer	seconds
count	sleep.levels.summary.deep.count	integer	count
minutes	sleep.levels.summary.deep.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.deep.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.light.count	integer	count
minutes	sleep.levels.summary.light.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.light.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.rem.count	integer	count
minutes	sleep.levels.summary.rem.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.rem.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
count	sleep.levels.summary.wake.count	integer	count
minutes	sleep.levels.summary.wake.minutes	integer	minutes
thirtyDayAvgMinutes	sleep.levels.summary.wake.thirtyDayAvgMinutes	integer	thirtyDayAvgMinutes
logId	sleep.logId	integer	logId
logType	sleep.logType	string	logType
minutesAfterWakeup	sleep.minutesAfterWakeup	integer	minutesAfterWakeup
minutesAsleep	sleep.minutesAsleep	integer	minutesAsleep
minutesAwake	sleep.minutesAwake	integer	minutesAwake
minutesToFallAsleep	sleep.minutesToFallAsleep	integer	minutesToFallAsleep
startTime	sleep.startTime	string	startTime
timeInBed	sleep.timeInBed	integer	timeInBed
type	sleep.type	string	type

Get VO2 Max Summary by Date

Operation ID:

GetVO2MaxSummarybyDate

Returns the Cardio Fitness Score (also known as VO2 Max) data for a single date. VO2 Max values will be shown as a range if no run data is available or a single numeric value if the user uses a GPS for runs. See Additional Information for further context.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Date	date	True	string	The date in the format yyyy-mm-dd or today.

Returns

Name	Path	Type	Description
cardioScore	cardioScore	array of object	cardioScore
dateTime	cardioScore.dateTime	string	The date specified in the format YYYY-MM-DD.
vo2Max	cardioScore.value.vo2Max	string	The displayable value of VO2 Max in mL/kg/min

Get Weight Log

Operation ID:

GetWeightLog

Retrieves a list of all user's weight log entries for a given date.

Parameters

Name	Key	Required	Type	Description
User Id	user-id	True	string	The encoded ID of the user
Date	date	True	string	The date in the format yyyy-mm-dd

Returns

Name	Path	Type	Description
weight	weight	array of object	weight
bmi	weight.bmi	float	Calculated BMI in the format X.XX
date	weight.date	string	Log entry date in the format yyyy-mm-dd.
fat	weight.fat	integer
logId	weight.logId	integer	Weight Log IDs are unique to the user, but not globally unique.
source	weight.source	string	source
time	weight.time	string	Time of the measurement; hours and minutes in the format HH:mm:ss, set to the last second of the day if not provided.
weight	weight.weight	integer	Weight in the format X.XX, in the unit system that corresponds to the Accept-Language header provided or if not provided in metric.

Get Weight Time Series by Date

Operation ID:

GetWeightTimeSeriesbyDate

Retrieves a list of all user's weight log entries for a given period.

Parameters

Name	Key	Required	Type	Description
User id	user-id	True	string	The encoded ID of the user
Date	date	True	string	The end date of the period specified in the format yyyy-mm-dd or today.
Period	period	True	string	The range for which data will be returned.

Returns

Name	Path	Type	Description
weight	weight	array of object	weight
bmi	weight.bmi	float	Calculated BMI in the format X.XX.
date	weight.date	string	Log entry date in the format yyyy-mm-dd.
fat	weight.fat	integer	The body fat percentage.
logId	weight.logId	integer	The weight log IDs. It's unique to the user, but not globally unique.
source	weight.source	string	The source of the weight log.
time	weight.time	string	Time of the measurement; hours and minutes in the format HH:mm:ss, set to the last second of the day if not provided.
weight	weight.weight	integer	Weight in the format X.XX, in the unit system that corresponds to the Accept-Language header provided or if not provided in metric.