通过

Fitbit （独立发布者） （预览版）

访问 Fitbit Web API 的方法

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name 阿什温·加内什·库马尔
URL https://www.blisdigital.com/
Email a.kumar@blisdigital.com
连接器元数据
发布者 阿什温·加内什·库马尔
网站 https://dev.fitbit.com//
隐私策略 https://www.fitbit.com/global/nl/legal/privacy-policy
类别 Data

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

按日期范围获取睡眠日志

返回日期范围的用户的睡眠日志条目的列表。
按日期获取 HRV 摘要

此终结点返回单个日期的心率可变性（HRV）数据
按日期获取 VO2 最大摘要

返回单个日期的有氧健身分数（也称为 VO2 Max）数据。 如果用户使用 GPS 运行，VO2 最大值将显示为范围（如果没有可用的运行数据），或单个数值。 有关进一步上下文的详细信息，请参阅“其他信息”。
按日期获取呼吸速率摘要

此终结点返回单个日期的平均呼吸速率数据。 呼吸速率数据特别适用于用户的“主睡眠”，这是他们在特定日期睡觉的最长时间。
按日期获取权重时序

检索给定时间段内所有用户权重日志条目的列表。
按日期获取正文时序

检索给定时间段内所有用户的 bmi、身体脂肪或体重的列表。
按日期获取活动时序

通过指定日期和时间时间段检索给定资源的活动数据。 响应将仅包括每日摘要值。
按日期获取睡眠日志

返回给定日期的用户睡眠日志条目的列表
按日期获取身体脂肪时序

检索给定时间段内所有用户的正文脂肪日志条目的列表。
获取个人资料

检索用户的配置文件数据。
获取好友排行榜

此终结点返回用户的朋友排行榜
获取所有活动类型

检索所有有效的 Fitbit 公共活动和专用用户创建活动的列表，该活动采用所请求的格式从 Fitbit 活动数据库。 如果可用，则会显示活动级别详细信息。
获取收藏夹活动

检索用户最喜欢的活动的列表。
获取最近的活动类型

检索用户最近记录的活动类型的列表，其中包含该类型的最后一个活动日志的一些详细信息。
获取权重日志

检索给定日期的所有用户权重日志条目的列表。
获取每日活动摘要

检索给定日期的用户活动和活动日志条目的摘要和列表。
获取活动 TCX

训练中心 XML（TCX）是包含 GPS、心率和圈数据的数据交换格式。 此终结点在记录的练习期间使用 GPS 和心率数据检索用户位置的详细信息。
获取活动日志列表

检索给定一天之前或之后用户的活动日志条目的列表。
获取活动目标

检索用户的当前每日或每周活动目标。
获取活动类型

根据请求的格式从 Fitbit 活动数据库中检索单个活动的详细信息。 如果可用，则会显示活动级别详细信息。
获取生存期统计信息

检索用户的活动统计信息。
获取睡眠日志列表

返回给定日期前后用户睡眠日志条目的列表
获取睡眠目标

指定用户的编码 ID。 对当前登录用户使用“-”（dash）。
获取警报

检索为特定设备启用的警报。
获取设备

检索与用户帐户配对的 Fitbit 设备列表。
获取身体目标

检索用户的身体脂肪和体重目标。
获取身体脂肪日志

检索给定日期所有用户的正文脂肪日志条目的列表。
获取锁屏提醒

检索用户的锁屏提醒列表。
获取频繁的活动

检索用户的频繁活动的列表。

按日期范围获取睡眠日志

操作 ID:
GetSleepLogbyDateRange

返回日期范围的用户的睡眠日志条目的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
开始日期
 startDate True string

要返回的第一个睡眠日志的日期（yyyy-mm-dd）
结束日期
 endDate True string

返回的最后一个睡眠日志的日期（yyyy-mm-dd）

返回

名称 路径 类型 说明
sleep
 sleep array of object

sleep
dateOfSleep
 sleep.dateOfSleep string

睡眠日志结束的日期。
duration
 sleep.duration integer

睡眠的长度（以毫秒为单位）。
效率
 sleep.efficiency integer

计算的睡眠效率分数。 这不是移动应用程序中可用的睡眠分数。
endTime
 sleep.endTime string

睡眠日志结束的时间。
infoCode
 sleep.infoCode integer

