共用方式為

Fitbit （獨立發行商） （預覽版）

存取 Fitbit Web API 的方法

此連接器適用於以下產品和區域：

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 （DoD）
Power Apps 進階 除下列區域外的所有 Power Apps 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
連絡人​​
名稱 阿什溫·加內什·庫馬爾
URL https://www.blisdigital.com/
Email a.kumar@blisdigital.com
連接器中繼資料
Publisher 阿什溫·加內什·庫馬爾
網站 https://dev.fitbit.com//
隱私策略 https://www.fitbit.com/global/nl/legal/privacy-policy
類別 資料

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

依日期取得活動時間序列

透過指定日期和時段，擷取指定資源在一段時間內的活動資料。 回應將僅包含每日摘要值。
取得徽章

擷取使用者徽章的清單。
取得所有活動類型

以要求的格式從 Fitbit 活動資料庫擷取所有有效的 Fitbit 公開活動和使用者建立的私人活動清單。 如果可用，將顯示活動層級詳細資訊。
取得最近的活動類型

擷取記錄的使用者最近活動類型的清單，其中包含該類型的最後一個活動記錄的一些詳細資料。
取得活動日誌清單

擷取使用者在指定日期之前或之後的活動記錄項目清單。
取得活動目標

擷取使用者目前的每日或每週活動目標。
取得活動類型

以要求的格式從 Fitbit 活動資料庫擷取單一活動的詳細資料。 如果可用，將顯示活動層級詳細資訊。
取得睡眠日誌清單

傳回指定日期之前或之後使用者睡眠記錄項目的清單
可在安卓獲取Activity TCX

訓練中心 XML （TCX） 是一種資料交換格式，其中包含 GPS、心率和圈數資料。 此端點在記錄的運動期間使用 GPS 和心率資料擷取使用者位置的詳細資料。
按日期獲取 HRV 摘要

此端點會傳回單一日期的心率變異性 （HRV） 資料
按日期獲取 VO2 Max 摘要

傳回單一日期的 Cardio Fitness Score （也稱為 VO2 Max） 資料。 如果沒有可用的跑步數據，VO2 Max 值將顯示為一個範圍，如果用戶使用 GPS 進行跑步，則將顯示為單個數值。 如需進一步的背景資訊，請參閱其他資訊。
按日期獲取呼吸頻率摘要

此端點會傳回單一日期的平均呼吸頻率資料。 呼吸頻率數據專門適用於用戶的“主要睡眠”，這是他們在給定日期睡眠的最長單時。
按日期獲取睡眠日誌

傳回指定日期的使用者睡眠記錄項目清單
按日期獲取身體時間序列

擷取指定時段內所有使用者的 BMI、體脂或體重清單。
按日期獲取體脂時間序列

擷取指定期間內所有使用者體脂記錄項目的清單。
按日期獲取體重時間序列

擷取指定期間內所有使用者權重記錄項目的清單。
按日期範圍獲取睡眠日誌

傳回日期範圍的使用者睡眠記錄項目清單。
獲取個人資料

擷取使用者的設定檔資料。
獲取好友排行榜

此端點會傳回使用者的好友排行榜
獲取最喜歡的活動

擷取使用者最愛活動的清單。
獲取每日活動摘要

擷取指定日期使用者活動和活動記錄專案的摘要和清單。
獲取睡眠目標

指定使用者的編碼 ID。 對目前登入的使用者使用「-」（破折號）。
獲取終身統計數據

擷取使用者的活動統計資料。
獲取設備

擷取與使用者帳戶配對的 Fitbit 裝置清單。
獲取警報

擷取為特定裝置啟用的警示。
獲取體脂日誌

擷取指定日期內所有使用者體脂記錄項目的清單。
獲取體重日誌

擷取指定日期的所有使用者權重記錄項目清單。
獲得身體目標

擷取使用者的體脂和體重目標。
獲得頻繁的活動

擷取使用者經常活動的清單。

依日期取得活動時間序列

作業識別碼：
GetActivityTimeSeriesbyDate

透過指定日期和時段，擷取指定資源在一段時間內的活動資料。 回應將僅包含每日摘要值。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Resource
 resource True string

要傳回的資料資源。
Date
 date True string

以格式 yyyy-mm-dd 指定的期間結束日期
期間
 period True string

將傳回資料的範圍。

傳回

名稱 路徑 類型 Description
活動步驟
 activities-steps array of object

活動步驟
日期時間
 activities-steps.dateTime string

日期時間
value
 activities-steps.value string

value

取得徽章

作業識別碼：
GetBadges

擷取使用者徽章的清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 Description
徽章
 badges array of object

徽章
badgeGradientEndColor
 badges.badgeGradientEndColor string

badgeGradientEndColor
badge漸層起始顏色
 badges.badgeGradientStartColor string

badge漸層起始顏色
徽章類型
 badges.badgeType string

收到的徽章類型。
分類
 badges.category string

分類
乾杯
 badges.cheers array of

