Fitbit (独立した発行元) (プレビュー)
Fitbit Web API にアクセスする方法
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Ashwin Ganesh Kumar |
| URL | https://www.blisdigital.com/ |
| a.kumar@blisdigital.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Ashwin Ganesh Kumar |
| Website | https://dev.fitbit.com// |
| プライバシー ポリシー | https://www.fitbit.com/global/nl/legal/privacy-policy |
| カテゴリ | データ |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| VO2 Max Summary by Date を取得する |
1 つの日付のカーディオ フィットネス スコア (VO2 Max とも呼ばれます) データを返します。 VO2 実行データが使用できない場合は範囲として、ユーザーが実行に GPS を使用する場合は 1 つの数値として VO2 最大値が表示されます。 詳細なコンテキストについては、追加情報を参照してください。 |
| お気に入りのアクティビティを取得する |
ユーザーのお気に入りのアクティビティの一覧を取得します。 |
| すべてのアクティビティの種類を取得する |
Fitbit アクティビティ データベースから、有効なすべての Fitbit パブリック アクティビティと、ユーザーが作成したプライベート アクティビティの一覧を、要求された形式で取得します。 使用可能な場合は、アクティビティ レベルの詳細が表示されます。 |
| アクティビティ TCX の取得 |
トレーニング センター XML (TCX) は、GPS、心拍数、ラップ データを含むデータ交換形式です。 このエンドポイントは、記録された演習中に GPS と心拍数データを使用して、ユーザーの位置情報の詳細を取得します。 |
| アクティビティ ログの一覧を取得する |
特定の日の前後にユーザーのアクティビティ ログ エントリの一覧を取得します。 |
| アクティビティの時系列を日付で取得する |
日付と期間を指定して、特定のリソースのアクティビティ データを一定期間にわたって取得します。 応答には、日単位の集計値のみが含まれます。 |
| アクティビティの目標を取得する |
ユーザーの現在の毎日または毎週のアクティビティ目標を取得します。 |
| アクティビティの種類を取得する |
Fitbit アクティビティ データベースから、要求された形式で 1 つのアクティビティの詳細を取得します。 使用可能な場合は、アクティビティ レベルの詳細が表示されます。 |
| アラームを取得する |
特定のデバイスで有効になっているアラームを取得します。 |
| スリープ ログの一覧を取得する |
特定の日付の前または後のユーザーのスリープ ログ エントリの一覧を返します。 |
| デバイスの取得 |
ユーザーのアカウントとペアリングされている Fitbit デバイスの一覧を取得します。 |
| バッジを取得する |
ユーザーのバッジの一覧を取得します。 |
| フレンド ランキングを取得する |
このエンドポイントは、ユーザーのフレンド ランキングを返します |
| プロフィールを取得 |
ユーザーのプロファイル データを取得します。 |
| 体の目標を取得する |
ユーザーの体脂肪と体重の目標を取得します。 |
| 体脂肪ログを取得する |
特定の日付のすべてのユーザーの体脂肪ログ エントリの一覧を取得します。 |
| 日付でスリープ ログを取得する |
特定の日付のユーザーのスリープ ログ エントリの一覧を返します。 |
| 日付で本文の時系列を取得する |
特定の期間のすべてのユーザーの bmi、体脂肪、または体重の一覧を取得します。 |
| 日付で重みの時系列を取得する |
特定の期間のすべてのユーザーの重みログ エントリの一覧を取得します。 |
| 日付別に体脂肪時系列を取得する |
特定の期間のすべてのユーザーの体脂肪ログ エントリの一覧を取得します。 |
| 日付別の HRV の概要を取得する |
このエンドポイントは、1 つの日付の心拍数変動 (HRV) データを返します |
| 日付別呼吸率の概要を取得する |
このエンドポイントは、1 つの日付の平均呼吸数データを返します。 呼吸率データは、特定の日付に眠っていた最も長い単一期間であるユーザーの "メイン スリープ" に特に適用されます。 |
| 日付範囲でスリープ ログを取得する |
日付範囲のユーザーのスリープ ログ エントリの一覧を返します。 |
| 最近のアクティビティの種類を取得する |
ログに記録されたユーザーの最近のアクティビティの種類の一覧と、その種類の最後のアクティビティ ログの詳細を取得します。 |
| 有効期間統計を取得する |
ユーザーのアクティビティ統計を取得します。 |
| 毎日のアクティビティの概要を取得する |
特定の日のユーザーのアクティビティとアクティビティ ログ エントリの概要と一覧を取得します。 |
| 睡眠の目標を取得する |
ユーザーのエンコードされた ID を指定します。 現在ログインしているユーザーには "-" (ダッシュ) を使用します。 |
| 重みログを取得する |
特定の日付のすべてのユーザーの重みログ エントリの一覧を取得します。 |
| 頻繁なアクティビティを取得する |
ユーザーの頻繁なアクティビティの一覧を取得します。 |
VO2 Max Summary by Date を取得する
1 つの日付のカーディオ フィットネス スコア (VO2 Max とも呼ばれます) データを返します。 VO2 実行データが使用できない場合は範囲として、ユーザーが実行に GPS を使用する場合は 1 つの数値として VO2 最大値が表示されます。 詳細なコンテキストについては、追加情報を参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
|
日付
|
date | True | string |
yyyy-mm-dd または今日の形式の日付。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カーディオスコア
|
cardioScore | array of object |
カーディオスコア |
|
日時
|
cardioScore.dateTime | string |
YYYY-MM-DD 形式で指定された日付。 |
|
vo2Max
|
cardioScore.value.vo2Max | string |
表示可能な VO2 最大値 (mL/kg/分) |
お気に入りのアクティビティを取得する
ユーザーのお気に入りのアクティビティの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
記録されたアクティビティの識別子番号。 |
|
説明
|
description | string |
記録されたアクティビティに関する追加情報。 |
|
メッツ
|
mets | integer |
実行されたアクティビティの代謝量 (MET)。 |
|
名前
|
name | string |
記録されたアクティビティの名前。 |
すべてのアクティビティの種類を取得する
Fitbit アクティビティ データベースから、有効なすべての Fitbit パブリック アクティビティと、ユーザーが作成したプライベート アクティビティの一覧を、要求された形式で取得します。 使用可能な場合は、アクティビティ レベルの詳細が表示されます。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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 |
|
メッツ
|
categories.activities.activityLevels.mets | integer |
メッツ |
|
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 |
名前 |
|
メッツ
|
categories.activities.mets | float |
メッツ |
アクティビティ TCX の取得
トレーニング センター XML (TCX) は、GPS、心拍数、ラップ データを含むデータ交換形式です。 このエンドポイントは、記録された演習中に GPS と心拍数データを使用して、ユーザーの位置情報の詳細を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
使用のエンコードされた ID |
|
ログ ID
|
log-id | True | string |
アクティビティのログ ID。 |
|
部分 TCX
|
includePartialTCX | boolean |
GPS データが利用できない場合の TCX ポイントが含まれます。 |
アクティビティ ログの一覧を取得する
特定の日の前後にユーザーのアクティビティ ログ エントリの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー 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 |
|
minutes
|
activities.activityLevel.minutes | integer |
minutes |
|
名前
|
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 |
演習中に得られた昇格。 |
|
最終更新
|
activities.lastModified | string |
演習が最後に変更されたタイムスタンプ。 |
|
logId
|
activities.logId | integer |
演習のアクティビティ ログ識別子。 |
|
ログタイプ
|
activities.logType | string |
auto_detected |manual |mobile_run |tracker |サード パーティ製アプリケーションの名前 |
|
カロリー
|
activities.manualValuesSpecified.calories | boolean |
運動の記録時にカロリーが提供されたかどうかを示すブール値。 |
|
distance
|
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
|
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 |
|
日時
|
activities-steps.dateTime | string |
日時 |
|
value
|
activities-steps.value | string |
value |
アクティビティの目標を取得する
ユーザーの現在の毎日または毎週のアクティビティ目標を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
|
ピリオド
|
period | True | string |
daily|ウィークリー |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
activeMinutes
|
goals.activeMinutes | integer |
毎日のアクティブな分の目標。 週単位の目標の値は返されません。 |
|
activeZoneMinutes
|
goals.activeZoneMinutes | integer |
日単位または週単位のアクティブ ゾーン分の目標。 |
|
caloriesOut
|
goals.caloriesOut | integer |
毎日のカロリーが目標を燃やしました。 週単位の目標の値は返されません。 |
|
distance
|
goals.distance | float |
毎日または毎週の距離目標。 |
|
床
|
goals.floors | integer |
毎日または毎週のフロアが目標に登りました。 |
|
steps
|
goals.steps | integer |
毎日または毎週のステップが目標を達成しました。 |
アクティビティの種類を取得する
Fitbit アクティビティ データベースから、要求された形式で 1 つのアクティビティの詳細を取得します。 使用可能な場合は、アクティビティ レベルの詳細が表示されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
|
アクティビティ ID
|
activity-id | True | string |
アクティビティ ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
accessLevel (アクセスレベル)
|
activity.accessLevel | string |
PUBLIC |プライベート |
|
activityLevels
|
activity.activityLevels | array of object |
activityLevels |
|
id
|
activity.activityLevels.id | integer |
対応するアクティビティ レベルを表す数値。 |
|
maxSpeedMPH
|
activity.activityLevels.maxSpeedMPH | float |
MPH の最大速度。 値: -1 は適用されないことを意味します。 |
|
メッツ
|
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
|
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 オフセット。 |
|
vibe
|
trackerAlarms.vibe | string |
構成された振動の種類を返します。 |
|
weekDays
|
trackerAlarms.weekDays | array of string |
weekDays |
スリープ ログの一覧を取得する
特定の日付の前または後のユーザーのスリープ ログ エントリの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー 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 |
データ |
|
日時
|
sleep.levels.data.dateTime | string |
日時 |
|
レベル
|
sleep.levels.data.level | string |
レベル |
|
秒
|
sleep.levels.data.seconds | integer |
秒 |
|
shortData
|
sleep.levels.shortData | array of object |
shortData |
|
日時
|
sleep.levels.shortData.dateTime | string |
日時 |
|
レベル
|
sleep.levels.shortData.level | string |
レベル |
|
秒
|
sleep.levels.shortData.seconds | integer |
秒 |
|
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 |
|
ログタイプ
|
sleep.logType | string |
ログタイプ |
|
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 |
型 |
デバイスの取得
ユーザーのアカウントとペアリングされている Fitbit デバイスの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
battery
|
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 |
トラッカー |規模 |
バッジを取得する
ユーザーのバッジの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー 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 |
乾杯 |
|
日時
|
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
|
user-id | True | string |
ユーザーのエンコードされた ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object |
データ |
|
型
|
data.type | string |
型 |
|
id
|
data.id | string |
id |
|
step-rank
|
data.attributes.step-rank | integer |
ユーザーのフレンド間のランキング。 |
|
step-summary
|
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
|
user-id | True | string |
ユーザーのエンコードされた ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
aboutMe
|
user.aboutMe | string |
ユーザーのアカウント設定で指定された "自分について" 情報。 |
|
年齢
|
user.age | string |
ユーザーのアカウント設定で指定した誕生日に基づく年齢。 |
|
大使
|
user.ambassador | string |
大使 |
|
autoStrideEnabled
|
user.autoStrideEnabled | string |
autoStrideEnabled |
|
アバター
|
user.avatar | string |
アバター |
|
avatar150
|
user.avatar150 | string |
avatar150 |
|
avatar640
|
user.avatar640 | string |
avatar640 |
|
averageDailySteps
|
user.averageDailySteps | string |
ユーザーに対して計算された 1 日の平均ステップ数。 |
|
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 |
|
ディスプレイ名
|
user.displayName | string |
ディスプレイ名 |
|
displayNameSetting
|
user.displayNameSetting | string |
displayNameSetting |
|
distanceUnit
|
user.distanceUnit | string |
distanceUnit |
|
encodedId
|
user.encodedId | string |
encodedId |
|
exerciseGoal
|
user.features.exerciseGoal | string |
exerciseGoal |
|
ファーストネーム
|
user.firstName | string |
ファーストネーム |
|
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 |
|
苗字
|
user.lastName | string |
苗字 |
|
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
|
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
|
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
|
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 |
データ |
|
日時
|
sleep.levels.data.dateTime | string |
日時 |
|
レベル
|
sleep.levels.data.level | string |
レベル |
|
秒
|
sleep.levels.data.seconds | integer |
秒 |
|
shortData
|
sleep.levels.shortData | array of object |
shortData |
|
日時
|
sleep.levels.shortData.dateTime | string |
日時 |
|
レベル
|
sleep.levels.shortData.level | string |
レベル |
|
秒
|
sleep.levels.shortData.seconds | integer |
秒 |
|
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 |
スリープ ログ ID。 |
|
minutesAfterWakeup
|
sleep.minutesAfterWakeup | integer |
ユーザーが目を覚ました後の合計分数。 |
|
minutesAsleep
|
sleep.minutesAsleep | integer |
ユーザーがスリープ状態だった合計時間 (分)。 |
|
minutesAwake
|
sleep.minutesAwake | integer |
"ウェイク" 分の合計のみ。 眠りに落ちる前や目を覚ます後は含まれません。 |
|
minutesToFallAsleep
|
sleep.minutesToFallAsleep | integer |
ユーザーがスリープ状態になるまでの合計時間 (分)。 この値は、通常、自動スリープで作成されたスリープ ログの場合は 0 です。 |
|
ログタイプ
|
sleep.logType | string |
auto_detected |手動 |
|
startTime
|
sleep.startTime | string |
スリープ ログの開始時間。 |
|
timeInBed
|
sleep.timeInBed | integer |
ユーザーがベッドにいた合計分数。 |
|
型
|
sleep.type | string |
classic |段階 |
|
深い
|
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 |
ユーザーがスリープ ログ内のすべてのレコードをベッドに入れていた合計時間 (分)。 |
日付で本文の時系列を取得する
特定の期間のすべてのユーザーの 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 |
|
日時
|
body-weight.dateTime | string |
日時 |
|
value
|
body-weight.value | string |
value |
日付で重みの時系列を取得する
特定の期間のすべてのユーザーの重みログ エントリの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー 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 |
yyyy-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
|
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 |
体脂肪ログが記録されたときのタイムスタンプ。 |
日付別の HRV の概要を取得する
このエンドポイントは、1 つの日付の心拍数変動 (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) の根平均二乗。 ユーザーの毎日の心拍数の短期的な変動をミリ秒単位 (ミリ秒) で測定します。 |
|
deepRmssd
|
hrv.value.deepRmssd | float |
ハート ビート間の連続する差 (RMSSD) の根平均二乗。 深い睡眠中のユーザーの心拍数の短期的な変動をミリ秒単位 (ミリ秒) で測定します。 |
|
日時
|
hrv.dateTime | string |
YYYY-MM-DD 形式で指定されたスリープ ログの日付。 |
日付別呼吸率の概要を取得する
このエンドポイントは、1 つの日付の平均呼吸数データを返します。 呼吸率データは、特定の日付に眠っていた最も長い単一期間であるユーザーの "メイン スリープ" に特に適用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
|
日付
|
date | True | string |
yyyy-mm-dd または今日の形式の日付。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
br
|
br | array of object |
br |
|
breathingRate
|
br.value.breathingRate | float |
1 分あたりの平均呼吸数。 |
|
日時
|
br.dateTime | string |
YYYY-MM-DD 形式で指定されたスリープ ログの日付。 |
日付範囲でスリープ ログを取得する
日付範囲のユーザーのスリープ ログ エントリの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー 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 |
データ |
|
日時
|
sleep.levels.data.dateTime | string |
日時 |
|
レベル
|
sleep.levels.data.level | string |
レベル |
|
秒
|
sleep.levels.data.seconds | integer |
秒 |
|
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 |
|
日時
|
sleep.levels.shortData.dateTime | string |
日時 |
|
レベル
|
sleep.levels.shortData.level | string |
レベル |
|
秒
|
sleep.levels.shortData.seconds | integer |
秒 |
|
logId
|
sleep.logId | integer |
スリープ ログ ID。 |
|
minutesAfterWakeup
|
sleep.minutesAfterWakeup | integer |
ユーザーが目を覚ました後の合計分数。 |
|
minutesAsleep
|
sleep.minutesAsleep | integer |
ユーザーがスリープ状態だった合計時間 (分)。 |
|
minutesAwake
|
sleep.minutesAwake | integer |
"ウェイク" 分の合計のみ。 眠りに落ちる前や目を覚ます後は含まれません。 |
|
minutesToFallAsleep
|
sleep.minutesToFallAsleep | integer |
ユーザーがスリープ状態になるまでの合計時間 (分)。 この値は、通常、自動スリープで作成されたスリープ ログの場合は 0 です。 |
|
ログタイプ
|
sleep.logType | string |
auto_detected |手動 |
|
startTime
|
sleep.startTime | string |
スリープ ログの開始時間 |
|
timeInBed
|
sleep.timeInBed | integer |
ユーザーがベッドにいた合計時間 (分) |
|
型
|
sleep.type | string |
classic |段階 |
最近のアクティビティの種類を取得する
ログに記録されたユーザーの最近のアクティビティの種類の一覧と、その種類の最後のアクティビティ ログの詳細を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
アクティビティまたは演習の数値 ID。 |
|
カロリー
|
calories | integer |
記録された活動中に消費されたカロリーの数。 |
|
説明
|
description | string |
アクティビティまたは演習に関する情報 (使用可能な場合)。 |
|
distance
|
distance | integer |
記録されたアクティビティ中に移動した距離。 |
|
duration
|
duration | integer |
記録されたアクティビティを完了する時間 (ミリ秒)。 |
|
名前
|
name | string |
アクティビティまたは演習の名前。 |
有効期間統計を取得する
ユーザーのアクティビティ統計を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー 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 |
|
distance
|
lifetime.total.distance | float |
distance |
|
床
|
lifetime.total.floors | integer |
床 |
|
steps
|
lifetime.total.steps | integer |
steps |
|
activeScore
|
lifetime.tracker.activeScore | integer |
activeScore |
|
caloriesOut
|
lifetime.tracker.caloriesOut | integer |
caloriesOut |
|
distance
|
lifetime.tracker.distance | float |
distance |
|
床
|
lifetime.tracker.floors | integer |
床 |
|
steps
|
lifetime.tracker.steps | integer |
steps |
毎日のアクティビティの概要を取得する
特定の日のユーザーのアクティビティとアクティビティ ログ エントリの概要と一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
|
日付
|
date | True | string |
日付 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
activities
|
activities | array of |
activities |
|
activeMinutes
|
goals.activeMinutes | integer |
activeMinutes |
|
caloriesOut
|
goals.caloriesOut | integer |
caloriesOut |
|
distance
|
goals.distance | float |
distance |
|
床
|
goals.floors | integer |
床 |
|
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 |
|
名前
|
summary.customHeartRateZones.name | string |
名前 |
|
距離
|
summary.distances | array of object |
距離 |
|
アクティビティ
|
summary.distances.activity | string |
<アクティビティ名> | total | tracker | loggedActivities | veryActive | moderatelyActive | lightlyActive | sedentaryActive |
|
distance
|
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 |
|
max
|
summary.heartRateZones.max | integer |
max |
|
min
|
summary.heartRateZones.min | integer |
min |
|
minutes
|
summary.heartRateZones.minutes | integer |
minutes |
|
名前
|
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 |
ユーザーが非常にアクティブだった合計時間 (分)。 |
睡眠の目標を取得する
ユーザーのエンコードされた ID を指定します。 現在ログインしているユーザーには "-" (ダッシュ) を使用します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user-id | True | string |
ユーザーのエンコードされた ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
flowId
|
consistency.flowId | integer |
0 = スリープの目標が設定されていますが、十分なスリープ ログが記録されていません。 1 = ユーザーがスリープの目標を見逃したか、目標が設定されていませんが、十分なスリープ ログが記録されています。 2 = スリープ目標が設定されておらず、十分なスリープ ログが記録されていません。 3 = ユーザーが睡眠の目標を達成した |
|
minDuration
|
goal.minDuration | integer |
睡眠目標期間の長さ (分単位)。 |
|
updatedOn
|
goal.updatedOn | string |
目標が作成/更新されたタイムスタンプ。 |
重みログを取得する
特定の日付のすべてのユーザーの重みログ エントリの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー 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 |
yyyy-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
|
user-id | True | string |
ユーザーのエンコードされた ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
記録されたアクティビティの識別子番号。 |
|
カロリー
|
calories | integer |
アクティビティに関連付けられている消費カロリーの数。 |
|
説明
|
description | string |
記録されたアクティビティに関する追加情報。 |
|
distance
|
distance | integer |
記録されたアクティビティに関連付けられた移動距離。 |
|
duration
|
duration | integer |
演習の編集後の時間 (ミリ秒)。 この値には、演習中の一時停止が含まれます。 |
|
名前
|
name | string |
記録されたアクティビティの名前。 |