一个整数值，表示在睡眠日志中收集的数据的质量。 0 = 足以生成睡眠日志的数据。 1 = 心率数据不足。 2 = 睡眠期太短（不到 3 小时）。 3 = 服务器端问题。
isMainSleep
 sleep.isMainSleep boolean

布尔
数据
 sleep.levels.data array of object

数据
dateTime
 sleep.levels.data.dateTime string

dateTime
水平仪
 sleep.levels.data.level string

水平仪
seconds
 sleep.levels.data.seconds integer

seconds
计数
 sleep.levels.summary.asleep.count integer

计数
分钟数
 sleep.levels.summary.asleep.minutes integer

分钟数
计数
 sleep.levels.summary.awake.count integer

计数
分钟数
 sleep.levels.summary.awake.minutes integer

分钟数
计数
 sleep.levels.summary.restless.count integer

计数
分钟数
 sleep.levels.summary.restless.minutes integer

分钟数
计数
 sleep.levels.summary.deep.count integer

计数
分钟数
 sleep.levels.summary.deep.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.deep.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.light.count integer

计数
分钟数
 sleep.levels.summary.light.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.light.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.rem.count integer

计数
分钟数
 sleep.levels.summary.rem.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.rem.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.wake.count integer

计数
分钟数
 sleep.levels.summary.wake.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.wake.thirtyDayAvgMinutes integer

3DayAvgMinutes
shortData
 sleep.levels.shortData array of object

shortData
dateTime
 sleep.levels.shortData.dateTime string

dateTime
水平仪
 sleep.levels.shortData.level string

水平仪
seconds
 sleep.levels.shortData.seconds integer

seconds
logId
 sleep.logId integer

睡眠日志 ID。
minutesAfterWakeup
 sleep.minutesAfterWakeup integer

用户醒来后的分钟总数。
minutesAsleep
 sleep.minutesAsleep integer

用户睡眠的总分钟数。
minutesAwake
 sleep.minutesAwake integer

仅“唤醒”分钟的总和。 它不包括在睡前或醒来后。
minutesToFallAsleep
 sleep.minutesToFallAsleep integer

用户入睡前的总分钟数。 对于自动睡眠创建的睡眠日志，此值通常为 0。
logType
 sleep.logType string

auto_detected |手动
startTime
 sleep.startTime string

睡眠日志开始的时间
timeInBed
 sleep.timeInBed integer

用户在床上的总分钟数
类型
 sleep.type string

经典 |阶段

按日期获取 HRV 摘要

操作 ID:
GetHRVSummarybyDate

此终结点返回单个日期的心率可变性（HRV）数据

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

格式为 yyyy-MM-dd 或今天日期的日期。

返回

名称 路径 类型 说明
hrv
 hrv array of object

hrv
dailyRmssd
 hrv.value.dailyRmssd float

心跳之间的连续差异（RMSSD）的根平均平方。 它以毫秒为单位测量用户每日心率的短期可变性（ms）。
deepRmssd
 hrv.value.deepRmssd float

心跳之间的连续差异（RMSSD）的根平均平方。 它测量用户的心率的短期可变性，而在深度睡眠中，以毫秒为单位（ms）。
dateTime
 hrv.dateTime string

以 YYYY-MM-DD 格式指定的睡眠日志日期。

按日期获取 VO2 最大摘要

操作 ID:
GetVO2MaxSummarybyDate

返回单个日期的有氧健身分数（也称为 VO2 Max）数据。 如果用户使用 GPS 运行，VO2 最大值将显示为范围（如果没有可用的运行数据），或单个数值。 有关进一步上下文的详细信息，请参阅“其他信息”。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

格式为 yyyy-mm-dd 或今天日期。

返回

名称 路径 类型 说明
有氧心
 cardioScore array of object

有氧心
dateTime
 cardioScore.dateTime string

以 YYYY-MM-DD 格式指定的日期。
vo2Max
 cardioScore.value.vo2Max string

VO2 Max 的可显示值（以 mL/kg/min 为单位）

按日期获取呼吸速率摘要

操作 ID:
GetBreathingRateSummarybyDate

此终结点返回单个日期的平均呼吸速率数据。 呼吸速率数据特别适用于用户的“主睡眠”，这是他们在特定日期睡觉的最长时间。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

格式为 yyyy-mm-dd 或今天日期。

返回

名称 路径 类型 说明
br
 br array of object

br
breathingRate
 br.value.breathingRate float

每分钟呼吸的平均次数。
dateTime
 br.dateTime string