乾杯
日期時間
 badges.dateTime string

獲得徽章的日期。
描述
 badges.description string

描述
earned訊息
 badges.earnedMessage string

earned訊息
編碼標識
 badges.encodedId string

編碼標識
圖片100像素
 badges.image100px string

圖片100像素
圖片125px
 badges.image125px string

圖片125px
圖片300像素
 badges.image300px string

圖片300像素
圖片50px
 badges.image50px string

圖片50px
圖片75像素
 badges.image75px string

圖片75像素
營銷說明
 badges.marketingDescription string

營銷說明
行動說明
 badges.mobileDescription string

行動說明
名稱
 badges.name string

名稱
分享圖片640像素
 badges.shareImage640px string

分享圖片640像素
分享文字
 badges.shareText string

分享文字
簡短描述
 badges.shortDescription string

簡短描述
短名稱
 badges.shortName string

短名稱
次數達成
 badges.timesAchieved integer

使用者獲得徽章的次數。
value
 badges.value integer

單位度量中的徽章目標。

取得所有活動類型

作業識別碼：
GetAllActivityTypes

以要求的格式從 Fitbit 活動資料庫擷取所有有效的 Fitbit 公開活動和使用者建立的私人活動清單。 如果可用，將顯示活動層級詳細資訊。

傳回

名稱 路徑 類型 Description
categories
 categories array of object

categories
activities
 categories.activities array of object

activities
訪問級別
 categories.activities.accessLevel string

訪問級別
活動層次
 categories.activities.activityLevels array of object

活動層次
識別碼
 categories.activities.activityLevels.id integer

識別碼
最大速度英里/小時
 categories.activities.activityLevels.maxSpeedMPH integer

最大速度英里/小時
大都會隊
 categories.activities.activityLevels.mets integer

大都會隊
最小速度MPH
 categories.activities.activityLevels.minSpeedMPH integer

最小速度MPH
名稱
 categories.activities.activityLevels.name string

名稱
has速度
 categories.activities.hasSpeed boolean

has速度
識別碼
 categories.activities.id integer

識別碼
名稱
 categories.activities.name string

名稱
大都會隊
 categories.activities.mets float

大都會隊

取得最近的活動類型

作業識別碼：
GetRecentActivityTypes

擷取記錄的使用者最近活動類型的清單，其中包含該類型的最後一個活動記錄的一些詳細資料。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 Description
array of object
活動標識符
 activityId integer

活動或練習的數字 ID。
卡路里
 calories integer

記錄活動期間燃燒的卡路里數。
描述
 description string

有關活動或鍛煉的信息（如果有）。
distance
 distance integer

記錄活動期間行駛的距離。
duration
 duration integer

完成記錄活動的時間量 （毫秒）。
名稱
 name string

活動或練習的名稱。

取得活動日誌清單

作業識別碼：
GetActivityLogList

擷取使用者在指定日期之前或之後的活動記錄項目清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
之後日期
 afterDate string

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

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

依日期排序項目的順序。
限制
 limit integer

傳回的項目數。

傳回

名稱 路徑 類型 Description
activities
 activities array of object

activities
主動持續時間
 activities.activeDuration integer

每個 activityLevel 內的時間量 （毫秒）。
活動等級
 activities.activityLevel array of object

活動等級
紀要
 activities.activityLevel.minutes integer

紀要
名稱
 activities.activityLevel.name string

名稱
活動名稱
 activities.activityName string

錄製練習的名稱。
activityTypeId
 activities.activityTypeId integer

activityName 的識別碼。
卡路里
 activities.calories integer

運動期間燃燒的卡路里數量。
卡路里鏈接
 activities.caloriesLink string

Web API 端點來呼叫，以取得具名運動燃燒的特定卡路里。
duration
 activities.duration integer

編輯練習後的時間長度 （毫秒）。 如果未編輯練習，則持續時間 = originalDuration。 此值將包含練習期間的暫停。
標高增益
 activities.elevationGain float

演習期間獲得的海拔。
上次修改
 activities.lastModified string

練習上次修改的時間戳記。
logId
 activities.logId integer

練習的活動記錄識別碼。
logType
 activities.logType string

auto_detected |手冊 |mobile_run |追蹤器 |第三方應用程式的名稱
卡路里
 activities.manualValuesSpecified.calories boolean

一個布林值，表示在記錄運動時是否提供了卡路里。
distance
 activities.manualValuesSpecified.distance boolean

一個布林值，指出在記錄練習時是否提供了距離。
steps
 activities.manualValuesSpecified.steps boolean

一個布林值，說明在記錄練習時是否提供了步驟。
original持續時間
 activities.originalDuration integer

記錄練習的初始時間長度（毫秒）。 此值將包含練習期間的暫停。
原始開始時間
 activities.originalStartTime string

記錄練習的初始開始日期時間。
startTime
 activities.startTime string

編輯練習後的開始日期時間。 如果未編輯練習，則 startTime = originalStartTime。
steps
 activities.steps integer

