Fitbit (Unabhängiger Herausgeber) (Vorschau)
Eine Möglichkeit für den Zugriff auf die Fitbit-Web-API
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Ashwin Ganesh Kumar |
| URL | https://www.blisdigital.com/ |
| a.kumar@blisdigital.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Ashwin Ganesh Kumar |
| Webseite | https://dev.fitbit.com// |
| Datenschutzrichtlinie | https://www.fitbit.com/global/nl/legal/privacy-policy |
| Kategorien | Daten |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen aller Aktivitätstypen |
Ruft eine Liste aller gültigen öffentlichen Fitbit-Aktivitäten und der privaten, vom Benutzer erstellten Aktivitäten aus der Fitbit-Aktivitätsdatenbank im angeforderten Format ab. Wenn verfügbar, werden Details auf Aktivitätsebene angezeigt. |
| Abrufen der Textzeitreihe nach Datum |
Ruft eine Liste aller Bmi-, Körperfett- oder Gewichtsarten des Benutzers für einen bestimmten Zeitraum ab. |
| Abrufen von Aktivitätszielen |
Ruft die aktuellen täglichen oder wöchentlichen Aktivitätsziele eines Benutzers ab. |
| Abrufen von Geräten |
Ruft eine Liste der Fitbit-Geräte ab, die mit dem Konto eines Benutzers gekoppelt sind. |
| Abrufen von Lebensdauerstatistiken |
Ruft die Aktivitätsstatistiken des Benutzers ab. |
| Abrufen zuletzt verwendeter Aktivitätstypen |
Ruft eine Liste der zuletzt verwendeten Aktivitätstypen eines Benutzers ab, die mit einigen Details des letzten Aktivitätsprotokolls dieses Typs protokolliert wurden. |
| Aktivitätsprotokollliste abrufen |
Ruft eine Liste der Aktivitätsprotokolleinträge eines Benutzers vor oder nach einem bestimmten Tag ab. |
| Aktivitätstyp abrufen |
Ruft die Details für eine einzelne Aktivität aus der Fitbit-Aktivitätsdatenbank im angeforderten Format ab. Wenn verfügbar, werden Details auf Aktivitätsebene angezeigt. |
| Aktivitätszeitreihe nach Datum abrufen |
Ruft die Aktivitätsdaten für eine bestimmte Ressource über einen Bestimmten Zeitraum ab, indem ein Datum und ein Zeitraum angegeben werden. Die Antwort enthält nur die täglichen Zusammenfassungswerte. |
| Alarme abrufen |
Ruft die Für ein bestimmtes Gerät aktivierten Alarme ab. |
| Badges abrufen |
Ruft eine Liste der Badges des Benutzers ab. |
| Body Fat Time Series nach Datum abrufen |
Ruft eine Liste aller Fettprotokolleinträge des Benutzers für einen bestimmten Zeitraum ab. |
| Favoritenaktivitäten abrufen |
Ruft eine Liste der bevorzugten Aktivitäten eines Benutzers ab. |
| Freundes-Bestenliste abrufen |
Dieser Endpunkt gibt das Freund-Leaderboard des Benutzers zurück. |
| Get Activity TCX |
Das Training Center XML (TCX) ist ein Datenaustauschformat, das GPS-, Herzfrequenz- und Rundendaten enthält. Dieser Endpunkt ruft die Details des Standorts eines Benutzers mithilfe von GPS- und Herzfrequenzdaten während einer protokollierten Übung ab. |
| Gewichtungsprotokoll abrufen |
Ruft eine Liste aller Gewichtungsprotokolleinträge des Benutzers für ein bestimmtes Datum ab. |
| Gewichtungszeitreihe nach Datum abrufen |
Ruft eine Liste aller Gewichtungsprotokolleinträge des Benutzers für einen bestimmten Zeitraum ab. |
| HRV-Zusammenfassung nach Datum abrufen |
Dieser Endpunkt gibt die HrV-Daten (Heart Rate Variability) für ein einzelnes Datum zurück. |
| Häufige Aktivitäten abrufen |
Ruft eine Liste der häufigen Aktivitäten eines Benutzers ab. |
| Körperfettprotokoll abrufen |
Ruft eine Liste aller Fettprotokolleinträge des Benutzers für ein bestimmtes Datum ab. |
| Körperziele abrufen |
Ruft die Körperfett- und Gewichtsziele eines Benutzers ab. |
| Liste der Ruhezustandsprotokolle abrufen |
Gibt eine Liste der Ruhezustandsprotokolleinträge eines Benutzers vor oder nach einem bestimmten Datum zurück. |
| Profil abrufen |
Ruft die Profildaten des Benutzers ab. |
| Ruhezustandsprotokoll nach Datum abrufen |
Gibt eine Liste der Ruhezustandsprotokolleinträge eines Benutzers für ein bestimmtes Datum zurück. |
| Ruhezustandsprotokoll nach Datumsbereich abrufen |
Gibt eine Liste der Ruhezustandsprotokolleinträge eines Benutzers für einen Datumsbereich zurück. |
| Schlafziel abrufen |
Geben Sie die codierte ID des Benutzers an. Verwenden Sie "-" (Gedankenstrich) für den aktuellen angemeldeten Benutzer. |
| Tägliche Aktivitätszusammenfassung abrufen |
Ruft eine Zusammenfassung und Liste der Aktivitäten und Aktivitätsprotokolleinträge eines Benutzers für einen bestimmten Tag ab. |
| Vo2 Max. Zusammenfassung nach Datum abrufen |
Gibt die Cardio Fitness Score -Daten (auch als VO2 Max bezeichnet) für ein einzelnes Datum zurück. VO2 Max-Werte werden als Bereich angezeigt, wenn keine Ausführungsdaten verfügbar sind oder ein einzelner numerischer Wert, wenn der Benutzer ein GPS für Die Ausführung verwendet. Weitere Informationen finden Sie unter "Weitere Informationen". |
| Zusammenfassung der Atemrate nach Datum abrufen |
Dieser Endpunkt gibt durchschnittliche Atemfrequenzdaten für ein einzelnes Datum zurück. Die Atemfrequenzdaten gelten speziell für den "Hauptschlaf" eines Benutzers, der die längste Zeit ist, in der sie an einem bestimmten Datum eingeschlafen waren. |
Abrufen aller Aktivitätstypen
Ruft eine Liste aller gültigen öffentlichen Fitbit-Aktivitäten und der privaten, vom Benutzer erstellten Aktivitäten aus der Fitbit-Aktivitätsdatenbank im angeforderten Format ab. Wenn verfügbar, werden Details auf Aktivitätsebene angezeigt.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
categories
|
categories | array of object |
categories |
|
activities
|
categories.activities | array of object |
activities |
|
Zugriffsebene
|
categories.activities.accessLevel | string |
Zugriffsebene |
|
activityLevels
|
categories.activities.activityLevels | array of object |
activityLevels |
|
id
|
categories.activities.activityLevels.id | integer |
id |
|
maxSpeedMPH
|
categories.activities.activityLevels.maxSpeedMPH | integer |
maxSpeedMPH |
|
Mets
|
categories.activities.activityLevels.mets | integer |
Mets |
|
minSpeedMPH
|
categories.activities.activityLevels.minSpeedMPH | integer |
minSpeedMPH |
|
name
|
categories.activities.activityLevels.name | string |
name |
|
hasSpeed
|
categories.activities.hasSpeed | boolean |
hasSpeed |
|
id
|
categories.activities.id | integer |
id |
|
name
|
categories.activities.name | string |
name |
|
Mets
|
categories.activities.mets | float |
Mets |
Abrufen der Textzeitreihe nach Datum
Ruft eine Liste aller Bmi-, Körperfett- oder Gewichtsarten des Benutzers für einen bestimmten Zeitraum ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Resource
|
resource | True | string |
Die zurückzugebende Textressource. |
|
Datum
|
date | True | string |
Das Enddatum des im Format jjjj-mm-dd oder heute angegebenen Zeitraums. |
|
Zeitraum
|
period | True | string |
Der Bereich, für den Daten zurückgegeben werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Körpergewicht
|
body-weight | array of object |
Körpergewicht |
|
Datum und Uhrzeit
|
body-weight.dateTime | string |
Datum und Uhrzeit |
|
value
|
body-weight.value | string |
value |
Abrufen von Aktivitätszielen
Ruft die aktuellen täglichen oder wöchentlichen Aktivitätsziele eines Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Zeitraum
|
period | True | string |
täglich| wöchentlich |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
activeMinutes
|
goals.activeMinutes | integer |
Tägliches Ziel der aktiven Minuten. Für wöchentliche Ziele wird kein Wert zurückgegeben. |
|
activeZoneMinutes
|
goals.activeZoneMinutes | integer |
Ziel der täglichen oder wöchentlichen aktiven Zone. |
|
kalorienaus
|
goals.caloriesOut | integer |
Tägliche Kalorien verbrannt Ziel. Für wöchentliche Ziele wird kein Wert zurückgegeben. |
|
distance
|
goals.distance | float |
Tages- oder Wochenabstandsziel. |
|
Etagen
|
goals.floors | integer |
Tages- oder Wöchentliche Stockwerke kletterten zum Ziel. |
|
steps
|
goals.steps | integer |
Tägliche oder wöchentliche Schritte, die Ziel ausgeführt wurden. |
Abrufen von Geräten
Ruft eine Liste der Fitbit-Geräte ab, die mit dem Konto eines Benutzers gekoppelt sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
battery
|
battery | string |
Gibt den Akkustand des Geräts zurück. |
|
batteryLevel
|
batteryLevel | integer |
Gibt den Prozentsatz des Akkustands des Geräts zurück. |
|
deviceVersion
|
deviceVersion | string |
Der Produktname des Geräts. |
|
features
|
features | array of |
features |
|
id
|
id | string |
Die Geräte-ID. |
|
lastSyncTime
|
lastSyncTime | string |
Zeitstempel, der die letzte Synchronisierung des Geräts mit der mobilen Fitbit-Anwendung darstellt. |
|
mac
|
mac | string |
Mac-ID-Nummer |
|
type
|
type | string |
TRACKER | MAßSTAB |
Abrufen von Lebensdauerstatistiken
Ruft die Aktivitätsstatistiken des Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
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 |
|
kalorienaus
|
lifetime.total.caloriesOut | integer |
kalorienaus |
|
distance
|
lifetime.total.distance | float |
distance |
|
Etagen
|
lifetime.total.floors | integer |
Etagen |
|
steps
|
lifetime.total.steps | integer |
steps |
|
activeScore
|
lifetime.tracker.activeScore | integer |
activeScore |
|
kalorienaus
|
lifetime.tracker.caloriesOut | integer |
kalorienaus |
|
distance
|
lifetime.tracker.distance | float |
distance |
|
Etagen
|
lifetime.tracker.floors | integer |
Etagen |
|
steps
|
lifetime.tracker.steps | integer |
steps |
Abrufen zuletzt verwendeter Aktivitätstypen
Ruft eine Liste der zuletzt verwendeten Aktivitätstypen eines Benutzers ab, die mit einigen Details des letzten Aktivitätsprotokolls dieses Typs protokolliert wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
Die numerische ID für die Aktivität oder Übung. |
|
Kalorien
|
calories | integer |
Die Anzahl der Kalorien, die während der aufgezeichneten Aktivität verbrannt wurden. |
|
Beschreibung
|
description | string |
Informationen, falls verfügbar, über die Aktivität oder Übung. |
|
distance
|
distance | integer |
Die Während der aufgezeichneten Aktivität zurückgelegte Entfernung. |
|
duration
|
duration | integer |
Zeitraum (Millisekunden), um die aufgezeichnete Aktivität abzuschließen. |
|
name
|
name | string |
Der Name der Aktivität oder Übung. |
Aktivitätsprotokollliste abrufen
Ruft eine Liste der Aktivitätsprotokolleinträge eines Benutzers vor oder nach einem bestimmten Tag ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Nach Datum
|
afterDate | string |
Das Nachdatum (jjjj-mm-dd) |
|
|
Vor Dem Datum
|
beforeDate | string |
Das Vordatum (jjjj-mm-dd) |
|
|
Sortieren
|
sort | string |
Die Sortierreihenfolge von Einträgen nach Datum. |
|
|
Limit
|
limit | integer |
Die Anzahl der zurückgegebenen Einträge. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
activities
|
activities | array of object |
activities |
|
activeDuration
|
activities.activeDuration | integer |
Die Zeitspanne (Millisekunden) innerhalb der einzelnen ActivityLevels. |
|
activityLevel
|
activities.activityLevel | array of object |
activityLevel |
|
minutes
|
activities.activityLevel.minutes | integer |
minutes |
|
name
|
activities.activityLevel.name | string |
name |
|
activityName
|
activities.activityName | string |
Name der aufgezeichneten Übung. |
|
activityTypeId
|
activities.activityTypeId | integer |
Die ID-Nummer des Aktivitätsnames. |
|
Kalorien
|
activities.calories | integer |
Die Anzahl der Kalorien, die während der Übung verbrannt wurden. |
|
kalorienlink
|
activities.caloriesLink | string |
Web-API-Endpunkt, um aufzurufen, um die spezifischen Kalorien für die benannte Übung zu verbrennen. |
|
duration
|
activities.duration | integer |
Die Zeitdauer (Millisekunden) nach der Bearbeitung der Übung. Wenn die Übung nicht bearbeitet wurde, wird die Dauer = originalDuration. Dieser Wert enthält Pausen während der Übung. |
|
elevationGain
|
activities.elevationGain | float |
Während der Übung gewonnene Erhöhung. |
|
zuletzt geändert
|
activities.lastModified | string |
Der Zeitstempel der Übung wurde zuletzt geändert. |
|
logId
|
activities.logId | integer |
Der Aktivitätsprotokollbezeichner für die Übung. |
|
logTyp
|
activities.logType | string |
auto_detected | manual | mobile_run | Tracker | der Name der Drittanbieteranwendung |
|
Kalorien
|
activities.manualValuesSpecified.calories | boolean |
Ein boolescher Wert, der angibt, ob Kalorien beim Aufzeichnen der Übung bereitgestellt wurden. |
|
distance
|
activities.manualValuesSpecified.distance | boolean |
Ein boolescher Wert, der angibt, ob beim Aufzeichnen der Übung Entfernung angegeben wurde. |
|
steps
|
activities.manualValuesSpecified.steps | boolean |
Ein boolescher Wert, der angibt, ob beim Aufzeichnen der Übung Schritte bereitgestellt wurden. |
|
originalDuration
|
activities.originalDuration | integer |
Die anfängliche Zeitdauer (Millisekunden), die die Übung aufgezeichnet hat. Dieser Wert enthält Pausen während der Übung. |
|
originalStartTime
|
activities.originalStartTime | string |
Der anfängliche Anfangstermin, zu dem die Übung aufgezeichnet wurde. |
|
startTime
|
activities.startTime | string |
Das Startdatum nach der Bearbeitung der Übung. Wenn die Übung nicht bearbeitet wurde, ist startTime = originalStartTime. |
|
steps
|
activities.steps | integer |
Die Anzahl der während der Übung ausgeführten Schritte. |
|
tcxLink
|
activities.tcxLink | string |
URL zum Herunterladen der TCX-Datei. |
|
afterDate
|
pagination.afterDate | string |
afterDate |
|
Grenze
|
pagination.limit | integer |
Grenze |
|
nächster
|
pagination.next | string |
nächster |
|
offset
|
pagination.offset | integer |
offset |
|
vorhergehend
|
pagination.previous | string |
vorhergehend |
|
sort
|
pagination.sort | string |
sort |
Aktivitätstyp abrufen
Ruft die Details für eine einzelne Aktivität aus der Fitbit-Aktivitätsdatenbank im angeforderten Format ab. Wenn verfügbar, werden Details auf Aktivitätsebene angezeigt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Aktivitäts-ID
|
activity-id | True | string |
Aktivitäts-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zugriffsebene
|
activity.accessLevel | string |
ÖFFENTLICH | PRIVAT |
|
activityLevels
|
activity.activityLevels | array of object |
activityLevels |
|
id
|
activity.activityLevels.id | integer |
Numerischer Wert, der die entsprechende Aktivitätsebene darstellt. |
|
maxSpeedMPH
|
activity.activityLevels.maxSpeedMPH | float |
Maximale Geschwindigkeit in MPH. Wert: -1 bedeutet nicht anwendbar. |
|
Mets
|
activity.activityLevels.mets | integer |
METs-Bewertung für die Aktivitäts-ID. |
|
minSpeedMPH
|
activity.activityLevels.minSpeedMPH | integer |
Minimale Geschwindigkeit in MPH. Wert: -1 bedeutet nicht anwendbar. |
|
name
|
activity.activityLevels.name | string |
Name der Aktivitätsebene. |
|
hasSpeed
|
activity.hasSpeed | boolean |
true | FALSCH |
|
id
|
activity.id | integer |
Numerischer Wert, der die entsprechende Aktivität darstellt. |
|
name
|
activity.name | string |
Der Name der Aktivität oder Übung. |
Aktivitätszeitreihe nach Datum abrufen
Ruft die Aktivitätsdaten für eine bestimmte Ressource über einen Bestimmten Zeitraum ab, indem ein Datum und ein Zeitraum angegeben werden. Die Antwort enthält nur die täglichen Zusammenfassungswerte.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Resource
|
resource | True | string |
Die Ressource der zurückzugebenden Daten. |
|
Datum
|
date | True | string |
Das Enddatum des im Format yyyy-mm-dd angegebenen Zeitraums |
|
Zeitraum
|
period | True | string |
Der Bereich, für den Daten zurückgegeben werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Aktivitätenschritte
|
activities-steps | array of object |
Aktivitätenschritte |
|
Datum und Uhrzeit
|
activities-steps.dateTime | string |
Datum und Uhrzeit |
|
value
|
activities-steps.value | string |
value |
Alarme abrufen
Ruft die Für ein bestimmtes Gerät aktivierten Alarme ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Tracker-ID
|
tracker-id | True | string |
Die ID des Trackers, für den die Daten zurückgegeben werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
trackerAlarms
|
trackerAlarms | array of object |
trackerAlarms |
|
alarmId
|
trackerAlarms.alarmId | integer |
Numerischer Wert, der die Alarm-ID darstellt. |
|
gelöscht
|
trackerAlarms.deleted | boolean |
Gibt an, ob ein Alarm gelöscht wurde. |
|
enabled
|
trackerAlarms.enabled | boolean |
Gibt an, ob ein Alarm aktiviert ist. |
|
wiederkehrend
|
trackerAlarms.recurring | boolean |
Gibt an, ob ein Alarm wiederholt wird. |
|
snoozeCount
|
trackerAlarms.snoozeCount | integer |
Gibt die Häufigkeit an, mit der der Alarm erneut aufläuft. |
|
snoozeLength
|
trackerAlarms.snoozeLength | integer |
Gibt die Zeit in Minuten zwischen Snooze-Perioden an. |
|
syncedToDevice
|
trackerAlarms.syncedToDevice | boolean |
true | FALSCH |
|
time
|
trackerAlarms.time | string |
Der Zeit- und UTC-Offset für den angegebenen Alarm. |
|
Stimmung
|
trackerAlarms.vibe | string |
Gibt den Typ der konfigurierten Vibration zurück. |
|
weekDays
|
trackerAlarms.weekDays | array of string |
weekDays |
Badges abrufen
Ruft eine Liste der Badges des Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kennzeichen
|
badges | array of object |
Kennzeichen |
|
badgeGradientEndColor
|
badges.badgeGradientEndColor | string |
badgeGradientEndColor |
|
badgeGradientStartColor
|
badges.badgeGradientStartColor | string |
badgeGradientStartColor |
|
badgeType
|
badges.badgeType | string |
Typ des empfangenen Badges. |
|
Kategorie
|
badges.category | string |
Kategorie |
|
Prost
|
badges.cheers | array of |
Prost |
|
Datum und Uhrzeit
|
badges.dateTime | string |
Datum, an dem das Signal erreicht wurde. |
|
Beschreibung
|
badges.description | string |
Beschreibung |
|
earnedMessage
|
badges.earnedMessage | string |
earnedMessage |
|
encodedId
|
badges.encodedId | string |
encodedId |
|
Bild100px
|
badges.image100px | string |
Bild100px |
|
Bild125px
|
badges.image125px | string |
Bild125px |
|
image300px
|
badges.image300px | string |
image300px |
|
image50px
|
badges.image50px | string |
image50px |
|
image75px
|
badges.image75px | string |
image75px |
|
marketingDescription
|
badges.marketingDescription | string |
marketingDescription |
|
mobileDescription
|
badges.mobileDescription | string |
mobileDescription |
|
name
|
badges.name | string |
name |
|
shareImage640px
|
badges.shareImage640px | string |
shareImage640px |
|
shareText
|
badges.shareText | string |
shareText |
|
kurzeBeschreibung
|
badges.shortDescription | string |
kurzeBeschreibung |
|
shortName
|
badges.shortName | string |
shortName |
|
timesAchieved
|
badges.timesAchieved | integer |
Häufigkeit, mit der der Benutzer das Signal erreicht hat. |
|
value
|
badges.value | integer |
Das Signalziel in der Maßeinheit. |
Body Fat Time Series nach Datum abrufen
Ruft eine Liste aller Fettprotokolleinträge des Benutzers für einen bestimmten Zeitraum ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
Das Enddatum des im Format jjjj-mm-dd oder heute angegebenen Zeitraums. |
|
Zeitraum
|
period | True | string |
Der Bereich, für den Daten zurückgegeben werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Fett
|
fat | array of object |
Fett |
|
date
|
fat.date | string |
Das Datum, an dem das Körperfettprotokoll aufgezeichnet wurde. |
|
Fett
|
fat.fat | float |
Der Fettanteil des Körpers. |
|
logId
|
fat.logId | integer |
Die Fettprotokoll-ID des Körpers. |
|
source
|
fat.source | string |
Die Position, an der die Körperfettdaten stammen. Weitere Informationen finden Sie unter "Quellwerte". |
|
time
|
fat.time | string |
Der Zeitstempel, zu dem das Körperfettprotokoll aufgezeichnet wurde. |
Favoritenaktivitäten abrufen
Ruft eine Liste der bevorzugten Aktivitäten eines Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
Die ID-Nummer der aufgezeichneten Aktivität. |
|
Beschreibung
|
description | string |
Zusätzliche Informationen zur aufgezeichneten Aktivität. |
|
Mets
|
mets | integer |
Die metabolische Entsprechung (METs) der durchgeführten Aktivität. |
|
name
|
name | string |
Der Name der aufgezeichneten Aktivität. |
Freundes-Bestenliste abrufen
Dieser Endpunkt gibt das Freund-Leaderboard des Benutzers zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Daten
|
data | array of object |
Daten |
|
type
|
data.type | string |
type |
|
id
|
data.id | string |
id |
|
Schritt-Rang
|
data.attributes.step-rank | integer |
Rangfolge zwischen den Freunden des Benutzers. |
|
Schrittzusammenfassung
|
data.attributes.step-summary | integer |
Wöchentliche Schrittanzahl. |
|
type
|
data.relationships.user.data.type | string |
type |
|
id
|
data.relationships.user.data.id | string |
id |
|
iinklusive
|
included | array of object |
iinklusive |
|
type
|
included.type | string |
type |
|
id
|
included.id | string |
id |
|
Avatar
|
included.attributes.avatar | string |
Link zum Avatarbild des Benutzers. |
|
untergeordnet
|
included.attributes.child | boolean |
untergeordnet |
|
Freund
|
included.attributes.friend | boolean |
Freund |
|
name
|
included.attributes.name | string |
name |
Get Activity TCX
Das Training Center XML (TCX) ist ein Datenaustauschformat, das GPS-, Herzfrequenz- und Rundendaten enthält. Dieser Endpunkt ruft die Details des Standorts eines Benutzers mithilfe von GPS- und Herzfrequenzdaten während einer protokollierten Übung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID der Verwendung |
|
Protokoll-ID
|
log-id | True | string |
Die Protokoll-ID der Aktivität. |
|
Teil TCX
|
includePartialTCX | boolean |
Enthält die TCX-Punkte, wenn die GPS-Daten nicht verfügbar sind. |
Gewichtungsprotokoll abrufen
Ruft eine Liste aller Gewichtungsprotokolleinträge des Benutzers für ein bestimmtes Datum ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
Das Datum im Format jjjj-mm-dd |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
weight
|
weight | array of object |
weight |
|
bmi
|
weight.bmi | float |
Berechneter BMI im Format X.XX |
|
date
|
weight.date | string |
Protokolleintragsdatum im Format jjjj-mm-dd. |
|
Fett
|
weight.fat | integer | |
|
logId
|
weight.logId | integer |
Gewichtungsprotokoll-IDs sind für den Benutzer eindeutig, aber nicht global eindeutig. |
|
source
|
weight.source | string |
source |
|
time
|
weight.time | string |
Zeitpunkt der Messung; Stunden und Minuten im Format HH:mm:ss, wird auf die letzte Sekunde des Tages festgelegt, falls nicht angegeben. |
|
weight
|
weight.weight | integer |
Gewichtung im Format X.XX im Einheitensystem, das der bereitgestellten Accept-Language Kopfzeile entspricht oder nicht in der Metrik angegeben ist. |
Gewichtungszeitreihe nach Datum abrufen
Ruft eine Liste aller Gewichtungsprotokolleinträge des Benutzers für einen bestimmten Zeitraum ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
Das Enddatum des im Format jjjj-mm-dd oder heute angegebenen Zeitraums. |
|
Zeitraum
|
period | True | string |
Der Bereich, für den Daten zurückgegeben werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
weight
|
weight | array of object |
weight |
|
bmi
|
weight.bmi | float |
Berechneter BMI im Format X.XX. |
|
date
|
weight.date | string |
Protokolleintragsdatum im Format jjjj-mm-dd. |
|
Fett
|
weight.fat | integer |
Der Fettanteil des Körpers. |
|
logId
|
weight.logId | integer |
Die Gewichtungsprotokoll-IDs. Es ist für den Benutzer einzigartig, aber nicht global eindeutig. |
|
source
|
weight.source | string |
Die Quelle des Gewichtungsprotokolls. |
|
time
|
weight.time | string |
Zeitpunkt der Messung; Stunden und Minuten im Format HH:mm:ss, wird auf die letzte Sekunde des Tages festgelegt, falls nicht angegeben. |
|
weight
|
weight.weight | integer |
Gewichtung im Format X.XX im Einheitensystem, das der bereitgestellten Accept-Language Kopfzeile entspricht oder nicht in der Metrik angegeben ist. |
HRV-Zusammenfassung nach Datum abrufen
Dieser Endpunkt gibt die HrV-Daten (Heart Rate Variability) für ein einzelnes Datum zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
Das Datum im Format jjjj-MM-TT oder heute. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
hrv
|
hrv | array of object |
hrv |
|
dailyRmssd
|
hrv.value.dailyRmssd | float |
Das Wurzelmittelwert-Quadrat der aufeinander folgenden Unterschiede (RMSSD) zwischen Herzschlägen. Sie misst die kurzfristige Variabilität in der täglichen Herzfrequenz des Benutzers in Millisekunden (ms). |
|
deepRmssd
|
hrv.value.deepRmssd | float |
Das Wurzelmittelwert-Quadrat der aufeinander folgenden Unterschiede (RMSSD) zwischen Herzschlägen. Es misst die kurzfristige Variabilität in der Herzfrequenz des Benutzers während des Tiefschlafs in Millisekunden (ms). |
|
Datum und Uhrzeit
|
hrv.dateTime | string |
Das im Format JJJJ-MM-TT angegebene Standbyprotokolldatum. |
Häufige Aktivitäten abrufen
Ruft eine Liste der häufigen Aktivitäten eines Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
Die ID-Nummer der aufgezeichneten Aktivität. |
|
Kalorien
|
calories | integer |
Die Anzahl der Kalorien, die mit der Aktivität verbunden sind. |
|
Beschreibung
|
description | string |
Zusätzliche Informationen zur aufgezeichneten Aktivität. |
|
distance
|
distance | integer |
Entfernung, die mit der aufgezeichneten Aktivität verknüpft ist. |
|
duration
|
duration | integer |
Die Zeitdauer (Millisekunden) nach der Bearbeitung der Übung. Dieser Wert enthält Pausen während der Übung. |
|
name
|
name | string |
Der Name der aufgezeichneten Aktivität. |
Körperfettprotokoll abrufen
Ruft eine Liste aller Fettprotokolleinträge des Benutzers für ein bestimmtes Datum ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
Das Datum im Format jjjj-mm-dd. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Fett
|
fat | array of object |
Fett |
|
date
|
fat.date | string |
Das Datum, an dem das Körperfettprotokoll aufgezeichnet wurde. |
|
Fett
|
fat.fat | integer |
Der Fettanteil des Körpers. |
|
logId
|
fat.logId | integer |
Die Fettprotokoll-ID des Körpers. |
|
source
|
fat.source | string |
Die Position, an der die Körperfettdaten stammen. |
|
time
|
fat.time | string |
Der Zeitstempel, zu dem das Körperfettprotokoll aufgezeichnet wurde. |
Körperziele abrufen
Ruft die Körperfett- und Gewichtsziele eines Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Zieltyp
|
goal-type | True | string |
Zieltyp |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
goalType
|
goal.goalType | string | |
|
startDate
|
goal.startDate | string |
Das Startdatum des Ziels. |
|
startWeight
|
goal.startWeight | float |
Die Gewichtung des Benutzers beim Festlegen des Ziels. |
|
weight
|
goal.weight | float |
Das Gewichtsziel, das erreicht werden soll. |
|
weightThreshold
|
goal.weightThreshold | float |
Die empfohlene Gewichtsmenge, die jede Woche verloren gehen soll, um das Ziel zu erreichen und aufrechtzuerhalten. |
Liste der Ruhezustandsprotokolle abrufen
Gibt eine Liste der Ruhezustandsprotokolleinträge eines Benutzers vor oder nach einem bestimmten Datum zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Nach Datum
|
afterDate | string |
Nach dem Datum, an dem das Ruhezustandsprotokoll des Benutzers zurückgegeben wird (yyyy-mm-dd) |
|
|
Vor Dem Datum
|
beforeDate | string |
Vor dem Datum, an dem das Ruhezustandsprotokoll des Benutzers zurückgegeben wird (yyyy-mm-dd) |
|
|
Sortieren
|
sort | string |
Aufsteigend oder absteigend |
|
|
Limit
|
limit | integer |
Die Anzahl der zurückzugebenden Ruhezustandsprotokolle. (max. 100) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
afterDate
|
pagination.afterDate | string |
afterDate |
|
Grenze
|
pagination.limit | integer |
Grenze |
|
nächster
|
pagination.next | string |
nächster |
|
offset
|
pagination.offset | integer |
offset |
|
vorhergehend
|
pagination.previous | string |
vorhergehend |
|
sort
|
pagination.sort | string |
sort |
|
sleep
|
sleep | array of object |
sleep |
|
dateOfSleep
|
sleep.dateOfSleep | string | |
|
duration
|
sleep.duration | integer |
duration |
|
Effizienz
|
sleep.efficiency | integer |
Effizienz |
|
endTime
|
sleep.endTime | string |
endTime |
|
infoCode
|
sleep.infoCode | integer |
infoCode |
|
isMainSleep
|
sleep.isMainSleep | boolean |
isMainSleep |
|
Daten
|
sleep.levels.data | array of object |
Daten |
|
Datum und Uhrzeit
|
sleep.levels.data.dateTime | string |
Datum und Uhrzeit |
|
Niveau
|
sleep.levels.data.level | string |
Niveau |
|
Sekunden
|
sleep.levels.data.seconds | integer |
Sekunden |
|
shortData
|
sleep.levels.shortData | array of object |
shortData |
|
Datum und Uhrzeit
|
sleep.levels.shortData.dateTime | string |
Datum und Uhrzeit |
|
Niveau
|
sleep.levels.shortData.level | string |
Niveau |
|
Sekunden
|
sleep.levels.shortData.seconds | integer |
Sekunden |
|
count
|
sleep.levels.summary.deep.count | integer |
count |
|
minutes
|
sleep.levels.summary.deep.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.deep.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.light.count | integer |
count |
|
minutes
|
sleep.levels.summary.light.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.light.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.rem.count | integer |
count |
|
minutes
|
sleep.levels.summary.rem.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.rem.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.wake.count | integer |
count |
|
minutes
|
sleep.levels.summary.wake.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.wake.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
logId
|
sleep.logId | integer |
logId |
|
logTyp
|
sleep.logType | string |
logTyp |
|
minutesAfterWakeup
|
sleep.minutesAfterWakeup | integer |
minutesAfterWakeup |
|
minutesAsleep
|
sleep.minutesAsleep | integer |
minutesAsleep |
|
minutesAwake
|
sleep.minutesAwake | integer |
minutesAwake |
|
minutesToFallAsleep
|
sleep.minutesToFallAsleep | integer |
minutesToFallAsleep |
|
startTime
|
sleep.startTime | string |
startTime |
|
timeInBed
|
sleep.timeInBed | integer |
timeInBed |
|
type
|
sleep.type | string |
type |
Profil abrufen
Ruft die Profildaten des Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
aboutMe
|
user.aboutMe | string |
Die informationen "Über mich", die in den Kontoeinstellungen des Benutzers angegeben sind. |
|
Alter
|
user.age | string |
Das Alter basierend auf ihrem angegebenen Geburtstag in den Kontoeinstellungen des Benutzers. |
|
Botschafter
|
user.ambassador | string |
Botschafter |
|
autoStrideEnabled
|
user.autoStrideEnabled | string |
autoStrideEnabled |
|
Avatar
|
user.avatar | string |
Avatar |
|
avatar150
|
user.avatar150 | string |
avatar150 |
|
avatar640
|
user.avatar640 | string |
avatar640 |
|
averageDailySteps
|
user.averageDailySteps | string |
Durchschnittliche tägliche Schritte, die für den Benutzer berechnet werden. |
|
challengesBeta
|
user.challengesBeta | string |
challengesBeta |
|
clockTimeDisplayFormat
|
user.clockTimeDisplayFormat | string |
clockTimeDisplayFormat |
|
country
|
user.country | string |
country |
|
körperschaftlich
|
user.corporate | string |
körperschaftlich |
|
corporateAdmin
|
user.corporateAdmin | string |
corporateAdmin |
|
dateOfBirth
|
user.dateOfBirth | string |
dateOfBirth |
|
Anzeigename
|
user.displayName | string |
Anzeigename |
|
displayNameSetting
|
user.displayNameSetting | string |
displayNameSetting |
|
distanceUnit
|
user.distanceUnit | string |
distanceUnit |
|
encodedId
|
user.encodedId | string |
encodedId |
|
übungGoal
|
user.features.exerciseGoal | string |
übungGoal |
|
Vorname
|
user.firstName | string |
Vorname |
|
foodsLocale
|
user.foodsLocale | string |
foodsLocale |
|
fullName
|
user.fullName | string |
fullName |
|
gender
|
user.gender | string |
gender |
|
GlucoseUnit
|
user.glucoseUnit | string |
GlucoseUnit |
|
height
|
user.height | string |
Der in den Kontoeinstellungen des Benutzers angegebene Höhenwert. |
|
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 |
|
Gebietsschema
|
user.locale | string |
Gebietsschema |
|
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 |
|
Staat
|
user.state | string |
Staat |
|
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 |
Ein Array, das die derzeit vom Benutzer erzielten Fitbit-Badges auflistet. |
|
waterUnit
|
user.waterUnit | string |
waterUnit |
|
waterUnitName
|
user.waterUnitName | string |
waterUnitName |
|
weight
|
user.weight | string |
weight |
|
weightUnit
|
user.weightUnit | string |
weightUnit |
Ruhezustandsprotokoll nach Datum abrufen
Gibt eine Liste der Ruhezustandsprotokolleinträge eines Benutzers für ein bestimmtes Datum zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
yyyy-mm-dd |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
sleep
|
sleep | array of object |
sleep |
|
dateOfSleep
|
sleep.dateOfSleep | string |
Das Datum, an dem das Ruhezustandsprotokoll beendet wurde |
|
duration
|
sleep.duration | integer |
Länge des Schlafes in Millisekunden. |
|
Effizienz
|
sleep.efficiency | integer |
Berechnete Bewertung der Ruhezustandseffizienz. Dies ist nicht die Ruhezustandsbewertung, die in der mobilen Anwendung verfügbar ist. |
|
endTime
|
sleep.endTime | string |
Der Zeitpunkt, zu dem das Ruhezustandsprotokoll beendet wurde. |
|
infoCode
|
sleep.infoCode | integer |
Ein ganzzahliger Wert, der die Qualität der im Ruhezustandsprotokoll erfassten Daten darstellt. 0 = Ausreichende Daten zum Generieren eines Energiesparprotokolls. 1 = Unzureichende Herzfrequenzdaten. 2 = Schlafzeit war zu kurz (weniger als 3 Stunden). 3 = Serverseitiges Problem. |
|
isMainSleep
|
sleep.isMainSleep | boolean |
Boolean |
|
Daten
|
sleep.levels.data | array of object |
Daten |
|
Datum und Uhrzeit
|
sleep.levels.data.dateTime | string |
Datum und Uhrzeit |
|
Niveau
|
sleep.levels.data.level | string |
Niveau |
|
Sekunden
|
sleep.levels.data.seconds | integer |
Sekunden |
|
shortData
|
sleep.levels.shortData | array of object |
shortData |
|
Datum und Uhrzeit
|
sleep.levels.shortData.dateTime | string |
Datum und Uhrzeit |
|
Niveau
|
sleep.levels.shortData.level | string |
Niveau |
|
Sekunden
|
sleep.levels.shortData.seconds | integer |
Sekunden |
|
count
|
sleep.levels.summary.deep.count | integer |
count |
|
minutes
|
sleep.levels.summary.deep.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.deep.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.light.count | integer |
count |
|
minutes
|
sleep.levels.summary.light.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.light.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.rem.count | integer |
count |
|
minutes
|
sleep.levels.summary.rem.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.rem.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.wake.count | integer |
count |
|
minutes
|
sleep.levels.summary.wake.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.wake.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
logId
|
sleep.logId | integer |
Standbyprotokoll-ID. |
|
minutesAfterWakeup
|
sleep.minutesAfterWakeup | integer |
Die Gesamtzahl der Minuten nach dem Aufwachen des Benutzers. |
|
minutesAsleep
|
sleep.minutesAsleep | integer |
Die Gesamtzahl der Minuten, die der Benutzer eingeschlafen hat. |
|
minutesAwake
|
sleep.minutesAwake | integer |
Die Summe der "Wake"-Minuten. Es enthält nicht vor dem Einschlafen oder nach dem Aufwachen. |
|
minutesToFallAsleep
|
sleep.minutesToFallAsleep | integer |
Die Gesamtzahl der Minuten, bevor der Benutzer einschlafen kann. Dieser Wert ist in der Regel 0 für automatisch eingeschlafene Schlafprotokolle. |
|
logTyp
|
sleep.logType | string |
auto_detected | Manuell |
|
startTime
|
sleep.startTime | string |
Zeit, zu der das Standbyprotokoll beginnt. |
|
timeInBed
|
sleep.timeInBed | integer |
Die Gesamtzahl der Minuten, die der Benutzer im Bett hatte. |
|
type
|
sleep.type | string |
klassisch | Bühnen |
|
tief
|
summary.stages.deep | integer |
tief |
|
Licht
|
summary.stages.light | integer |
Licht |
|
rem
|
summary.stages.rem | integer |
rem |
|
aufwachen
|
summary.stages.wake | integer |
aufwachen |
|
totalMinutesAsleep
|
summary.totalMinutesAsleep | integer |
Die Gesamtzahl der Minuten, die der Benutzer in allen Ruhezustandsdatensätzen im Energiesparprotokoll einschlafen ließ. |
|
totalSleepRecords
|
summary.totalSleepRecords | integer |
Die Anzahl der Energiespardatensätze innerhalb des Energiesparprotokolls. |
|
totalTimeInBed
|
summary.totalTimeInBed | integer |
Die Gesamtzahl der Minuten, die der Benutzer in allen Datensätzen im Schlafprotokoll im Bett war. |
Ruhezustandsprotokoll nach Datumsbereich abrufen
Gibt eine Liste der Ruhezustandsprotokolleinträge eines Benutzers für einen Datumsbereich zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Startdatum
|
startDate | True | string |
Das Datum für das erste Schlafprotokoll, das zurückgegeben werden soll (yyyy-mm-dd) |
|
Enddatum
|
endDate | True | string |
Das Datum, an dem das letzte Ruhezustandsprotokoll zurückgegeben werden soll (yyyy-mm-dd) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
sleep
|
sleep | array of object |
sleep |
|
dateOfSleep
|
sleep.dateOfSleep | string |
Das Datum, an dem das Energiesparprotokoll beendet wurde. |
|
duration
|
sleep.duration | integer |
Länge des Schlafes in Millisekunden. |
|
Effizienz
|
sleep.efficiency | integer |
Berechnete Bewertung der Ruhezustandseffizienz. Dies ist nicht die Ruhezustandsbewertung, die in der mobilen Anwendung verfügbar ist. |
|
endTime
|
sleep.endTime | string |
Der Zeitpunkt, zu dem das Ruhezustandsprotokoll beendet wurde. |
|
infoCode
|
sleep.infoCode | integer |
Ein ganzzahliger Wert, der die Qualität der im Ruhezustandsprotokoll erfassten Daten darstellt. 0 = Ausreichende Daten zum Generieren eines Energiesparprotokolls. 1 = Unzureichende Herzfrequenzdaten. 2 = Schlafzeit war zu kurz (weniger als 3 Stunden). 3 = Serverseitiges Problem. |
|
isMainSleep
|
sleep.isMainSleep | boolean |
Boolean |
|
Daten
|
sleep.levels.data | array of object |
Daten |
|
Datum und Uhrzeit
|
sleep.levels.data.dateTime | string |
Datum und Uhrzeit |
|
Niveau
|
sleep.levels.data.level | string |
Niveau |
|
Sekunden
|
sleep.levels.data.seconds | integer |
Sekunden |
|
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 |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.deep.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.light.count | integer |
count |
|
minutes
|
sleep.levels.summary.light.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.light.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.rem.count | integer |
count |
|
minutes
|
sleep.levels.summary.rem.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.rem.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
count
|
sleep.levels.summary.wake.count | integer |
count |
|
minutes
|
sleep.levels.summary.wake.minutes | integer |
minutes |
|
dreißigDayAvgMinutes
|
sleep.levels.summary.wake.thirtyDayAvgMinutes | integer |
dreißigDayAvgMinutes |
|
shortData
|
sleep.levels.shortData | array of object |
shortData |
|
Datum und Uhrzeit
|
sleep.levels.shortData.dateTime | string |
Datum und Uhrzeit |
|
Niveau
|
sleep.levels.shortData.level | string |
Niveau |
|
Sekunden
|
sleep.levels.shortData.seconds | integer |
Sekunden |
|
logId
|
sleep.logId | integer |
Standbyprotokoll-ID. |
|
minutesAfterWakeup
|
sleep.minutesAfterWakeup | integer |
Die Gesamtzahl der Minuten nach dem Aufwachen des Benutzers. |
|
minutesAsleep
|
sleep.minutesAsleep | integer |
Die Gesamtzahl der Minuten, die der Benutzer eingeschlafen hat. |
|
minutesAwake
|
sleep.minutesAwake | integer |
Die Summe der "Wake"-Minuten. Es enthält nicht vor dem Einschlafen oder nach dem Aufwachen. |
|
minutesToFallAsleep
|
sleep.minutesToFallAsleep | integer |
Die Gesamtzahl der Minuten, bevor der Benutzer einschlafen kann. Dieser Wert ist in der Regel 0 für automatisch eingeschlafene Schlafprotokolle. |
|
logTyp
|
sleep.logType | string |
auto_detected | Manuell |
|
startTime
|
sleep.startTime | string |
Zeitpunkt, zu dem das Ruhezustandsprotokoll beginnt |
|
timeInBed
|
sleep.timeInBed | integer |
Gesamtzahl der Minuten, die der Benutzer im Bett war |
|
type
|
sleep.type | string |
klassisch | Bühnen |
Schlafziel abrufen
Geben Sie die codierte ID des Benutzers an. Verwenden Sie "-" (Gedankenstrich) für den aktuellen angemeldeten Benutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
flowId
|
consistency.flowId | integer |
0 = Ein Schlafziel ist festgelegt, aber es werden nicht genügend Schlafprotokolle aufgezeichnet. 1 = Der Benutzer hat entweder sein Schlafziel verpasst oder kein Ziel festgelegt, aber es werden genügend Schlafprotokolle aufgezeichnet. 2 = Ein Schlafziel ist nicht festgelegt, und es werden nicht genügend Schlafprotokolle aufgezeichnet. 3 = Der Benutzer hat sein Schlafziel erreicht |
|
minDuration
|
goal.minDuration | integer |
Länge des Schlafzielzeitraums in Minuten. |
|
updatedOn
|
goal.updatedOn | string |
Der Zeitstempel, den das Ziel erstellt/aktualisiert hat. |
Tägliche Aktivitätszusammenfassung abrufen
Ruft eine Zusammenfassung und Liste der Aktivitäten und Aktivitätsprotokolleinträge eines Benutzers für einen bestimmten Tag ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
Datum |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
activities
|
activities | array of |
activities |
|
activeMinutes
|
goals.activeMinutes | integer |
activeMinutes |
|
kalorienaus
|
goals.caloriesOut | integer |
kalorienaus |
|
distance
|
goals.distance | float |
distance |
|
Etagen
|
goals.floors | integer |
Etagen |
|
steps
|
goals.steps | integer |
steps |
|
activeScore
|
summary.activeScore | integer |
activeScore |
|
activityCalories
|
summary.activityCalories | integer |
activityCalories |
|
kalorienestimationMu
|
summary.calorieEstimationMu | integer |
kalorienestimationMu |
|
KalorienBMR
|
summary.caloriesBMR | integer |
KalorienBMR |
|
kalorienaus
|
summary.caloriesOut | integer |
kalorienaus |
|
KalorienOutUnestimated
|
summary.caloriesOutUnestimated | integer |
KalorienOutUnestimated |
|
customHeartRateZones
|
summary.customHeartRateZones | array of object |
customHeartRateZones |
|
kalorienaus
|
summary.customHeartRateZones.caloriesOut | integer |
kalorienaus |
|
max
|
summary.customHeartRateZones.max | integer |
max |
|
min
|
summary.customHeartRateZones.min | integer |
min |
|
minutes
|
summary.customHeartRateZones.minutes | integer |
minutes |
|
name
|
summary.customHeartRateZones.name | string |
name |
|
Abstände
|
summary.distances | array of object |
Abstände |
|
activity
|
summary.distances.activity | string |
<Aktivitätsname> | Gesamt | Tracker | loggedActivities | veryActive | moderatelyActive | lightlyActive | sedentaryActive |
|
distance
|
summary.distances.distance | integer |
Für die angegebene Ressource wird die Entfernung für den Tag, der in den einheiten angezeigt wird, die durch die kopfzeile Accept-Language definiert sind. |
|
Erhebung
|
summary.elevation | integer |
Die höhe, die für den Tag, der in den einheiten angezeigt wird, die durch die Accept-Language Kopfzeile definiert sind. |
|
fairActiveMinutes
|
summary.fairlyActiveMinutes | integer |
Die Gesamtzahl der Minuten, die der Benutzer relativ/moderat aktiv war. |
|
Etagen
|
summary.floors | integer |
Die äquivalenten Stockwerke für den Tag, der in den einheiten angezeigt wird, die durch die Accept-Language Kopfzeile definiert sind. |
|
heartRateZones
|
summary.heartRateZones | array of object |
heartRateZones |
|
kalorienaus
|
summary.heartRateZones.caloriesOut | integer |
kalorienaus |
|
max
|
summary.heartRateZones.max | integer |
max |
|
min
|
summary.heartRateZones.min | integer |
min |
|
minutes
|
summary.heartRateZones.minutes | integer |
minutes |
|
name
|
summary.heartRateZones.name | string |
Der Herzfrequenzumfang ist erforderlich, um diesen Wert anzuzeigen. Außerhalb des Zulässigen Bereichs | Fettbrand | Kardio | Höhepunkt |
|
lightlyActiveMinutes
|
summary.lightlyActiveMinutes | integer |
Die Gesamtzahl der Minuten, die der Benutzer leicht aktiv war. |
|
marginalCalories
|
summary.marginalCalories | integer |
Am Tag verbrannte die gesamte marginal geschätzte Kalorienmenge. |
|
restingHeartRate
|
summary.restingHeartRate | integer |
Der Bereich "Herzfrequenz" ist erforderlich, um diesen Wert anzuzeigen. |
|
sedentaryMinutes
|
summary.sedentaryMinutes | integer |
Die Gesamtzahl der Minuten, die der Benutzer sedentär war. |
|
steps
|
summary.steps | integer |
Gesamtschritte für den Tag. |
|
useEstimation
|
summary.useEstimation | boolean |
Boolescher Wert, der angibt, ob Schätzungen in Berechnungen verwendet werden. |
|
veryActiveMinutes
|
summary.veryActiveMinutes | integer |
Die Gesamtzahl der Minuten, die der Benutzer sehr aktiv war. |
Vo2 Max. Zusammenfassung nach Datum abrufen
Gibt die Cardio Fitness Score -Daten (auch als VO2 Max bezeichnet) für ein einzelnes Datum zurück. VO2 Max-Werte werden als Bereich angezeigt, wenn keine Ausführungsdaten verfügbar sind oder ein einzelner numerischer Wert, wenn der Benutzer ein GPS für Die Ausführung verwendet. Weitere Informationen finden Sie unter "Weitere Informationen".
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
Das Datum im Format jjjj-mm-dd oder heute. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
kardioScore
|
cardioScore | array of object |
kardioScore |
|
Datum und Uhrzeit
|
cardioScore.dateTime | string |
Das im Format JJJJ-MM-TT angegebene Datum. |
|
vo2Max
|
cardioScore.value.vo2Max | string |
Der anzeigebare Wert von VO2 Max in mL/kg/min |
Zusammenfassung der Atemrate nach Datum abrufen
Dieser Endpunkt gibt durchschnittliche Atemfrequenzdaten für ein einzelnes Datum zurück. Die Atemfrequenzdaten gelten speziell für den "Hauptschlaf" eines Benutzers, der die längste Zeit ist, in der sie an einem bestimmten Datum eingeschlafen waren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
user-id | True | string |
Die codierte ID des Benutzers |
|
Datum
|
date | True | string |
Das Datum im Format jjjj-mm-dd oder heute. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Br
|
br | array of object |
Br |
|
Atemrate
|
br.value.breathingRate | float |
Die durchschnittliche Anzahl der Atempausen pro Minute. |
|
Datum und Uhrzeit
|
br.dateTime | string |
Das im Format JJJJ-MM-TT angegebene Standbyprotokolldatum. |