以 YYYY-MM-DD 格式指定的睡眠日志日期。

按日期获取权重时序

操作 ID:
GetWeightTimeSeriesbyDate

检索给定时间段内所有用户权重日志条目的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

以 yyyy-mm-dd 或今天格式指定的时间段的结束日期。
期限
 period True string

将返回数据的范围。

返回

名称 路径 类型 说明
重量
 weight array of object

重量
bmi
 weight.bmi float

以 X.XX 格式计算的 BMI。
date
 weight.date string

以 yy-mm-dd格式记录条目日期。
脂肪
 weight.fat integer

身体脂肪百分比。
logId
 weight.logId integer

权重日志 ID。 它对用户是唯一的，但并非全局唯一。
源
 weight.source string

权重日志的源。
time
 weight.time string

度量时间;HH：mm：ss 格式的小时和分钟数，如果未提供，则设置为当天的最后一秒。
重量
 weight.weight integer

X.XX 格式的权重，在与提供的 Accept-Language 标头相对应的单元系统中，或者指标中未提供。

按日期获取正文时序

操作 ID:
GetBodyTimeSeriesbyDate

检索给定时间段内所有用户的 bmi、身体脂肪或体重的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
Resource
 resource True string

要返回的正文资源。
日期
 date True string

以 yyyy-mm-dd 或今天格式指定的时间段的结束日期。
期限
 period True string

将返回数据的范围。

返回

名称 路径 类型 说明
body-weight
 body-weight array of object

body-weight
dateTime
 body-weight.dateTime string

dateTime
value
 body-weight.value string

value

按日期获取活动时序

操作 ID:
GetActivityTimeSeriesbyDate

通过指定日期和时间时间段检索给定资源的活动数据。 响应将仅包括每日摘要值。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
Resource
 resource True string

要返回的数据的资源。
日期
 date True string

以 yyyy-mm-dd 格式指定的时间段的结束日期
期限
 period True string

将返回数据的范围。

返回

名称 路径 类型 说明
activities-steps
 activities-steps array of object

activities-steps
dateTime
 activities-steps.dateTime string

dateTime
value
 activities-steps.value string

value

按日期获取睡眠日志

操作 ID:
GetSleepLogbyDate

返回给定日期的用户睡眠日志条目的列表

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

yyyy-mm-dd

返回

名称 路径 类型 说明
sleep
 sleep array of object

sleep
dateOfSleep
 sleep.dateOfSleep string

睡眠日志结束日期
duration
 sleep.duration integer

睡眠的长度（以毫秒为单位）。
效率
 sleep.efficiency integer

计算的睡眠效率分数。 这不是移动应用程序中可用的睡眠分数。
endTime
 sleep.endTime string

睡眠日志结束的时间。
infoCode
 sleep.infoCode integer

一个整数值，表示在睡眠日志中收集的数据的质量。 0 = 足以生成睡眠日志的数据。 1 = 心率数据不足。 2 = 睡眠期太短（不到 3 小时）。 3 = 服务器端问题。
isMainSleep
 sleep.isMainSleep boolean

布尔
数据
 sleep.levels.data array of object

数据
dateTime
 sleep.levels.data.dateTime string

dateTime
水平仪
 sleep.levels.data.level string

水平仪
seconds
 sleep.levels.data.seconds integer

seconds
shortData
 sleep.levels.shortData array of object

shortData
dateTime
 sleep.levels.shortData.dateTime string

dateTime
水平仪
 sleep.levels.shortData.level string

水平仪
seconds
 sleep.levels.shortData.seconds integer

seconds
计数
 sleep.levels.summary.deep.count integer

计数
分钟数
 sleep.levels.summary.deep.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.deep.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.light.count integer

计数
分钟数
 sleep.levels.summary.light.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.light.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.rem.count integer

计数
分钟数
 sleep.levels.summary.rem.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.rem.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.wake.count integer

计数
分钟数
 sleep.levels.summary.wake.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.wake.thirtyDayAvgMinutes integer

3DayAvgMinutes
logId
 sleep.logId integer

睡眠日志 ID。
minutesAfterWakeup
 sleep.minutesAfterWakeup integer

用户醒来后的分钟总数。
minutesAsleep
 sleep.minutesAsleep integer

用户睡眠的总分钟数。
minutesAwake
 sleep.minutesAwake integer

仅“唤醒”分钟的总和。 它不包括在睡前或醒来后。
minutesToFallAsleep
 sleep.minutesToFallAsleep integer