練習期間採取的步數。
tcx連結
 activities.tcxLink string

下載TCX檔案的URL。
afterDate 之後
 pagination.afterDate string

afterDate 之後
limit
 pagination.limit integer

limit
next
 pagination.next string

next
位移
 pagination.offset integer

位移
前
 pagination.previous string

前
排序
 pagination.sort string

排序

取得活動目標

作業識別碼：
GetActivityGoals

擷取使用者目前的每日或每週活動目標。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
 user-id True string

使用者的編碼 ID
期間
 period True string

每日|每週

傳回

名稱 路徑 類型 Description
活動分鐘數
 goals.activeMinutes integer

每日活躍分鐘數目標。 每週目標不會傳回值。
活動區域分鐘數
 goals.activeZoneMinutes integer

每日或每週活躍區域分鐘數目標。
卡路里輸出
 goals.caloriesOut integer

每日燃燒的卡路里目標。 每週目標不會傳回值。
distance
 goals.distance float

每日或每週距離目標。
樓層
 goals.floors integer

每日或每週樓層攀升目標。
steps
 goals.steps integer

每日或每週所採取的步數目標。

取得活動類型

作業識別碼：
GetAcitivityType

以要求的格式從 Fitbit 活動資料庫擷取單一活動的詳細資料。 如果可用，將顯示活動層級詳細資訊。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
活動標識符
 activity-id True string

活動標識符

傳回

名稱 路徑 類型 Description
訪問級別
 activity.accessLevel string

公眾 |私
活動層次
 activity.activityLevels array of object

活動層次
識別碼
 activity.activityLevels.id integer

代表相應活動水平的數值。
最大速度英里/小時
 activity.activityLevels.maxSpeedMPH float

最高速度（以英里/小時為單位）。 值：-1 表示不適用。
大都會隊
 activity.activityLevels.mets integer

活動識別碼的 MET 分數。
最小速度MPH
 activity.activityLevels.minSpeedMPH integer

最低速度（以英里/小時為單位）。 值：-1 表示不適用。
名稱
 activity.activityLevels.name string

活動層級的名稱。
has速度
 activity.hasSpeed boolean

真 |偽
識別碼
 activity.id integer

代表相應活動的數值。
名稱
 activity.name string

活動或練習的名稱。

取得睡眠日誌清單

作業識別碼：
GetSleepLogList

傳回指定日期之前或之後使用者睡眠記錄項目的清單

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
之後日期
 afterDate string

在返回用戶睡眠日誌的日期之後（yyyy-mm-dd）
之前日期
 beforeDate string

在傳回使用者睡眠日誌的日期之前（yyyy-mm-dd）
排序
 sort string

遞增或遞減
限制
 limit integer

要傳回的睡眠日誌數目。 （最多 100 人）

傳回

名稱 路徑 類型 Description
afterDate 之後
 pagination.afterDate string

afterDate 之後
limit
 pagination.limit integer

limit
next
 pagination.next string

next
位移
 pagination.offset integer

位移
前
 pagination.previous string

前
排序
 pagination.sort string

排序
sleep
 sleep array of object

sleep
睡眠日期
 sleep.dateOfSleep string
duration
 sleep.duration integer

duration
效率
 sleep.efficiency integer

效率
endTime
 sleep.endTime string

endTime
資訊代碼
 sleep.infoCode integer

資訊代碼
是主睡眠
 sleep.isMainSleep boolean

是主睡眠
資料
 sleep.levels.data array of object

資料
日期時間
 sleep.levels.data.dateTime string

日期時間
水平儀
 sleep.levels.data.level string

水平儀
秒
 sleep.levels.data.seconds integer

秒
短數據
 sleep.levels.shortData array of object

短數據
日期時間
 sleep.levels.shortData.dateTime string

日期時間
水平儀
 sleep.levels.shortData.level string

水平儀
秒
 sleep.levels.shortData.seconds integer

秒
count
 sleep.levels.summary.deep.count integer

count
紀要
 sleep.levels.summary.deep.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.deep.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.light.count integer

count
紀要
 sleep.levels.summary.light.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.light.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.rem.count integer

count
紀要
 sleep.levels.summary.rem.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.rem.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.wake.count integer

count
紀要
 sleep.levels.summary.wake.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.wake.thirtyDayAvgMinutes integer

三十天平均分鐘數
logId
 sleep.logId integer

logId
logType
 sleep.logType string

logType
分鐘喚醒後
 sleep.minutesAfterWakeup integer

分鐘喚醒後
分鐘睡著了
 sleep.minutesAsleep integer

分鐘睡著了
分鐘醒來
 sleep.minutesAwake integer

分鐘醒來
分鐘到入睡
 sleep.minutesToFallAsleep integer

分鐘到入睡
startTime
 sleep.startTime string

startTime
時間在床上
 sleep.timeInBed integer

時間在床上
型別
 sleep.type string

型別

可在安卓獲取Activity TCX

作業識別碼：
GetActivityTCX

