Fitbit (Editor Independente) (Versão prévia)
Uma maneira de acessar a API Web do Fitbit
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Ashwin Ganesh Kumar |
| URL | https://www.blisdigital.com/ |
| a.kumar@blisdigital.com |
| Metadados do conector | |
|---|---|
| Publicador | Ashwin Ganesh Kumar |
| Site | https://dev.fitbit.com// |
| Política de privacidade | https://www.fitbit.com/global/nl/legal/privacy-policy |
| Categorias | Dados |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Obter alarmes |
Recupera os alarmes habilitados para um dispositivo específico. |
| Obter atividade TCX |
O TCX (Centro de Treinamento XML) é um formato de troca de dados que contém GPS, frequência cardíaca e dados de volta. Esse ponto de extremidade recupera os detalhes da localização de um usuário usando dados de GPS e freqüência cardíaca durante um exercício registrado. |
| Obter atividades favoritas |
Recupera uma lista das atividades favoritas de um usuário. |
| Obter atividades frequentes |
Recupera uma lista das atividades frequentes de um usuário. |
| Obter dispositivos |
Recupera uma lista de dispositivos Fitbit emparelhados com a conta de um usuário. |
| Obter estatísticas de tempo de vida |
Recupera as estatísticas de atividade do usuário. |
| Obter lista de logs de atividades |
Recupera uma lista das entradas de log de atividades de um usuário antes ou depois de um determinado dia. |
| Obter lista de logs de suspensão |
Retorna uma lista das entradas de log de suspensão de um usuário antes ou depois de uma determinada data |
| Obter log de gordura do corpo |
Recupera uma lista de entradas de log de gordura corporal de todos os usuários para uma determinada data. |
| Obter Log de Peso |
Recupera uma lista de entradas de log de peso de todos os usuários para uma determinada data. |
| Obter log de suspensão por data |
Retorna uma lista de entradas de log de suspensão de um usuário para uma determinada data |
| Obter log de suspensão por intervalo de datas |
Retorna uma lista das entradas de log de suspensão de um usuário para um intervalo de datas. |
| Obter meta de suspensão |
Especifique a ID codificada do usuário. Use "-" (traço) para o usuário conectado atual. |
| Obter metas de atividade |
Recupera as metas atuais de atividade diária ou semanal de um usuário. |
| Obter metas de corpo |
Recupera as metas de peso e gordura corporal de um usuário. |
| Obter o Placar de Líderes de Amigos |
Esse ponto de extremidade retorna o placar de líderes de amigos do usuário |
| Obter perfil |
Recupera os dados do perfil do usuário. |
| Obter resumo da taxa de respiração por data |
Esse ponto de extremidade retorna dados médios de taxa de respiração para uma única data. Os dados de Taxa de Respiração se aplicam especificamente ao "sono principal" de um usuário, que é o período de tempo mais longo durante o qual eles estavam dormindo em uma determinada data. |
| Obter resumo de atividades diárias |
Recupera um resumo e uma lista de atividades e entradas de log de atividades de um usuário para um determinado dia. |
| Obter resumo do HRV por data |
Esse ponto de extremidade retorna os dados de HRV (Variabilidade da Freqüência Cardíaca) para uma única data |
| Obter resumo máximo de VO2 por data |
Retorna os dados de Pontuação de Aptidão Cardio (também conhecido como VO2 Max) para uma única data. Os valores máximos de VO2 serão mostrados como um intervalo se nenhum dado de execução estiver disponível ou um único valor numérico se o usuário usar um GPS para execuções. Consulte Informações Adicionais para obter mais contexto. |
| Obter selos |
Recupera uma lista de selos do usuário. |
| Obter série de tempo de gordura corporal por data |
Recupera uma lista de entradas de log de gordura corporal de todos os usuários por um determinado período. |
| Obter série temporal da atividade por data |
Recupera os dados de atividade de um determinado recurso durante um período de tempo especificando um período de data e hora. A resposta incluirá apenas os valores de resumo diários. |
| Obter série temporal de peso por data |
Recupera uma lista de entradas de log de peso de todos os usuários por um determinado período. |
| Obter série temporal do corpo por data |
Recupera uma lista do imc, da gordura corporal ou do peso de todo o usuário por um determinado período. |
| Obter tipo de atividade |
Recupera os detalhes de uma única atividade do banco de dados de atividades do Fitbit no formato solicitado. Se disponível, os detalhes do nível de atividade serão exibidos. |
| Obter tipos de atividade recentes |
Recupera uma lista dos tipos de atividades recentes de um usuário registrados com alguns detalhes do último log de atividades desse tipo. |
| Obter todos os tipos de atividade |
Recupera uma lista de todas as atividades públicas válidas do Fitbit e as atividades privadas criadas pelo usuário do banco de dados de atividades do Fitbit no formato solicitado. Se disponível, os detalhes do nível de atividade serão exibidos. |
Obter alarmes
Recupera os alarmes habilitados para um dispositivo específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
ID do rastreador
|
tracker-id | True | string |
A ID do rastreador para o qual os dados são retornados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
trackerAlarms
|
trackerAlarms | array of object |
trackerAlarms |
|
alarmId
|
trackerAlarms.alarmId | integer |
Valor numérico que representa a ID do alarme. |
|
excluído
|
trackerAlarms.deleted | boolean |
Indica se um alarme foi excluído. |
|
enabled
|
trackerAlarms.enabled | boolean |
Indica se um alarme está habilitado. |
|
recorrente
|
trackerAlarms.recurring | boolean |
Indica se um alarme é recorrente. |
|
snoozeCount
|
trackerAlarms.snoozeCount | integer |
Indica o número de vezes que o alarme vai cootar. |
|
snoozeLength
|
trackerAlarms.snoozeLength | integer |
Indica o tempo em minutos entre os períodos de soneca. |
|
syncedToDevice
|
trackerAlarms.syncedToDevice | boolean |
true | falso |
|
time
|
trackerAlarms.time | string |
A hora e o deslocamento UTC para o alarme especificado. |
|
vibração
|
trackerAlarms.vibe | string |
Retorna o tipo de vibração configurado. |
|
weekDays
|
trackerAlarms.weekDays | array of string |
weekDays |
Obter atividade TCX
O TCX (Centro de Treinamento XML) é um formato de troca de dados que contém GPS, frequência cardíaca e dados de volta. Esse ponto de extremidade recupera os detalhes da localização de um usuário usando dados de GPS e freqüência cardíaca durante um exercício registrado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do uso |
|
Log Id
|
log-id | True | string |
A ID de log da atividade. |
|
TCX parcial
|
includePartialTCX | boolean |
Inclui os pontos TCX quando os dados gps não estão disponíveis. |
Obter atividades favoritas
Recupera uma lista das atividades favoritas de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
O número do identificador da atividade registrada. |
|
descrição
|
description | string |
Informações adicionais sobre a atividade registrada. |
|
Mets
|
mets | integer |
O equivalente metabólico (METs) da atividade executada. |
|
nome
|
name | string |
O nome da atividade gravada. |
Obter atividades frequentes
Recupera uma lista das atividades frequentes de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
O número do identificador da atividade registrada. |
|
Calorias
|
calories | integer |
O número de calorias queimadas associadas à atividade. |
|
descrição
|
description | string |
Informações adicionais sobre a atividade registrada. |
|
distance
|
distance | integer |
Distância percorrida associada à atividade registrada. |
|
duration
|
duration | integer |
O tempo (milissegundos) após a edição do exercício. Esse valor conterá pausas durante o exercício. |
|
nome
|
name | string |
O nome da atividade gravada. |
Obter dispositivos
Recupera uma lista de dispositivos Fitbit emparelhados com a conta de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
pilha
|
battery | string |
Retorna o nível de bateria do dispositivo |
|
batteryLevel
|
batteryLevel | integer |
Retorna o percentual de nível de bateria do dispositivo. |
|
deviceVersion
|
deviceVersion | string |
O nome do produto do dispositivo. |
|
features
|
features | array of |
features |
|
id
|
id | string |
A ID do dispositivo. |
|
lastSyncTime
|
lastSyncTime | string |
Carimbo de data/hora que representa a última vez que o dispositivo foi sincronizado com o aplicativo móvel Fitbit. |
|
mac
|
mac | string |
Número da ID do Mac |
|
tipo
|
type | string |
RASTREADOR | ESCALA |
Obter estatísticas de tempo de vida
Recupera as estatísticas de atividade do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
date
|
best.total.distance.date | string |
date |
|
value
|
best.total.distance.value | float |
value |
|
date
|
best.total.floors.date | string |
date |
|
value
|
best.total.floors.value | float |
value |
|
date
|
best.total.steps.date | string |
date |
|
value
|
best.total.steps.value | integer |
value |
|
date
|
best.tracker.distance.date | string |
date |
|
value
|
best.tracker.distance.value | float |
value |
|
date
|
best.tracker.floors.date | string |
date |
|
value
|
best.tracker.floors.value | float |
value |
|
date
|
best.tracker.steps.date | string |
date |
|
value
|
best.tracker.steps.value | integer |
value |
|
activeScore
|
lifetime.total.activeScore | integer |
activeScore |
|
caloriesOut
|
lifetime.total.caloriesOut | integer |
caloriesOut |
|
distance
|
lifetime.total.distance | float |
distance |
|
Pisos
|
lifetime.total.floors | integer |
Pisos |
|
etapas
|
lifetime.total.steps | integer |
etapas |
|
activeScore
|
lifetime.tracker.activeScore | integer |
activeScore |
|
caloriesOut
|
lifetime.tracker.caloriesOut | integer |
caloriesOut |
|
distance
|
lifetime.tracker.distance | float |
distance |
|
Pisos
|
lifetime.tracker.floors | integer |
Pisos |
|
etapas
|
lifetime.tracker.steps | integer |
etapas |
Obter lista de logs de atividades
Recupera uma lista das entradas de log de atividades de um usuário antes ou depois de um determinado dia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Após a Data
|
afterDate | string |
A data após (yyyy-mm-dd) |
|
|
Data anterior
|
beforeDate | string |
A data anterior (yyyy-mm-dd) |
|
|
Classificar
|
sort | string |
A ordem de classificação de entradas por data. |
|
|
Limit
|
limit | integer |
O número de entradas retornadas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
activities
|
activities | array of object |
activities |
|
activeDuration
|
activities.activeDuration | integer |
A quantidade de tempo (milissegundos) em cada activityLevel. |
|
activityLevel
|
activities.activityLevel | array of object |
activityLevel |
|
minutes
|
activities.activityLevel.minutes | integer |
minutes |
|
nome
|
activities.activityLevel.name | string |
nome |
|
activityName
|
activities.activityName | string |
Nome do exercício gravado. |
|
activityTypeId
|
activities.activityTypeId | integer |
O número do identificador do activityName. |
|
Calorias
|
activities.calories | integer |
Número de calorias queimadas durante o exercício. |
|
caloriesLink
|
activities.caloriesLink | string |
Ponto de extremidade da API Web para chamar para obter as calorias específicas queimadas para o exercício nomeado. |
|
duration
|
activities.duration | integer |
O tempo (milissegundos) após a edição do exercício. Se o exercício não tiver sido editado, a duração = originalDuration. Esse valor conterá pausas durante o exercício. |
|
elevationGain
|
activities.elevationGain | float |
Elevação obtida durante o exercício. |
|
últimaModificação
|
activities.lastModified | string |
O carimbo de data/hora em que o exercício foi modificado pela última vez. |
|
logId
|
activities.logId | integer |
O identificador do log de atividades do exercício. |
|
Tipo de log
|
activities.logType | string |
auto_detected | manual | mobile_run | rastreador | o nome do aplicativo de terceiros |
|
Calorias
|
activities.manualValuesSpecified.calories | boolean |
Um valor booliano informando se as calorias foram fornecidas ao gravar o exercício. |
|
distance
|
activities.manualValuesSpecified.distance | boolean |
Um valor booliano informando se a distância foi fornecida ao gravar o exercício. |
|
etapas
|
activities.manualValuesSpecified.steps | boolean |
Um valor booliano informando se as etapas foram fornecidas ao gravar o exercício. |
|
originalDuration
|
activities.originalDuration | integer |
O período inicial em tempo (milissegundos) em que o exercício foi registrado. Esse valor conterá pausas durante o exercício. |
|
originalStartTime
|
activities.originalStartTime | string |
A data de início inicial em que o exercício foi registrado. |
|
startTime
|
activities.startTime | string |
A data de início após a edição do exercício. Se o exercício não tiver sido editado, o startTime = originalStartTime. |
|
etapas
|
activities.steps | integer |
Número de etapas executadas durante o exercício. |
|
tcxLink
|
activities.tcxLink | string |
URL para baixar o arquivo TCX. |
|
afterDate
|
pagination.afterDate | string |
afterDate |
|
limit
|
pagination.limit | integer |
limit |
|
próximo
|
pagination.next | string |
próximo |
|
deslocamento
|
pagination.offset | integer |
deslocamento |
|
anterior
|
pagination.previous | string |
anterior |
|
classificar
|
pagination.sort | string |
classificar |
Obter lista de logs de suspensão
Retorna uma lista das entradas de log de suspensão de um usuário antes ou depois de uma determinada data
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Após a Data
|
afterDate | string |
Após a data em que o log de suspensão do usuário é retornado (yyyy-mm-dd) |
|
|
Data anterior
|
beforeDate | string |
Antes da data em que o log de suspensão do usuário é retornado (yyyy-mm-dd) |
|
|
Classificar
|
sort | string |
crescente ou decrescente |
|
|
Limit
|
limit | integer |
O número de logs de suspensão a serem retornados. (máximo de 100) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
afterDate
|
pagination.afterDate | string |
afterDate |
|
limit
|
pagination.limit | integer |
limit |
|
próximo
|
pagination.next | string |
próximo |
|
deslocamento
|
pagination.offset | integer |
deslocamento |
|
anterior
|
pagination.previous | string |
anterior |
|
classificar
|
pagination.sort | string |
classificar |
|
sleep
|
sleep | array of object |
sleep |
|
dateOfSleep
|
sleep.dateOfSleep | string | |
|
duration
|
sleep.duration | integer |
duration |
|
eficiência
|
sleep.efficiency | integer |
eficiência |
|
endTime
|
sleep.endTime | string |
endTime |
|
infoCode
|
sleep.infoCode | integer |
infoCode |
|
isMainSleep
|
sleep.isMainSleep | boolean |
isMainSleep |
|
dados
|
sleep.levels.data | array of object |
dados |
|
data e hora
|
sleep.levels.data.dateTime | string |
data e hora |
|
nível
|
sleep.levels.data.level | string |
nível |
|
segundos
|
sleep.levels.data.seconds | integer |
segundos |
|
shortData
|
sleep.levels.shortData | array of object |
shortData |
|
data e hora
|
sleep.levels.shortData.dateTime | string |
data e hora |
|
nível
|
sleep.levels.shortData.level | string |
nível |
|
segundos
|
sleep.levels.shortData.seconds | integer |
segundos |
|
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 |
|
Tipo de log
|
sleep.logType | string |
Tipo de log |
|
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 |
|
tipo
|
sleep.type | string |
tipo |
Obter log de gordura do corpo
Recupera uma lista de entradas de log de gordura corporal de todos os usuários para uma determinada data.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato yyyyy-mm-dd. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
gordura
|
fat | array of object |
gordura |
|
date
|
fat.date | string |
A data em que o log de gordura do corpo foi registrado. |
|
gordura
|
fat.fat | integer |
A porcentagem de gordura corporal. |
|
logId
|
fat.logId | integer |
A ID do log de gordura do corpo. |
|
fonte
|
fat.source | string |
O local em que os dados de gordura corporal se originaram. |
|
time
|
fat.time | string |
O carimbo de data/hora quando o log de gordura do corpo foi registrado. |
Obter Log de Peso
Recupera uma lista de entradas de log de peso de todos os usuários para uma determinada data.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato yyyy-mm-dd |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
peso
|
weight | array of object |
peso |
|
Imc
|
weight.bmi | float |
IMC calculado no formato X.XX |
|
date
|
weight.date | string |
Data de entrada de log no formato yyyy-mm-dd. |
|
gordura
|
weight.fat | integer | |
|
logId
|
weight.logId | integer |
As IDs de Log de Peso são exclusivas para o usuário, mas não globalmente exclusivas. |
|
fonte
|
weight.source | string |
fonte |
|
time
|
weight.time | string |
Hora da medida; horas e minutos no formato HH:mm:ss, definido como o último segundo do dia, se não for fornecido. |
|
peso
|
weight.weight | integer |
Peso no formato X.XX, no sistema de unidade que corresponde ao cabeçalho Accept-Language fornecido ou se não for fornecido na métrica. |
Obter log de suspensão por data
Retorna uma lista de entradas de log de suspensão de um usuário para uma determinada data
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
aaaa-mm-dd |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sleep
|
sleep | array of object |
sleep |
|
dateOfSleep
|
sleep.dateOfSleep | string |
A data em que o log de suspensão terminou |
|
duration
|
sleep.duration | integer |
Comprimento do sono em milissegundos. |
|
eficiência
|
sleep.efficiency | integer |
Pontuação calculada de eficiência do sono. Essa não é a pontuação de suspensão disponível no aplicativo móvel. |
|
endTime
|
sleep.endTime | string |
Hora em que o log de suspensão terminou. |
|
infoCode
|
sleep.infoCode | integer |
Um valor inteiro que representa a qualidade dos dados coletados no log de suspensão. 0 = Dados suficientes para gerar um log de suspensão. 1 = Dados de freqüência cardíaca insuficientes. 2 = O período de suspensão foi muito curto (menos de 3 horas). 3 = Problema do lado do servidor. |
|
isMainSleep
|
sleep.isMainSleep | boolean |
booleano |
|
dados
|
sleep.levels.data | array of object |
dados |
|
data e hora
|
sleep.levels.data.dateTime | string |
data e hora |
|
nível
|
sleep.levels.data.level | string |
nível |
|
segundos
|
sleep.levels.data.seconds | integer |
segundos |
|
shortData
|
sleep.levels.shortData | array of object |
shortData |
|
data e hora
|
sleep.levels.shortData.dateTime | string |
data e hora |
|
nível
|
sleep.levels.shortData.level | string |
nível |
|
segundos
|
sleep.levels.shortData.seconds | integer |
segundos |
|
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 do log de suspensão. |
|
minutesAfterWakeup
|
sleep.minutesAfterWakeup | integer |
O número total de minutos após o usuário acordar. |
|
minutesAsleep
|
sleep.minutesAsleep | integer |
O número total de minutos em que o usuário estava dormindo. |
|
minutesAwake
|
sleep.minutesAwake | integer |
A soma total apenas de minutos de "ativação". Não inclui antes de dormir ou depois de acordar. |
|
minutesToFallAsleep
|
sleep.minutesToFallAsleep | integer |
O número total de minutos antes que o usuário adormeça. Esse valor geralmente é 0 para logs de suspensão criados automaticamente. |
|
Tipo de log
|
sleep.logType | string |
auto_detected | Manual |
|
startTime
|
sleep.startTime | string |
Hora em que o log de suspensão começa. |
|
timeInBed
|
sleep.timeInBed | integer |
Número total de minutos em que o usuário estava na cama. |
|
tipo
|
sleep.type | string |
clássico | Estágios |
|
fundo
|
summary.stages.deep | integer |
fundo |
|
luz
|
summary.stages.light | integer |
luz |
|
rem
|
summary.stages.rem | integer |
rem |
|
acordar
|
summary.stages.wake | integer |
acordar |
|
totalMinutesAsleep
|
summary.totalMinutesAsleep | integer |
Número total de minutos em que o usuário estava dormindo em todos os registros de suspensão no log de suspensão. |
|
totalSleepRecords
|
summary.totalSleepRecords | integer |
O número de registros de suspensão dentro do log de suspensão. |
|
totalTimeInBed
|
summary.totalTimeInBed | integer |
Número total de minutos em que o usuário estava na cama em todos os registros no log de suspensão. |
Obter log de suspensão por intervalo de datas
Retorna uma lista das entradas de log de suspensão de um usuário para um intervalo de datas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Data de Início
|
startDate | True | string |
A data para o primeiro log de suspensão a ser retornado (yyyy-mm-dd) |
|
Data de Término
|
endDate | True | string |
A data do último log de suspensão a ser retornado (yyyy-mm-dd) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sleep
|
sleep | array of object |
sleep |
|
dateOfSleep
|
sleep.dateOfSleep | string |
A data em que o log de suspensão terminou. |
|
duration
|
sleep.duration | integer |
Comprimento do sono em milissegundos. |
|
eficiência
|
sleep.efficiency | integer |
Pontuação calculada de eficiência do sono. Essa não é a pontuação de suspensão disponível no aplicativo móvel. |
|
endTime
|
sleep.endTime | string |
Hora em que o log de suspensão terminou. |
|
infoCode
|
sleep.infoCode | integer |
Um valor inteiro que representa a qualidade dos dados coletados no log de suspensão. 0 = Dados suficientes para gerar um log de suspensão. 1 = Dados de freqüência cardíaca insuficientes. 2 = O período de suspensão foi muito curto (menos de 3 horas). 3 = Problema do lado do servidor. |
|
isMainSleep
|
sleep.isMainSleep | boolean |
booleano |
|
dados
|
sleep.levels.data | array of object |
dados |
|
data e hora
|
sleep.levels.data.dateTime | string |
data e hora |
|
nível
|
sleep.levels.data.level | string |
nível |
|
segundos
|
sleep.levels.data.seconds | integer |
segundos |
|
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 |
|
data e hora
|
sleep.levels.shortData.dateTime | string |
data e hora |
|
nível
|
sleep.levels.shortData.level | string |
nível |
|
segundos
|
sleep.levels.shortData.seconds | integer |
segundos |
|
logId
|
sleep.logId | integer |
ID do log de suspensão. |
|
minutesAfterWakeup
|
sleep.minutesAfterWakeup | integer |
O número total de minutos após o usuário acordar. |
|
minutesAsleep
|
sleep.minutesAsleep | integer |
O número total de minutos em que o usuário estava dormindo. |
|
minutesAwake
|
sleep.minutesAwake | integer |
A soma total apenas de minutos de "ativação". Não inclui antes de dormir ou depois de acordar. |
|
minutesToFallAsleep
|
sleep.minutesToFallAsleep | integer |
O número total de minutos antes que o usuário adormeça. Esse valor geralmente é 0 para logs de suspensão criados automaticamente. |
|
Tipo de log
|
sleep.logType | string |
auto_detected | Manual |
|
startTime
|
sleep.startTime | string |
Hora em que o log de suspensão começa |
|
timeInBed
|
sleep.timeInBed | integer |
Número total de minutos em que o usuário estava na cama |
|
tipo
|
sleep.type | string |
clássico | Estágios |
Obter meta de suspensão
Especifique a ID codificada do usuário. Use "-" (traço) para o usuário conectado atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
flowId
|
consistency.flowId | integer |
0 = Uma meta de suspensão é definida, mas não há logs de suspensão suficientes registrados. 1 = O usuário perdeu a meta de suspensão ou nenhuma meta foi definida, mas há logs de suspensão suficientes registrados. 2 = Uma meta de suspensão não está definida e não há logs de suspensão suficientes registrados. 3 = O usuário atingiu sua meta de suspensão |
|
minDuration
|
goal.minDuration | integer |
Comprimento do período de meta de suspensão em minutos. |
|
updatedOn
|
goal.updatedOn | string |
O carimbo de data/hora em que a meta foi criada/atualizada. |
Obter metas de atividade
Recupera as metas atuais de atividade diária ou semanal de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Período
|
period | True | string |
diariamente| semanalmente |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
activeMinutes
|
goals.activeMinutes | integer |
Meta diária de minutos ativos. Um valor não é retornado para metas semanais. |
|
activeZoneMinutes
|
goals.activeZoneMinutes | integer |
Meta de minutos de zona ativa diária ou semanal. |
|
caloriesOut
|
goals.caloriesOut | integer |
Calorias diárias queimavam meta. Um valor não é retornado para metas semanais. |
|
distance
|
goals.distance | float |
Meta de distância diária ou semanal. |
|
Pisos
|
goals.floors | integer |
Andares diários ou semanais subiram a meta. |
|
etapas
|
goals.steps | integer |
Etapas diárias ou semanais tomadas meta. |
Obter metas de corpo
Recupera as metas de peso e gordura corporal de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Tipo de meta
|
goal-type | True | string |
Tipo de meta |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
goalType
|
goal.goalType | string | |
|
startDate
|
goal.startDate | string |
A data de início da meta. |
|
startWeight
|
goal.startWeight | float |
Peso do usuário quando a meta foi estabelecida. |
|
peso
|
goal.weight | float |
A meta de peso a ser alcançada. |
|
weightThreshold
|
goal.weightThreshold | float |
A quantidade recomendada de peso a perder a cada semana para alcançar e manter a meta. |
Obter o Placar de Líderes de Amigos
Esse ponto de extremidade retorna o placar de líderes de amigos do usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object |
dados |
|
tipo
|
data.type | string |
tipo |
|
id
|
data.id | string |
id |
|
step-rank
|
data.attributes.step-rank | integer |
Classificação entre os amigos do usuário. |
|
step-summary
|
data.attributes.step-summary | integer |
Contagem semanal de etapas. |
|
tipo
|
data.relationships.user.data.type | string |
tipo |
|
id
|
data.relationships.user.data.id | string |
id |
|
incluído
|
included | array of object |
incluído |
|
tipo
|
included.type | string |
tipo |
|
id
|
included.id | string |
id |
|
Avatar
|
included.attributes.avatar | string |
Link para a imagem de avatar do usuário. |
|
filho
|
included.attributes.child | boolean |
filho |
|
amigo
|
included.attributes.friend | boolean |
amigo |
|
nome
|
included.attributes.name | string |
nome |
Obter perfil
Recupera os dados do perfil do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
aboutMe
|
user.aboutMe | string |
As informações "Sobre mim" especificadas nas configurações da conta do usuário. |
|
idade
|
user.age | string |
A idade com base no aniversário especificado nas configurações da conta do usuário. |
|
embaixador
|
user.ambassador | string |
embaixador |
|
autoStrideEnabled
|
user.autoStrideEnabled | string |
autoStrideEnabled |
|
Avatar
|
user.avatar | string |
Avatar |
|
avatar150
|
user.avatar150 | string |
avatar150 |
|
avatar640
|
user.avatar640 | string |
avatar640 |
|
averageDailySteps
|
user.averageDailySteps | string |
Média de etapas diárias calculadas para o usuário. |
|
challengesBeta
|
user.challengesBeta | string |
challengesBeta |
|
clockTimeDisplayFormat
|
user.clockTimeDisplayFormat | string |
clockTimeDisplayFormat |
|
country
|
user.country | string |
country |
|
corporativo
|
user.corporate | string |
corporativo |
|
corporateAdmin
|
user.corporateAdmin | string |
corporateAdmin |
|
dateOfBirth
|
user.dateOfBirth | string |
dateOfBirth |
|
nome de exibição
|
user.displayName | string |
nome de exibição |
|
displayNameSetting
|
user.displayNameSetting | string |
displayNameSetting |
|
distanceUnit
|
user.distanceUnit | string |
distanceUnit |
|
encodedId
|
user.encodedId | string |
encodedId |
|
exerciseGoal
|
user.features.exerciseGoal | string |
exerciseGoal |
|
primeiro nome
|
user.firstName | string |
primeiro nome |
|
foodsLocale
|
user.foodsLocale | string |
foodsLocale |
|
fullName
|
user.fullName | string |
fullName |
|
gender
|
user.gender | string |
gender |
|
glucoseUnit
|
user.glucoseUnit | string |
glucoseUnit |
|
height
|
user.height | string |
O valor de altura especificado nas configurações da conta do usuário. |
|
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 |
|
sobrenome
|
user.lastName | string |
sobrenome |
|
legalTermsAcceptRequired
|
user.legalTermsAcceptRequired | string |
legalTermsAcceptRequired |
|
localidade
|
user.locale | string |
localidade |
|
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 |
|
estado
|
user.state | string |
estado |
|
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 |
Uma matriz que lista os selos do Fitbit atualmente obtidos pelo usuário. |
|
waterUnit
|
user.waterUnit | string |
waterUnit |
|
waterUnitName
|
user.waterUnitName | string |
waterUnitName |
|
peso
|
user.weight | string |
peso |
|
weightUnit
|
user.weightUnit | string |
weightUnit |
Obter resumo da taxa de respiração por data
Esse ponto de extremidade retorna dados médios de taxa de respiração para uma única data. Os dados de Taxa de Respiração se aplicam especificamente ao "sono principal" de um usuário, que é o período de tempo mais longo durante o qual eles estavam dormindo em uma determinada data.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato yyyyy-mm-dd ou hoje. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Br
|
br | array of object |
Br |
|
breathingRate
|
br.value.breathingRate | float |
O número médio de respirações tomadas por minuto. |
|
data e hora
|
br.dateTime | string |
A data de log de suspensão especificada no formato YYYY-MM-DD. |
Obter resumo de atividades diárias
Recupera um resumo e uma lista de atividades e entradas de log de atividades de um usuário para um determinado dia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
Date |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
activities
|
activities | array of |
activities |
|
activeMinutes
|
goals.activeMinutes | integer |
activeMinutes |
|
caloriesOut
|
goals.caloriesOut | integer |
caloriesOut |
|
distance
|
goals.distance | float |
distance |
|
Pisos
|
goals.floors | integer |
Pisos |
|
etapas
|
goals.steps | integer |
etapas |
|
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 |
|
nome
|
summary.customHeartRateZones.name | string |
nome |
|
Distâncias
|
summary.distances | array of object |
Distâncias |
|
atividade
|
summary.distances.activity | string |
<nome> da atividade | total | tracker | loggedActivities | veryActive | moderatelyActive | lightlyActive | sedentaryActive |
|
distance
|
summary.distances.distance | integer |
Para o recurso especificado, a distância percorrida para o dia exibido nas unidades definidas pelo cabeçalho Accept-Language. |
|
elevação
|
summary.elevation | integer |
A elevação percorrida para o dia exibido nas unidades definidas pelo cabeçalho Accept-Language. |
|
fairlyActiveMinutes
|
summary.fairlyActiveMinutes | integer |
Total de minutos em que o usuário estava bastante/moderadamente ativo. |
|
Pisos
|
summary.floors | integer |
Os andares equivalentes subiram para o dia exibido nas unidades definidas pelo cabeçalho 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 |
|
nome
|
summary.heartRateZones.name | string |
O escopo da freqüência cardíaca é necessário para ver esse valor. Fora do intervalo | Queima de Gordura | Cardio | Pico |
|
lightlyActiveMinutes
|
summary.lightlyActiveMinutes | integer |
Total de minutos em que o usuário estava levemente ativo. |
|
marginalCalories
|
summary.marginalCalories | integer |
Total de calorias marginais estimadas queimadas por dia. |
|
restingHeartRate
|
summary.restingHeartRate | integer |
O escopo da Freqüência Cardíaca é necessário para ver esse valor. |
|
sedentaryMinutes
|
summary.sedentaryMinutes | integer |
Total de minutos em que o usuário foi sedentário. |
|
etapas
|
summary.steps | integer |
Total de etapas tomadas para o dia. |
|
useEstimation
|
summary.useEstimation | boolean |
Valor booliano informando se as estimativas são usadas em cálculos. |
|
veryActiveMinutes
|
summary.veryActiveMinutes | integer |
Total de minutos em que o usuário estava muito ativo. |
Obter resumo do HRV por data
Esse ponto de extremidade retorna os dados de HRV (Variabilidade da Freqüência Cardíaca) para uma única data
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato yyyy-MM-dd ou hoje. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
hrv
|
hrv | array of object |
hrv |
|
dailyRmssd
|
hrv.value.dailyRmssd | float |
O quadrado médio raiz de diferenças sucessivas (RMSSD) entre batidas cardíacas. Ele mede a variabilidade de curto prazo na freqüência cardíaca diária do usuário em milissegundos (ms). |
|
deepRmssd
|
hrv.value.deepRmssd | float |
O quadrado médio raiz de diferenças sucessivas (RMSSD) entre batidas cardíacas. Ele mede a variabilidade de curto prazo na freqüência cardíaca do usuário enquanto está em sono profundo, em milissegundos (ms). |
|
data e hora
|
hrv.dateTime | string |
A data de log de suspensão especificada no formato YYYY-MM-DD. |
Obter resumo máximo de VO2 por data
Retorna os dados de Pontuação de Aptidão Cardio (também conhecido como VO2 Max) para uma única data. Os valores máximos de VO2 serão mostrados como um intervalo se nenhum dado de execução estiver disponível ou um único valor numérico se o usuário usar um GPS para execuções. Consulte Informações Adicionais para obter mais contexto.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato yyyyy-mm-dd ou hoje. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
cardioScore
|
cardioScore | array of object |
cardioScore |
|
data e hora
|
cardioScore.dateTime | string |
A data especificada no formato YYYY-MM-DD. |
|
vo2Max
|
cardioScore.value.vo2Max | string |
O valor exibivel de VO2 Max em mL/kg/min |
Obter selos
Recupera uma lista de selos do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Emblemas
|
badges | array of object |
Emblemas |
|
badgeGradientEndColor
|
badges.badgeGradientEndColor | string |
badgeGradientEndColor |
|
badgeGradientStartColor
|
badges.badgeGradientStartColor | string |
badgeGradientStartColor |
|
badgeType
|
badges.badgeType | string |
Tipo de selo recebido. |
|
categoria
|
badges.category | string |
categoria |
|
obrigada
|
badges.cheers | array of |
obrigada |
|
data e hora
|
badges.dateTime | string |
Data em que o selo foi alcançado. |
|
descrição
|
badges.description | string |
descrição |
|
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 |
|
nome
|
badges.name | string |
nome |
|
shareImage640px
|
badges.shareImage640px | string |
shareImage640px |
|
shareText
|
badges.shareText | string |
shareText |
|
Descrição Curta
|
badges.shortDescription | string |
Descrição Curta |
|
shortName
|
badges.shortName | string |
shortName |
|
timesAchieved
|
badges.timesAchieved | integer |
Número de vezes que o usuário atingiu o selo. |
|
value
|
badges.value | integer |
A meta de selo na medida da unidade. |
Obter série de tempo de gordura corporal por data
Recupera uma lista de entradas de log de gordura corporal de todos os usuários por um determinado período.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data de término do período especificado no formato yyyy-mm-dd ou hoje. |
|
Período
|
period | True | string |
O intervalo para o qual os dados serão retornados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
gordura
|
fat | array of object |
gordura |
|
date
|
fat.date | string |
A data em que o log de gordura do corpo foi registrado. |
|
gordura
|
fat.fat | float |
A porcentagem de gordura corporal. |
|
logId
|
fat.logId | integer |
A ID do log de gordura do corpo. |
|
fonte
|
fat.source | string |
O local em que os dados de gordura corporal se originaram. Consulte valores de "origem" para obter mais informações. |
|
time
|
fat.time | string |
O carimbo de data/hora quando o log de gordura do corpo foi registrado. |
Obter série temporal da atividade por data
Recupera os dados de atividade de um determinado recurso durante um período de tempo especificando um período de data e hora. A resposta incluirá apenas os valores de resumo diários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Resource
|
resource | True | string |
O recurso dos dados a serem retornados. |
|
Date
|
date | True | string |
A data de término do período especificado no formato yyyy-mm-dd |
|
Período
|
period | True | string |
O intervalo para o qual os dados serão retornados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
etapas de atividades
|
activities-steps | array of object |
etapas de atividades |
|
data e hora
|
activities-steps.dateTime | string |
data e hora |
|
value
|
activities-steps.value | string |
value |
Obter série temporal de peso por data
Recupera uma lista de entradas de log de peso de todos os usuários por um determinado período.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data de término do período especificado no formato yyyy-mm-dd ou hoje. |
|
Período
|
period | True | string |
O intervalo para o qual os dados serão retornados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
peso
|
weight | array of object |
peso |
|
Imc
|
weight.bmi | float |
IMC calculado no formato X.XX. |
|
date
|
weight.date | string |
Data de entrada de log no formato yyyy-mm-dd. |
|
gordura
|
weight.fat | integer |
A porcentagem de gordura corporal. |
|
logId
|
weight.logId | integer |
As IDs do log de peso. Ele é exclusivo para o usuário, mas não globalmente exclusivo. |
|
fonte
|
weight.source | string |
A origem do log de peso. |
|
time
|
weight.time | string |
Hora da medida; horas e minutos no formato HH:mm:ss, definido como o último segundo do dia, se não for fornecido. |
|
peso
|
weight.weight | integer |
Peso no formato X.XX, no sistema de unidade que corresponde ao cabeçalho Accept-Language fornecido ou se não for fornecido na métrica. |
Obter série temporal do corpo por data
Recupera uma lista do imc, da gordura corporal ou do peso de todo o usuário por um determinado período.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
Resource
|
resource | True | string |
O recurso do corpo a ser retornado. |
|
Date
|
date | True | string |
A data de término do período especificado no formato yyyy-mm-dd ou hoje. |
|
Período
|
period | True | string |
O intervalo para o qual os dados serão retornados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
peso do corpo
|
body-weight | array of object |
peso do corpo |
|
data e hora
|
body-weight.dateTime | string |
data e hora |
|
value
|
body-weight.value | string |
value |
Obter tipo de atividade
Recupera os detalhes de uma única atividade do banco de dados de atividades do Fitbit no formato solicitado. Se disponível, os detalhes do nível de atividade serão exibidos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
|
ID da atividade
|
activity-id | True | string |
ID da atividade |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
accessLevel
|
activity.accessLevel | string |
PUBLIC | PRIVADO |
|
activityLevels
|
activity.activityLevels | array of object |
activityLevels |
|
id
|
activity.activityLevels.id | integer |
Valor numérico que representa o nível de atividade correspondente. |
|
maxSpeedMPH
|
activity.activityLevels.maxSpeedMPH | float |
Velocidade máxima em MPH. Valor: -1 significa não aplicável. |
|
Mets
|
activity.activityLevels.mets | integer |
Pontuação de METs para a ID da atividade. |
|
minSpeedMPH
|
activity.activityLevels.minSpeedMPH | integer |
Velocidade mínima em MPH. Valor: -1 significa não aplicável. |
|
nome
|
activity.activityLevels.name | string |
Nome do nível de atividade. |
|
hasSpeed
|
activity.hasSpeed | boolean |
true | falso |
|
id
|
activity.id | integer |
Valor numérico que representa a atividade correspondente. |
|
nome
|
activity.name | string |
O nome da atividade ou exercício. |
Obter tipos de atividade recentes
Recupera uma lista dos tipos de atividades recentes de um usuário registrados com alguns detalhes do último log de atividades desse tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
user-id | True | string |
A ID codificada do usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
A ID numérica para a atividade ou exercício. |
|
Calorias
|
calories | integer |
Número de calorias queimadas durante a atividade registrada. |
|
descrição
|
description | string |
Informações, se disponíveis, sobre a atividade ou exercício. |
|
distance
|
distance | integer |
Distância percorrida durante a atividade registrada. |
|
duration
|
duration | integer |
Tempo (milissegundos) para concluir a atividade registrada. |
|
nome
|
name | string |
O nome da atividade ou exercício. |
Obter todos os tipos de atividade
Recupera uma lista de todas as atividades públicas válidas do Fitbit e as atividades privadas criadas pelo usuário do banco de dados de atividades do Fitbit no formato solicitado. Se disponível, os detalhes do nível de atividade serão exibidos.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categories
|
categories | array of object |
categories |
|
activities
|
categories.activities | array of object |
activities |
|
accessLevel
|
categories.activities.accessLevel | string |
accessLevel |
|
activityLevels
|
categories.activities.activityLevels | array of object |
activityLevels |
|
id
|
categories.activities.activityLevels.id | integer |
id |
|
maxSpeedMPH
|
categories.activities.activityLevels.maxSpeedMPH | integer |
maxSpeedMPH |
|
Mets
|
categories.activities.activityLevels.mets | integer |
Mets |
|
minSpeedMPH
|
categories.activities.activityLevels.minSpeedMPH | integer |
minSpeedMPH |
|
nome
|
categories.activities.activityLevels.name | string |
nome |
|
hasSpeed
|
categories.activities.hasSpeed | boolean |
hasSpeed |
|
id
|
categories.activities.id | integer |
id |
|
nome
|
categories.activities.name | string |
nome |
|
Mets
|
categories.activities.mets | float |
Mets |