用户入睡前的总分钟数。 对于自动睡眠创建的睡眠日志，此值通常为 0。
logType
 sleep.logType string

auto_detected |手动
startTime
 sleep.startTime string

睡眠日志开始的时间。
timeInBed
 sleep.timeInBed integer

用户在床上的总分钟数。
类型
 sleep.type string

经典 |阶段
深
 summary.stages.deep integer

深
光
 summary.stages.light integer

光
rem
 summary.stages.rem integer

rem
唤醒
 summary.stages.wake integer

唤醒
totalMinutesAsleep
 summary.totalMinutesAsleep integer

用户在睡眠日志中的所有睡眠记录中处于睡眠状态的总分钟数。
totalSleepRecords
 summary.totalSleepRecords integer

睡眠日志中的睡眠记录数。
totalTimeInBed
 summary.totalTimeInBed integer

用户在睡眠日志中的所有记录中处于床上的总分钟数。

按日期获取身体脂肪时序

操作 ID:
GetBodyFatTimerSeriesbyDate

检索给定时间段内所有用户的正文脂肪日志条目的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

以 yyyy-mm-dd 或今天格式指定的时间段的结束日期。
期限
 period True string

将返回数据的范围。

返回

名称 路径 类型 说明
脂肪
 fat array of object

脂肪
date
 fat.date string

记录身体脂肪日志的日期。
脂肪
 fat.fat float

身体脂肪百分比。
logId
 fat.logId integer

正文脂肪日志 ID。
源
 fat.source string

身体脂肪数据源自的位置。 有关详细信息，请参阅“源”值。
time
 fat.time string

记录正文脂肪日志时的时间戳。

获取个人资料

操作 ID:
GetProfile

检索用户的配置文件数据。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
aboutMe
 user.aboutMe string

用户帐户设置中指定的“关于我”信息。
年龄
 user.age string

基于其在用户帐户设置中指定生日的年龄。
大使
 user.ambassador string

大使
autoStrideEnabled
 user.autoStrideEnabled string

autoStrideEnabled
化身
 user.avatar string

化身
虚拟形象 150
 user.avatar150 string

虚拟形象 150
虚拟形象640
 user.avatar640 string

虚拟形象640
averageDailySteps
 user.averageDailySteps string

为用户计算的平均每日步骤。
challengesBeta
 user.challengesBeta string

challengesBeta
clockTimeDisplayFormat
 user.clockTimeDisplayFormat string

clockTimeDisplayFormat
country
 user.country string

country
企业
 user.corporate string

企业
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
身高
 user.height string

用户帐户设置中指定的高度值。
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
区域设置
 user.locale string

区域设置
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
状态
 user.state string

状态
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

列出用户当前赚取的 Fitbit 锁屏提醒的数组。
waterUnit
 user.waterUnit string

waterUnit
waterUnitName
 user.waterUnitName string

waterUnitName
重量
 user.weight string

重量
weightUnit
 user.weightUnit string

weightUnit

获取好友排行榜

操作 ID:
GetFriendsLeaderboard

此终结点返回用户的朋友排行榜

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
数据
 data array of object

数据
类型
 data.type string

类型
id
 data.id string

id
step-rank
 data.attributes.step-rank integer

在用户好友中排名。
步骤摘要
 data.attributes.step-summary integer

每周步骤计数。
类型
 data.relationships.user.data.type string

类型
id
 data.relationships.user.data.id string

id
包括
 included array of object

包括
类型
 included.type string

类型
id
 included.id string

id
化身
 included.attributes.avatar string

链接到用户的头像图片。
子
 included.attributes.child boolean

子
朋友
 included.attributes.friend boolean

朋友
姓名
 included.attributes.name string

姓名

获取所有活动类型

操作 ID:
GetAllActivityTypes

检索所有有效的 Fitbit 公共活动和专用用户创建活动的列表，该活动采用所请求的格式从 Fitbit 活动数据库。 如果可用，则会显示活动级别详细信息。

返回

名称 路径 类型 说明
categories
 categories array of object

categories
activities
 categories.activities array of object

activities
访问级别
 categories.activities.accessLevel string

访问级别
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
姓名
 categories.activities.activityLevels.name string

姓名
hasSpeed
 categories.activities.hasSpeed boolean

hasSpeed
id
 categories.activities.id integer

id
姓名
 categories.activities.name string