訓練中心 XML （TCX） 是一種資料交換格式，其中包含 GPS、心率和圈數資料。 此端點在記錄的運動期間使用 GPS 和心率資料擷取使用者位置的詳細資料。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用的編碼ID
記錄標識碼
 log-id True string

活動的記錄 ID。
部分 TCX
 includePartialTCX boolean

當 GPS 資料不可用時，包括 TCX 點。

按日期獲取 HRV 摘要

作業識別碼：
GetHRVSummarybyDate

此端點會傳回單一日期的心率變異性 （HRV） 資料

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Date
 date True string

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

傳回

名稱 路徑 類型 Description
人權
 hrv array of object

人權
每日Rmssd
 hrv.value.dailyRmssd float

心跳之間的連續差異均方根 （RMSSD）。 它測量用戶每日心率的短期變異性，以毫秒 （ms） 為單位。
deepRmssd
 hrv.value.deepRmssd float

心跳之間的連續差異均方根 （RMSSD）。 它測量用戶在深度睡眠時心率的短期變異性，以毫秒 （ms） 為單位。
日期時間
 hrv.dateTime string

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

按日期獲取 VO2 Max 摘要

作業識別碼：
GetVO2MaxSummarybyDate

傳回單一日期的 Cardio Fitness Score （也稱為 VO2 Max） 資料。 如果沒有可用的跑步數據，VO2 Max 值將顯示為一個範圍，如果用戶使用 GPS 進行跑步，則將顯示為單個數值。 如需進一步的背景資訊，請參閱其他資訊。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Date
 date True string

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

傳回

名稱 路徑 類型 Description
心肺評分
 cardioScore array of object

心肺評分
日期時間
 cardioScore.dateTime string

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

VO2 Max 的可顯示值（以 mL/kg/min 為單位）

按日期獲取呼吸頻率摘要

作業識別碼：
GetBreathingRateSummarybyDate

此端點會傳回單一日期的平均呼吸頻率資料。 呼吸頻率數據專門適用於用戶的“主要睡眠”，這是他們在給定日期睡眠的最長單時。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Date
 date True string

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

傳回

名稱 路徑 類型 Description
BR
 br array of object

BR
呼吸率
 br.value.breathingRate float

每分鐘平均呼吸次數。
日期時間
 br.dateTime string

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

按日期獲取睡眠日誌

作業識別碼：
GetSleepLogbyDate

傳回指定日期的使用者睡眠記錄項目清單

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Date
 date True string

yyyy-mm-dd

傳回

名稱 路徑 類型 Description
sleep
 sleep array of object

sleep
睡眠日期
 sleep.dateOfSleep string

睡眠日誌結束的日期
duration
 sleep.duration integer

睡眠時間長度（以毫秒為單位）。
效率
 sleep.efficiency integer

計算的睡眠效率分數。 這不是移動應用程序中可用的睡眠分數。
endTime
 sleep.endTime string

睡眠日誌結束的時間。
資訊代碼
 sleep.infoCode integer

一個整數值，代表睡眠日誌中收集的資料品質。 0 = 足夠的資料來產生睡眠日誌。 1 = 心率數據不足。 2 = 睡眠時間太短（少於 3 小時）。 3 = 伺服器端問題。
是主睡眠
 sleep.isMainSleep boolean

布林值
資料
 sleep.levels.data array of object

資料
日期時間
 sleep.levels.data.dateTime string

日期時間
水平儀
 sleep.levels.data.level string

水平儀
秒
 sleep.levels.data.seconds integer

秒
短數據
 sleep.levels.shortData array of object

短數據
日期時間
 sleep.levels.shortData.dateTime string

日期時間
水平儀
 sleep.levels.shortData.level string

水平儀
秒
 sleep.levels.shortData.seconds integer

秒
count
 sleep.levels.summary.deep.count integer

count
紀要
 sleep.levels.summary.deep.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.deep.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.light.count integer

count
紀要
 sleep.levels.summary.light.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.light.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.rem.count integer

count
紀要
 sleep.levels.summary.rem.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.rem.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.wake.count integer

count
紀要
 sleep.levels.summary.wake.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.wake.thirtyDayAvgMinutes integer

三十天平均分鐘數
logId
 sleep.logId integer

睡眠日誌 ID。
分鐘喚醒後
 sleep.minutesAfterWakeup integer

使用者喚醒後的總分鐘數。
分鐘睡著了
 sleep.minutesAsleep integer

使用者睡眠的總分鐘數。
分鐘醒來
 sleep.minutesAwake integer

僅「喚醒」分鐘數的總和。 它不包括入睡前或醒來後。
分鐘到入睡
 sleep.minutesToFallAsleep integer

使用者入睡前的總分鐘數。 對於自動睡眠建立的睡眠記錄，此值通常為 0。
logType
 sleep.logType string

auto_detected |手工的
startTime
 sleep.startTime string

睡眠日誌開始的時間。
時間在床上
 sleep.timeInBed integer

使用者在床上的總分鐘數。
型別
 sleep.type string