姓名
mets
 categories.activities.mets float

mets

获取收藏夹活动

操作 ID:
GetFavoriteActivities

检索用户最喜欢的活动的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
array of object
activityId
 activityId integer

记录的活动标识符号。
描述
 description string

有关记录活动的其他信息。
mets
 mets integer

活动的代谢等效物（MET）。
姓名
 name string

记录的活动的名称。

获取最近的活动类型

操作 ID:
GetRecentActivityTypes

检索用户最近记录的活动类型的列表，其中包含该类型的最后一个活动日志的一些详细信息。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
array of object
activityId
 activityId integer

活动或练习的数字 ID。
卡路里
 calories integer

记录的活动期间燃烧的卡路里数。
描述
 description string

有关活动或练习的信息（如果有）。
距离
 distance integer

在记录的活动期间行驶的距离。
duration
 duration integer

完成记录的活动的时间（毫秒）。
姓名
 name string

活动或练习的名称。

获取权重日志

操作 ID:
GetWeightLog

检索给定日期的所有用户权重日志条目的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

格式为 yyyy-mm-dd 的日期

返回

名称 路径 类型 说明
重量
 weight array of object

重量
bmi
 weight.bmi float

以 X.XX 格式计算的 BMI
date
 weight.date string

以 yy-mm-dd格式记录条目日期。
脂肪
 weight.fat integer
logId
 weight.logId integer

权重日志 ID 对用户是唯一的，但并非全局唯一。
源
 weight.source string

源
time
 weight.time string

度量时间;HH：mm：ss 格式的小时和分钟数，如果未提供，则设置为当天的最后一秒。
重量
 weight.weight integer

X.XX 格式的权重，在与提供的 Accept-Language 标头相对应的单元系统中，或者指标中未提供。

获取每日活动摘要

操作 ID:
GetDailyActivitySummary

检索给定日期的用户活动和活动日志条目的摘要和列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

日期

返回

名称 路径 类型 说明
activities
 activities array of

activities
activeMinutes
 goals.activeMinutes integer

activeMinutes
caloriesOut
 goals.caloriesOut integer

caloriesOut
距离
 goals.distance float

距离
地板
 goals.floors integer

地板
steps
 goals.steps integer

steps
activeScore
 summary.activeScore integer

activeScore
activityCalories
 summary.activityCalories integer

activityCalories
calorieEstimationMu
 summary.calorieEstimationMu integer

calorieEstimationMu
卡路里BMR
 summary.caloriesBMR integer

卡路里BMR
caloriesOut
 summary.caloriesOut integer

caloriesOut
caloriesOutUnestimated
 summary.caloriesOutUnestimated integer

caloriesOutUnestimated
customHeartRateZones
 summary.customHeartRateZones array of object

customHeartRateZones
caloriesOut
 summary.customHeartRateZones.caloriesOut integer

caloriesOut
最大值
 summary.customHeartRateZones.max integer

最大值
分钟
 summary.customHeartRateZones.min integer

分钟
分钟数
 summary.customHeartRateZones.minutes integer

分钟数
姓名
 summary.customHeartRateZones.name string

姓名
距离
 summary.distances array of object

距离
活动
 summary.distances.activity string

<活动名称> | total | tracker | loggedActivities | veryActive | moderatelyActive | lightlyActive | sedentaryActive
距离
 summary.distances.distance integer

对于指定的资源，在 Accept-Language 标头定义的单位中显示的当天的距离。
提升
 summary.elevation integer

在 Accept-Language 标头定义的单位中显示的当天的提升。
fairlyActiveMinutes
 summary.fairlyActiveMinutes integer

用户相当/适度处于活动状态的总分钟数。
地板
 summary.floors integer

在 Accept-Language 标头定义的单位中显示的当天，等效楼层爬升。
heartRateZones
 summary.heartRateZones array of object

heartRateZones
caloriesOut
 summary.heartRateZones.caloriesOut integer

caloriesOut
最大值
 summary.heartRateZones.max integer

最大值
分钟
 summary.heartRateZones.min integer

分钟
分钟数
 summary.heartRateZones.minutes integer

分钟数
姓名
 summary.heartRateZones.name string

若要查看此值，需要心率范围。 范围不足 |脂肪燃烧 |有氧 |峰
lightlyActiveMinutes
 summary.lightlyActiveMinutes integer

用户处于活动状态的总分钟数。
marginalCalories
 summary.marginalCalories integer

当天燃烧的总边际估计卡路里。
restingHeartRate
 summary.restingHeartRate integer

若要查看此值，需要“心率”范围。
sedentaryMinutes
 summary.sedentaryMinutes integer

用户已久坐的总分钟数。
steps
 summary.steps integer

当天执行的总步骤。
useEstimation
 summary.useEstimation boolean

布尔值，指示是否在计算中使用估计值。
veryActiveMinutes
 summary.veryActiveMinutes integer

用户处于活动状态的总分钟数。

获取活动 TCX

操作 ID:
GetActivityTCX

训练中心 XML（TCX）是包含 GPS、心率和圈数据的数据交换格式。 此终结点在记录的练习期间使用 GPS 和心率数据检索用户位置的详细信息。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

使用的编码 ID
日志 ID
 log-id True string

活动的日志 ID。
部分 TCX
 includePartialTCX boolean

当 GPS 数据不可用时，包括 TCX 点。

获取活动日志列表

操作 ID:
GetActivityLogList

检索给定一天之前或之后用户的活动日志条目的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期之后
 afterDate string

后日期 （yyyy -mm-dd）
日期之前
 beforeDate string

前日期 （yyyy -mm-dd）
排序
 sort string

按日期排序条目的排序顺序。
限度
 limit integer

返回的条目数。

返回

名称 路径 类型 说明
activities
 activities array of object

activities
activeDuration
 activities.activeDuration integer

每个 activityLevel 中的时间（毫秒）。
activityLevel
 activities.activityLevel array of object

activityLevel
分钟数
 activities.activityLevel.minutes integer

分钟数
姓名
 activities.activityLevel.name string

姓名
activityName
 activities.activityName string

记录的练习的名称。
activityTypeId
 activities.activityTypeId integer

activityName 的标识符号。
卡路里
 activities.calories integer

锻炼期间燃烧的卡路里数。
caloriesLink
 activities.caloriesLink string

要调用的 Web API 终结点，以获取为命名练习燃烧的特定卡路里。
duration
 activities.duration integer

编辑练习后的时间长度（毫秒）。 如果未编辑练习，持续时间 = originalDuration。 此值将包含练习期间的暂停。
elevationGain
 activities.elevationGain float

练习期间获得的提升。
lastModified
 activities.lastModified string

上次修改练习的时间戳。
logId
 activities.logId integer

练习的活动日志标识符。
logType
 activities.logType string

auto_detected |manual |mobile_run |跟踪器 |第三方应用程序的名称
卡路里
 activities.manualValuesSpecified.calories boolean

一个布尔值，指示记录锻炼时是否提供了卡路里。
距离
 activities.manualValuesSpecified.distance boolean

一个布尔值，指示记录练习时是否提供了距离。
steps
 activities.manualValuesSpecified.steps boolean

一个布尔值，指示记录练习时是否提供了步骤。
originalDuration
 activities.originalDuration integer

记录练习的初始长度（毫秒）。 此值将包含练习期间的暂停。
originalStartTime
 activities.originalStartTime string

记录练习的初始开始日期时间。
startTime
 activities.startTime string

编辑练习后的开始日期时间。 如果未编辑练习，startTime = originalStartTime。
steps
 activities.steps integer

练习期间执行的步骤数。
tcxLink
 activities.tcxLink string

用于下载 TCX 文件的 URL。
afterDate
 pagination.afterDate string

afterDate
limit
 pagination.limit integer

limit
下一个
 pagination.next string

下一个
偏移
 pagination.offset integer

偏移
以前
 pagination.previous string

以前
排序
 pagination.sort string

排序

获取活动目标

操作 ID:
GetActivityGoals

检索用户的当前每日或每周活动目标。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
期限
 period True string

每日|周刊

返回

名称 路径 类型 说明
activeMinutes
 goals.activeMinutes integer

每日活动分钟数目标。 对于每周目标，不会返回值。
activeZoneMinutes
 goals.activeZoneMinutes integer

每日或每周活动区域分钟目标。
caloriesOut
 goals.caloriesOut integer

每日卡路里燃烧的目标。 对于每周目标，不会返回值。
距离
 goals.distance float

每日或每周距离目标。
地板
 goals.floors integer

每天或每周的楼层都爬进了目标。
steps
 goals.steps integer

每日或每周步骤都采取了目标。

获取活动类型

操作 ID:
GetAcitivityType