經典 |階段
深
 summary.stages.deep integer

深
光線
 summary.stages.light integer

光線
rem
 summary.stages.rem integer

rem
叫醒
 summary.stages.wake integer

叫醒
總分鐘睡眠
 summary.totalMinutesAsleep integer

睡眠日誌中所有睡眠記錄中使用者睡眠的總分鐘數。
睡眠記錄總計
 summary.totalSleepRecords integer

睡眠記錄中的睡眠記錄數目。
totalTimeInBed
 summary.totalTimeInBed integer

睡眠日誌中所有記錄中使用者在床上的總分鐘數。

按日期獲取身體時間序列

作業識別碼：
GetBodyTimeSeriesbyDate

擷取指定時段內所有使用者的 BMI、體脂或體重清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Resource
 resource True string

要傳回的內文資源。
Date
 date True string

以格式 yyyy-mm-dd 或今天指定的期間結束日期。
期間
 period True string

將傳回資料的範圍。

傳回

名稱 路徑 類型 Description
體重
 body-weight array of object

體重
日期時間
 body-weight.dateTime string

日期時間
value
 body-weight.value string

value

按日期獲取體脂時間序列

作業識別碼：
GetBodyFatTimerSeriesbyDate

擷取指定期間內所有使用者體脂記錄項目的清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Date
 date True string

以格式 yyyy-mm-dd 或今天指定的期間結束日期。
期間
 period True string

將傳回資料的範圍。

傳回

名稱 路徑 類型 Description
胖
 fat array of object

胖
date
 fat.date string

記錄體脂日誌的日期。
胖
 fat.fat float

體脂百分比。
logId
 fat.logId integer

體脂日誌 ID。
來源
 fat.source string

體脂資料的來源位置。 如需詳細資訊，請參閱「來源」值。
time
 fat.time string

記錄體脂記錄的時間戳記。

按日期獲取體重時間序列

作業識別碼：
GetWeightTimeSeriesbyDate

擷取指定期間內所有使用者權重記錄項目的清單。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
 user-id True string

使用者的編碼 ID
Date
 date True string

以格式 yyyy-mm-dd 或今天指定的期間結束日期。
期間
 period True string

將傳回資料的範圍。

傳回

名稱 路徑 類型 Description
weight
 weight array of object

weight
體重指數
 weight.bmi float

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

記錄格式為 yyyy-mm-dd的記錄日期。
胖
 weight.fat integer

體脂百分比。
logId
 weight.logId integer

權重日誌 ID。 它對使用者來說是唯一的，但不是全域唯一的。
來源
 weight.source string

權重記錄檔的來源。
time
 weight.time string

測量時間;小時和分鐘，格式為 HH：mm：ss，如果未提供，則設為一天的最後一秒。
weight
 weight.weight integer

格式為 X.XX 的權重，在單位系統中，對應於提供的 Accept-Language 標頭，或者如果未在公制中提供。

按日期範圍獲取睡眠日誌

作業識別碼：
GetSleepLogbyDateRange

傳回日期範圍的使用者睡眠記錄項目清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
開始日期
 startDate True string

要傳回第一個睡眠日誌的日期 （yyyy-mm-dd）
結束日期
 endDate True string

最後傳回睡眠日誌的日期 （yyyy-mm-dd）

傳回

名稱 路徑 類型 Description
sleep
 sleep array of object

sleep
睡眠日期
 sleep.dateOfSleep string

睡眠日誌結束的日期。
duration
 sleep.duration integer

睡眠時間長度（以毫秒為單位）。
效率
 sleep.efficiency integer

計算的睡眠效率分數。 這不是移動應用程序中可用的睡眠分數。
endTime
 sleep.endTime string

睡眠日誌結束的時間。
資訊代碼
 sleep.infoCode integer

一個整數值，代表睡眠日誌中收集的資料品質。 0 = 足夠的資料來產生睡眠日誌。 1 = 心率數據不足。 2 = 睡眠時間太短（少於 3 小時）。 3 = 伺服器端問題。
是主睡眠
 sleep.isMainSleep boolean

布林值
資料
 sleep.levels.data array of object

資料
日期時間
 sleep.levels.data.dateTime string

日期時間
水平儀
 sleep.levels.data.level string

水平儀
秒
 sleep.levels.data.seconds integer

秒
count
 sleep.levels.summary.asleep.count integer

count
紀要
 sleep.levels.summary.asleep.minutes integer

紀要
count
 sleep.levels.summary.awake.count integer

count
紀要
 sleep.levels.summary.awake.minutes integer

紀要
count
 sleep.levels.summary.restless.count integer

count
紀要
 sleep.levels.summary.restless.minutes integer

紀要
count
 sleep.levels.summary.deep.count integer

count
紀要
 sleep.levels.summary.deep.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.deep.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.light.count integer

count
紀要
 sleep.levels.summary.light.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.light.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.rem.count integer

count
紀要
 sleep.levels.summary.rem.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.rem.thirtyDayAvgMinutes integer