根据请求的格式从 Fitbit 活动数据库中检索单个活动的详细信息。 如果可用，则会显示活动级别详细信息。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
活动 ID
 activity-id True string

活动 ID

返回

名称 路径 类型 说明
访问级别
 activity.accessLevel string

PUBLIC |私人
activityLevels
 activity.activityLevels array of object

activityLevels
id
 activity.activityLevels.id integer

表示相应活动级别的数值。
maxSpeedMPH
 activity.activityLevels.maxSpeedMPH float

MPH 的最大速度。 值：-1 表示不适用。
mets
 activity.activityLevels.mets integer

活动 ID 的 MET 评分。
minSpeedMPH
 activity.activityLevels.minSpeedMPH integer

MPH 中的最小速度。 值：-1 表示不适用。
姓名
 activity.activityLevels.name string

活动级别的名称。
hasSpeed
 activity.hasSpeed boolean

true |假
id
 activity.id integer

表示相应活动的数值。
姓名
 activity.name string

活动或练习的名称。

获取生存期统计信息

操作 ID:
GetLifetimeStats

检索用户的活动统计信息。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
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
距离
 lifetime.total.distance float

距离
地板
 lifetime.total.floors integer

地板
steps
 lifetime.total.steps integer

steps
activeScore
 lifetime.tracker.activeScore integer

activeScore
caloriesOut
 lifetime.tracker.caloriesOut integer

caloriesOut
距离
 lifetime.tracker.distance float

距离
地板
 lifetime.tracker.floors integer

地板
steps
 lifetime.tracker.steps integer

steps

获取睡眠日志列表

操作 ID:
GetSleepLogList

返回给定日期前后用户睡眠日志条目的列表

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期之后
 afterDate string

返回用户的睡眠日志的日期后（yyyy-mm-dd）
日期之前
 beforeDate string

在返回用户的睡眠日志的日期之前（yyyy-mm-dd）
排序
 sort string

升序或降序
限度
 limit integer

要返回的睡眠日志数。 （最大值 100）

返回

名称 路径 类型 说明
afterDate
 pagination.afterDate string

afterDate
limit
 pagination.limit integer

limit
下一个
 pagination.next string

下一个
偏移
 pagination.offset integer

偏移
以前
 pagination.previous string

以前
排序
 pagination.sort string

排序
sleep
 sleep array of object

sleep
dateOfSleep
 sleep.dateOfSleep string
duration
 sleep.duration integer

duration
效率
 sleep.efficiency integer

效率
endTime
 sleep.endTime string

endTime
infoCode
 sleep.infoCode integer

infoCode
isMainSleep
 sleep.isMainSleep boolean

isMainSleep
数据
 sleep.levels.data array of object

数据
dateTime
 sleep.levels.data.dateTime string

dateTime
水平仪
 sleep.levels.data.level string

水平仪
seconds
 sleep.levels.data.seconds integer

seconds
shortData
 sleep.levels.shortData array of object

shortData
dateTime
 sleep.levels.shortData.dateTime string

dateTime
水平仪
 sleep.levels.shortData.level string

水平仪
seconds
 sleep.levels.shortData.seconds integer

seconds
计数
 sleep.levels.summary.deep.count integer

计数
分钟数
 sleep.levels.summary.deep.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.deep.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.light.count integer

计数
分钟数
 sleep.levels.summary.light.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.light.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.rem.count integer

计数
分钟数
 sleep.levels.summary.rem.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.rem.thirtyDayAvgMinutes integer

3DayAvgMinutes
计数
 sleep.levels.summary.wake.count integer

计数
分钟数
 sleep.levels.summary.wake.minutes integer

分钟数
3DayAvgMinutes
 sleep.levels.summary.wake.thirtyDayAvgMinutes integer

3DayAvgMinutes
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
类型
 sleep.type string

类型

获取睡眠目标

操作 ID:
GetSleepGoal

指定用户的编码 ID。 对当前登录用户使用“-”（dash）。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
flowId
 consistency.flowId integer

0 = 设置了睡眠目标，但记录的睡眠日志不足。 1 = 用户错过了睡眠目标或未设定任何目标，但记录了足够的睡眠日志。 2 = 未设置睡眠目标，并且记录的睡眠日志不足。 3 = 用户实现了睡眠目标
minDuration
 goal.minDuration integer

睡眠目标时间段的长度（以分钟为单位）。
updatedOn
 goal.updatedOn string

创建/更新目标的时间戳。