三十天平均分鐘數
count
 sleep.levels.summary.wake.count integer

count
紀要
 sleep.levels.summary.wake.minutes integer

紀要
三十天平均分鐘數
 sleep.levels.summary.wake.thirtyDayAvgMinutes integer

三十天平均分鐘數
短數據
 sleep.levels.shortData array of object

短數據
日期時間
 sleep.levels.shortData.dateTime string

日期時間
水平儀
 sleep.levels.shortData.level string

水平儀
秒
 sleep.levels.shortData.seconds integer

秒
logId
 sleep.logId integer

睡眠日誌 ID。
分鐘喚醒後
 sleep.minutesAfterWakeup integer

使用者喚醒後的總分鐘數。
分鐘睡著了
 sleep.minutesAsleep integer

使用者睡眠的總分鐘數。
分鐘醒來
 sleep.minutesAwake integer

僅「喚醒」分鐘數的總和。 它不包括入睡前或醒來後。
分鐘到入睡
 sleep.minutesToFallAsleep integer

使用者入睡前的總分鐘數。 對於自動睡眠建立的睡眠記錄，此值通常為 0。
logType
 sleep.logType string

auto_detected |手工的
startTime
 sleep.startTime string

睡眠日誌開始的時間
時間在床上
 sleep.timeInBed integer

使用者在床上的總分鐘數
型別
 sleep.type string

經典 |階段

獲取個人資料

作業識別碼：
GetProfile

擷取使用者的設定檔資料。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 Description
關於我
 user.aboutMe string

使用者帳戶設定中指定的「關於我」資訊。
年齡
 user.age string

年齡是根據使用者帳戶設定中指定的生日。
大使
 user.ambassador string

大使
自動步幅啟用
 user.autoStrideEnabled string

自動步幅啟用
頭像
 user.avatar string

頭像
頭像150
 user.avatar150 string

頭像150
頭像640
 user.avatar640 string

頭像640
平均每日步數
 user.averageDailySteps string

為使用者計算的平均每日步數。
挑戰Beta
 user.challengesBeta string

挑戰Beta
clockTimeDisplay格式
 user.clockTimeDisplayFormat string

clockTimeDisplay格式
country
 user.country string

country
企業
 user.corporate string

企業
公司管理員
 user.corporateAdmin string

公司管理員
dateOfBirth
 user.dateOfBirth string

dateOfBirth
顯示名稱
 user.displayName string

顯示名稱
displayName設定
 user.displayNameSetting string

displayName設定
距離單位
 user.distanceUnit string

距離單位
編碼標識
 user.encodedId string

編碼標識
運動目標
 user.features.exerciseGoal string

運動目標
名字
 user.firstName string

名字
foods地區
 user.foodsLocale string

foods地區
全名
 user.fullName string

全名
性
 user.gender string

性
葡萄糖單位
 user.glucoseUnit string

葡萄糖單位
height
 user.height string

使用者帳戶設定中指定的高度值。
高度單位
 user.heightUnit string

高度單位
isBugReport已啟用
 user.isBugReportEnabled string

isBugReport已啟用
是孩子
 user.isChild string

是孩子
是教練
 user.isCoach string

是教練
語言地區設定
 user.languageLocale string

語言地區設定
lastName
 user.lastName string

lastName
legalTermsAcceptRequired（法律條款接受必填）
 user.legalTermsAcceptRequired string

legalTermsAcceptRequired（法律條款接受必填）
地區設定
 user.locale string

地區設定
成員自
 user.memberSince string

成員自
mfa已啟用
 user.mfaEnabled string

mfa已啟用
offsetFromUTC米利斯
 user.offsetFromUTCMillis string

offsetFromUTC米利斯
sdk開發人員
 user.sdkDeveloper string

sdk開發人員
睡眠追蹤
 user.sleepTracking string

睡眠追蹤
startDayOfWeek
 user.startDayOfWeek string

startDayOfWeek
狀態
 user.state string

狀態
strideLength跑步
 user.strideLengthRunning string

strideLength跑步
strideLengthRunning類型
 user.strideLengthRunningType string

strideLengthRunning類型
步幅長度步行
 user.strideLengthWalking string

步幅長度步行
strideLengthWalkingType
 user.strideLengthWalkingType string

strideLengthWalkingType
游泳單位
 user.swimUnit string

游泳單位
溫度單位
 user.temperatureUnit string

溫度單位
timezone
 user.timezone string

timezone
頂部徽章
 user.topBadges string

列出使用者目前獲得的 Fitbit 徽章的陣列。
水單位
 user.waterUnit string

水單位
水單位名稱
 user.waterUnitName string

水單位名稱
weight
 user.weight string

weight
重量單位
 user.weightUnit string

重量單位

獲取好友排行榜

作業識別碼：
GetFriendsLeaderboard

此端點會傳回使用者的好友排行榜

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 Description
資料
 data array of object

資料
型別
 data.type string

型別
識別碼
 data.id string

識別碼
階梯級
 data.attributes.step-rank integer

在用戶的好友中排名。
步驟摘要
 data.attributes.step-summary integer

每週步數。
型別
 data.relationships.user.data.type string

型別
識別碼
 data.relationships.user.data.id string

識別碼
包含
 included array of object

包含
型別
 included.type string

型別
識別碼
 included.id string

識別碼
頭像
 included.attributes.avatar string

鏈接到用戶的頭像圖片。
子系
 included.attributes.child boolean

子系
朋友
 included.attributes.friend boolean

朋友
名稱
 included.attributes.name string

名稱

獲取最喜歡的活動

作業識別碼：
GetFavoriteActivities

擷取使用者最愛活動的清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 Description
array of object
活動標識符
 activityId integer

記錄的活動識別碼。
描述
 description string

有關記錄活動的其他資訊。
大都會隊
 mets integer

所執行活動的代謝當量 （MET）。
名稱
 name string

記錄活動的名稱。

獲取每日活動摘要

作業識別碼：
GetDailyActivitySummary

擷取指定日期使用者活動和活動記錄專案的摘要和清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Date
 date True string

Date

傳回

名稱 路徑 類型 Description
activities
 activities array of

activities
活動分鐘數
 goals.activeMinutes integer

活動分鐘數
卡路里輸出
 goals.caloriesOut integer

卡路里輸出
distance
 goals.distance float

distance
樓層
 goals.floors integer

樓層
steps
 goals.steps integer

steps
活動分數
 summary.activeScore integer

活動分數
活動卡路里
 summary.activityCalories integer

活動卡路里
calorieEstimationMu
 summary.calorieEstimationMu integer

calorieEstimationMu
卡路里基礎代謝率
 summary.caloriesBMR integer

卡路里基礎代謝率
卡路里輸出
 summary.caloriesOut integer

卡路里輸出
caloriesOutUnestimated
 summary.caloriesOutUnestimated integer

caloriesOutUnestimated
自訂心率區域
 summary.customHeartRateZones array of object

自訂心率區域
卡路里輸出
 summary.customHeartRateZones.caloriesOut integer

卡路里輸出
max
 summary.customHeartRateZones.max integer

max
min
 summary.customHeartRateZones.min integer

min
紀要
 summary.customHeartRateZones.minutes integer

紀要
名稱
 summary.customHeartRateZones.name string

名稱
距離
 summary.distances array of object

距離
活動
 summary.distances.activity string

<活動名稱> | 總計 | 追蹤器 | 記錄活動 | veryActive | moderatelyActive | lightlyActive | sedentaryActive
distance
 summary.distances.distance integer

對於指定的資源，當天的行駛距離以 Accept-Language 標頭所定義的單位顯示。
提高權限
 summary.elevation integer

當天行進的高程以 Accept-Language 標頭定義的單位顯示。
公平活躍分鐘數
 summary.fairlyActiveMinutes integer

使用者相當/中等活躍的總分鐘數。
樓層
 summary.floors integer

當天攀升的等效樓層以 Accept-Language 標題定義的單位顯示。
心率區
 summary.heartRateZones array of object

心率區
卡路里輸出
 summary.heartRateZones.caloriesOut integer

卡路里輸出
max
 summary.heartRateZones.max integer

max
min
 summary.heartRateZones.min integer

min
紀要
 summary.heartRateZones.minutes integer

紀要
名稱
 summary.heartRateZones.name string

需要心率範圍才能看到此值。 超出範圍 |脂肪燃燒 |有氧運動 |山頂
輕度活躍分鐘數
 summary.lightlyActiveMinutes integer

使用者輕微活躍的總分鐘數。
邊際卡路里
 summary.marginalCalories integer

當天燃燒的總邊際估計卡路里。
休息心率
 summary.restingHeartRate integer

需要心率範圍才能看到此值。
久坐不動分鐘
 summary.sedentaryMinutes integer

用戶久坐不動的總分鐘數。
steps
 summary.steps integer

當天的總步數。
useEstimation
 summary.useEstimation boolean

布林值，說明是否在計算中使用估計值。
非常活躍的分鐘數
 summary.veryActiveMinutes integer

用戶非常活躍的總分鐘數。

獲取睡眠目標

作業識別碼：
GetSleepGoal

指定使用者的編碼 ID。 對目前登入的使用者使用「-」（破折號）。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 Description
flowId
 consistency.flowId integer

0 = 已設定睡眠目標，但沒有記錄足夠的睡眠日誌。 1 = 使用者未達到睡眠目標或未設定目標，但記錄了足夠的睡眠日誌。 2 = 未設定睡眠目標，且沒有記錄足夠的睡眠日誌。 3 = 用戶達到了他們的睡眠目標
分鐘持續時間
 goal.minDuration integer

睡眠目標時間的長度（以分鐘為單位）。
updatedOn
 goal.updatedOn string

建立/更新目標的時間戳記。

獲取終身統計數據

作業識別碼：
GetLifetimeStats