获取警报

操作 ID:
GetAlarms

检索为特定设备启用的警报。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
跟踪器 ID
 tracker-id True string

返回数据的跟踪器的 ID。

返回

名称 路径 类型 说明
trackerAlarms
 trackerAlarms array of object

trackerAlarms
alarmId
 trackerAlarms.alarmId integer

表示警报 ID 的数值。
已删除
 trackerAlarms.deleted boolean

指示是否已删除警报。
enabled
 trackerAlarms.enabled boolean

指示是否启用了警报。
经常性
 trackerAlarms.recurring boolean

指示警报是否重复。
snoozeCount
 trackerAlarms.snoozeCount integer

指示警报暂停的次数。
snoozeLength
 trackerAlarms.snoozeLength integer

指示暂停期间之间的时间（以分钟为单位）。
syncedToDevice
 trackerAlarms.syncedToDevice boolean

true |假
time
 trackerAlarms.time string

指定警报的时间和 UTC 偏移量。
氛围
 trackerAlarms.vibe string

返回配置的振动类型。
weekDays
 trackerAlarms.weekDays array of string

weekDays

获取设备

操作 ID:
GetDevices

检索与用户帐户配对的 Fitbit 设备列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
array of object
电池
 battery string

返回设备的电池电量
batteryLevel
 batteryLevel integer

返回设备的电池电量百分比。
deviceVersion
 deviceVersion string

设备的产品名称。
features
 features array of

features
id
 id string

设备 ID。
lastSyncTime
 lastSyncTime string

表示设备上次与 Fitbit 移动应用程序同步的时间的时间戳。
mac
 mac string

Mac ID 号
类型
 type string

TRACKER |规模

获取身体目标

操作 ID:
GetBodyGoals

检索用户的身体脂肪和体重目标。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
目标类型
 goal-type True string

目标类型

返回

名称 路径 类型 说明
goalType
 goal.goalType string
startDate
 goal.startDate string

目标开始日期。
startWeight
 goal.startWeight float

建立目标时用户的权重。
重量
 goal.weight float

要实现的权重目标。
weightThreshold
 goal.weightThreshold float

建议每周减肥的体重量，以实现和维护目标。

获取身体脂肪日志

操作 ID:
GetBodyFattLog

检索给定日期所有用户的正文脂肪日志条目的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID
日期
 date True string

格式为 yyyy-mm-dd的日期。

返回

名称 路径 类型 说明
脂肪
 fat array of object

脂肪
date
 fat.date string

记录身体脂肪日志的日期。
脂肪
 fat.fat integer

身体脂肪百分比。
logId
 fat.logId integer

正文脂肪日志 ID。
源
 fat.source string

身体脂肪数据源自的位置。
time
 fat.time string

记录正文脂肪日志时的时间戳。

获取锁屏提醒

操作 ID:
GetBadges

检索用户的锁屏提醒列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
徽章
 badges array of object

徽章
badgeGradientEndColor
 badges.badgeGradientEndColor string

badgeGradientEndColor
badgeGradientStartColor
 badges.badgeGradientStartColor string

badgeGradientStartColor
badgeType
 badges.badgeType string

收到的锁屏提醒类型。
分类
 badges.category string

分类
干杯
 badges.cheers array of

干杯
dateTime
 badges.dateTime string

实现锁屏提醒的日期。
描述
 badges.description string

描述
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
姓名
 badges.name string

姓名
shareImage640px
 badges.shareImage640px string

shareImage640px
shareText
 badges.shareText string

shareText
简短描述
 badges.shortDescription string

简短描述
shortName
 badges.shortName string

shortName
timesAchieved
 badges.timesAchieved integer

用户达到锁屏提醒的次数。
value
 badges.value integer

单位度量中的锁屏提醒目标。

获取频繁的活动

操作 ID:
GetFrequentActivities

检索用户的频繁活动的列表。

参数

名称 密钥 必需 类型 说明
用户 ID
 user-id True string

用户的编码 ID

返回

名称 路径 类型 说明
array of object
activityId
 activityId integer

记录的活动标识符号。
卡路里
 calories integer

与活动相关的燃烧卡路里数。
描述
 description string

有关记录活动的其他信息。
距离
 distance integer

与记录的活动关联的距离。
duration
 duration integer

编辑练习后的时间长度（毫秒）。 此值将包含练习期间的暂停。
姓名
 name string

记录的活动的名称。