擷取使用者的活動統計資料。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 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
活動分數
 lifetime.total.activeScore integer

活動分數
卡路里輸出
 lifetime.total.caloriesOut integer

卡路里輸出
distance
 lifetime.total.distance float

distance
樓層
 lifetime.total.floors integer

樓層
steps
 lifetime.total.steps integer

steps
活動分數
 lifetime.tracker.activeScore integer

活動分數
卡路里輸出
 lifetime.tracker.caloriesOut integer

卡路里輸出
distance
 lifetime.tracker.distance float

distance
樓層
 lifetime.tracker.floors integer

樓層
steps
 lifetime.tracker.steps integer

steps

獲取設備

作業識別碼：
GetDevices

擷取與使用者帳戶配對的 Fitbit 裝置清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 Description
array of object
電池
 battery string

傳回裝置的電池電量
batteryLevel
 batteryLevel integer

傳回裝置的電池電量百分比。
裝置版本
 deviceVersion string

裝置的產品名稱。
features
 features array of

features
識別碼
 id string

裝置 ID。
lastSyncTime
 lastSyncTime string

時間戳記代表裝置上次與 Fitbit 行動應用程式同步的時間。
麥克
 mac string

Mac ID 號碼
型別
 type string

追蹤器 |秤

獲取警報

作業識別碼：
GetAlarms

擷取為特定裝置啟用的警示。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
追蹤器 ID
 tracker-id True string

傳回資料的追蹤器 ID。

傳回

名稱 路徑 類型 Description
追蹤器警報
 trackerAlarms array of object

追蹤器警報
警報標識符
 trackerAlarms.alarmId integer

代表警示 ID 的數值。
已刪除
 trackerAlarms.deleted boolean

指出警示是否已刪除。
enabled
 trackerAlarms.enabled boolean

指出是否已啟用警示。
重複性
 trackerAlarms.recurring boolean

指出警示是否重複發生。
貪睡計數
 trackerAlarms.snoozeCount integer

表示鬧鐘暫停的次數。
貪睡長度
 trackerAlarms.snoozeLength integer

指出暫停期間之間的時間（以分鐘為單位）。
syncedToDevice
 trackerAlarms.syncedToDevice boolean

真 |偽
time
 trackerAlarms.time string

指定警示的時間和 UTC 位移。
氛圍
 trackerAlarms.vibe string

傳回已設定的振動類型。
weekDays
 trackerAlarms.weekDays array of string

weekDays

獲取體脂日誌

作業識別碼：
GetBodyFattLog

擷取指定日期內所有使用者體脂記錄項目的清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Date
 date True string

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

傳回

名稱 路徑 類型 Description
胖
 fat array of object

胖
date
 fat.date string

記錄體脂日誌的日期。
胖
 fat.fat integer

體脂百分比。
logId
 fat.logId integer

體脂日誌 ID。
來源
 fat.source string

體脂資料的來源位置。
time
 fat.time string

記錄體脂記錄的時間戳記。

獲取體重日誌

作業識別碼：
GetWeightLog

擷取指定日期的所有使用者權重記錄項目清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
Date
 date True string

格式為 yyyy-mm-dd 的日期

傳回

名稱 路徑 類型 Description
weight
 weight array of object

weight
體重指數
 weight.bmi float

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

記錄格式為 yyyy-mm-dd的記錄日期。
胖
 weight.fat integer
logId
 weight.logId integer

權重記錄 ID 對使用者來說是唯一的，但不是全域唯一的。
來源
 weight.source string

來源
time
 weight.time string

測量時間;小時和分鐘，格式為 HH：mm：ss，如果未提供，則設為一天的最後一秒。
weight
 weight.weight integer

格式為 X.XX 的權重，在單位系統中，對應於提供的 Accept-Language 標頭，或者如果未在公制中提供。

獲得身體目標

作業識別碼：
GetBodyGoals

擷取使用者的體脂和體重目標。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID
目標類型
 goal-type True string

目標類型

傳回

名稱 路徑 類型 Description
目標類型
 goal.goalType string
startDate
 goal.startDate string

目標開始日期。
開始權重
 goal.startWeight float

設定目標時使用者的體重。
weight
 goal.weight float

要實現的體重目標。
權重臨界值
 goal.weightThreshold float

為實現和維持目標而每週減掉的建議體重。

獲得頻繁的活動

作業識別碼：
GetFrequentActivities

擷取使用者經常活動的清單。

參數

名稱 機碼 必要 類型 Description
使用者 ID
 user-id True string

使用者的編碼 ID

傳回

名稱 路徑 類型 Description
array of object
活動標識符
 activityId integer

記錄的活動識別碼。
卡路里
 calories integer

與活動相關的燃燒卡路里數量。
描述
 description string

有關記錄活動的其他資訊。
distance
 distance integer

與記錄的活動相關聯的行駛距離。
duration
 duration integer

編輯練習後的時間長度 （毫秒）。 此值將包含練習期間的暫停。
名稱
 name string

記錄活動的名稱。