Fitbit (Editora Independente) (Pré-visualização)
Uma maneira de acessar a API Web Fitbit
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 | |
|---|---|
| Editora | Ashwin Ganesh Kumar |
| Sítio Web | https://dev.fitbit.com// |
| Política de privacidade | https://www.fitbit.com/global/nl/legal/privacy-policy |
| Categorias | Data |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Obtenha atividades favoritas |
Recupera uma lista das atividades favoritas de um usuário. |
| Obtenha atividades frequentes |
Recupera uma lista das atividades frequentes de um usuário. |
| Obtenha estatísticas vitalícias |
Recupera as estatísticas de atividade do usuário. |
| Obter alarmes |
Recupera os alarmes ativados para um dispositivo específico. |
| Obter atividade TCX |
O Centro de Treinamento XML (TCX) é um formato de troca de dados que contém GPS, frequência cardíaca e dados de volta. Este ponto de extremidade recupera os detalhes da localização de um usuário usando GPS e dados de frequência cardíaca durante um exercício registrado. |
| Obter dispositivos |
Recupera uma lista de dispositivos Fitbit emparelhados à conta de um usuário. |
| Obter emblemas |
Recupera uma lista de selos do usuário. |
| Obter Gordura Corporal Série Temporal por Data |
Recupera uma lista de todas as entradas de log de gordura corporal do usuário para um determinado período. |
| Obter lista de log de suspensão |
Retorna uma lista das entradas do log de suspensão de um usuário antes ou depois de uma determinada data |
| Obter lista de registro de atividades |
Recupera uma lista de entradas do log de atividades de um usuário antes ou depois de um determinado dia. |
| Obter Log de Gordura Corporal |
Recupera uma lista de todas as entradas de log de gordura corporal do usuário para uma determinada data. |
| Obter log de suspensão por intervalo de datas |
Retorna uma lista das entradas do log de suspensão de um usuário para um intervalo de datas. |
| Obter Meta de Sono |
Especifique o ID codificado do usuário. Use "-" (traço) para o usuário conectado atual. |
| Obter Metas Corporais |
Recupera os objetivos de gordura corporal e peso de um usuário. |
| Obter Objetivos de Atividade |
Recupera as metas atuais de atividades diárias ou semanais de um usuário. |
| Obter perfil |
Recupera os dados de perfil do usuário. |
| Obter registro de peso |
Recupera uma lista de todas as entradas de log de peso do usuário para uma determinada data. |
| Obter registro de sono por data |
Retorna uma lista de entradas do log de suspensão de um usuário para uma determinada data |
| Obter Resumo da Atividade Diária |
Recupera um resumo e uma lista das atividades e entradas do log de atividades de um usuário para um determinado dia. |
| Obter Resumo da Frequência Respiratória por Data |
Este parâmetro de avaliação devolve dados de frequência respiratória média para uma única data. Os dados da Frequência Respiratória aplicam-se especificamente ao "sono principal" de um utilizador, que é o período de tempo mais longo durante o qual esteve a dormir numa determinada data. |
| Obter Resumo HRV por Data |
Este ponto de extremidade retorna os dados de Variabilidade da Frequência Cardíaca (VFC) para uma única data |
| Obter Série Temporal de Peso por Data |
Recupera uma lista de todas as entradas do log de peso do usuário para um determinado período. |
| Obter séries cronológicas de atividade por data |
Recupera os dados de atividade de um determinado recurso durante um período de tempo, especificando uma data e um período de tempo. A resposta incluirá apenas os valores do resumo diário. |
| Obter séries temporais corporais por data |
Recupera uma lista de todos os imc, gordura corporal ou peso do usuário por um determinado período. |
| Obter tipo de atividade |
Recupera os detalhes de uma única atividade do banco de dados de atividades 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 VO2 Max Summary por Data |
Devolve os dados do Cardio Fitness Score (também conhecido como VO2 Max) para uma única data. Os valores VO2 Max 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 mais contexto. |
| Tabela de Líderes Obter Amigos |
Este ponto de extremidade retorna a tabela de classificação de amigos do usuário |
Obtenha atividades favoritas
Recupera uma lista das atividades favoritas de um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
O número identificador da atividade registada. |
|
descrição
|
description | string |
Informações adicionais sobre a atividade registrada. |
|
Mets
|
mets | integer |
O equivalente metabólico (METs) da atividade realizada. |
|
nome
|
name | string |
O nome da atividade registrada. |
Obtenha atividades frequentes
Recupera uma lista das atividades frequentes de um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
O número identificador da atividade registada. |
|
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 registada. |
|
duration
|
duration | integer |
A duração no tempo (milissegundos) após a edição do exercício. Este valor conterá pausas durante o exercício. |
|
nome
|
name | string |
O nome da atividade registrada. |
Obtenha estatísticas vitalícias
Recupera as estatísticas de atividade do usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
date
|
best.total.distance.date | string |
date |
|
valor
|
best.total.distance.value | float |
valor |
|
date
|
best.total.floors.date | string |
date |
|
valor
|
best.total.floors.value | float |
valor |
|
date
|
best.total.steps.date | string |
date |
|
valor
|
best.total.steps.value | integer |
valor |
|
date
|
best.tracker.distance.date | string |
date |
|
valor
|
best.tracker.distance.value | float |
valor |
|
date
|
best.tracker.floors.date | string |
date |
|
valor
|
best.tracker.floors.value | float |
valor |
|
date
|
best.tracker.steps.date | string |
date |
|
valor
|
best.tracker.steps.value | integer |
valor |
|
activeScore
|
lifetime.total.activeScore | integer |
activeScore |
|
caloriasOut
|
lifetime.total.caloriesOut | integer |
caloriasOut |
|
distance
|
lifetime.total.distance | float |
distance |
|
pavimentos
|
lifetime.total.floors | integer |
pavimentos |
|
steps
|
lifetime.total.steps | integer |
steps |
|
activeScore
|
lifetime.tracker.activeScore | integer |
activeScore |
|
caloriasOut
|
lifetime.tracker.caloriesOut | integer |
caloriasOut |
|
distance
|
lifetime.tracker.distance | float |
distance |
|
pavimentos
|
lifetime.tracker.floors | integer |
pavimentos |
|
steps
|
lifetime.tracker.steps | integer |
steps |
Obter alarmes
Recupera os alarmes ativados para um dispositivo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
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. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
rastreadorAlarmes
|
trackerAlarms | array of object |
rastreadorAlarmes |
|
Id de alarme
|
trackerAlarms.alarmId | integer |
Valor numérico que representa o ID do alarme. |
|
Suprimido
|
trackerAlarms.deleted | boolean |
Indica se um alarme foi excluído. |
|
enabled
|
trackerAlarms.enabled | boolean |
Indica se um alarme está ativado. |
|
recorrente
|
trackerAlarms.recurring | boolean |
Indica se um alarme é recorrente. |
|
snoozeCount
|
trackerAlarms.snoozeCount | integer |
Indica o número de vezes que o alarme irá dormir. |
|
snoozeLength
|
trackerAlarms.snoozeLength | integer |
Indica o tempo, em minutos, entre os períodos de soneca. |
|
syncedToDevice
|
trackerAlarms.syncedToDevice | boolean |
verdadeiro | falso |
|
time
|
trackerAlarms.time | string |
O tempo e o deslocamento UTC para o alarme especificado. |
|
vibe
|
trackerAlarms.vibe | string |
Devolve o tipo de vibração configurada. |
|
weekDays
|
trackerAlarms.weekDays | array of string |
weekDays |
Obter atividade TCX
O Centro de Treinamento XML (TCX) é um formato de troca de dados que contém GPS, frequência cardíaca e dados de volta. Este ponto de extremidade recupera os detalhes da localização de um usuário usando GPS e dados de frequência cardíaca durante um exercício registrado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada da utilização |
|
ID de registo
|
log-id | True | string |
O ID de log da atividade. |
|
TCX parcial
|
includePartialTCX | boolean |
Inclui os pontos TCX quando os dados GPS não estão disponíveis. |
Obter dispositivos
Recupera uma lista de dispositivos Fitbit emparelhados à conta de um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
bateria
|
battery | string |
Devolve o nível da bateria do dispositivo |
|
nível de bateria
|
batteryLevel | integer |
Devolve a percentagem do nível de bateria do dispositivo. |
|
deviceVersion
|
deviceVersion | string |
O nome do produto do dispositivo. |
|
features
|
features | array of |
features |
|
id
|
id | string |
O 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 de ID Mac |
|
tipo
|
type | string |
RASTREADOR | ESCALA |
Obter emblemas
Recupera uma lista de selos do usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
crachás
|
badges | array of object |
crachás |
|
badgeGradientEndColor
|
badges.badgeGradientEndColor | string |
badgeGradientEndColor |
|
badgeGradientStartColor
|
badges.badgeGradientStartColor | string |
badgeGradientStartColor |
|
badgeType
|
badges.badgeType | string |
Tipo de crachá recebido. |
|
categoria
|
badges.category | string |
categoria |
|
aplausos
|
badges.cheers | array of |
aplausos |
|
data e hora
|
badges.dateTime | string |
Data em que o distintivo foi obtido. |
|
descrição
|
badges.description | string |
descrição |
|
earnedMessage
|
badges.earnedMessage | string |
earnedMessage |
|
encodedId
|
badges.encodedId | string |
encodedId |
|
imagem100px
|
badges.image100px | string |
imagem100px |
|
imagem125px
|
badges.image125px | string |
imagem125px |
|
imagem300px
|
badges.image300px | string |
imagem300px |
|
imagem50px
|
badges.image50px | string |
imagem50px |
|
imagem75px
|
badges.image75px | string |
imagem75px |
|
marketingDescrição
|
badges.marketingDescription | string |
marketingDescrição |
|
mobileDescrição
|
badges.mobileDescription | string |
mobileDescrição |
|
nome
|
badges.name | string |
nome |
|
shareImage640px
|
badges.shareImage640px | string |
shareImage640px |
|
shareText [en]
|
badges.shareText | string |
shareText [en] |
|
breveDescrição
|
badges.shortDescription | string |
breveDescrição |
|
shortNome
|
badges.shortName | string |
shortNome |
|
vezesAlcançado
|
badges.timesAchieved | integer |
Número de vezes que o usuário alcançou o selo. |
|
valor
|
badges.value | integer |
A meta do emblema na medida da unidade. |
Obter Gordura Corporal Série Temporal por Data
Recupera uma lista de todas as entradas de log de gordura corporal do usuário para um determinado período.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data final do período especificado no formato aaaa-mm-dd ou hoje. |
|
Período
|
period | True | string |
O intervalo para o qual os dados serão retornados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
gordura
|
fat | array of object |
gordura |
|
date
|
fat.date | string |
A data em que o log de gordura corporal foi registrado. |
|
gordura
|
fat.fat | float |
A percentagem de gordura corporal. |
|
ID de login
|
fat.logId | integer |
O log de gordura corporal Id. |
|
origem
|
fat.source | string |
O local de origem dos dados relativos à gordura corporal. Consulte os valores de "origem" para obter mais informações. |
|
time
|
fat.time | string |
O carimbo de data/hora quando o log de gordura corporal foi registrado. |
Obter lista de log de suspensão
Retorna uma lista das entradas do log de suspensão de um usuário antes ou depois de uma determinada data
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
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 (aaaa-mm-dd) |
|
|
Antes da data
|
beforeDate | string |
Antes da data em que o log de suspensão do usuário é retornado (aaaa-mm-dd) |
|
|
Ordenar
|
sort | string |
ascendente ou descendente |
|
|
Limite
|
limit | integer |
O número de logs de suspensão a serem retornados. (máx. 100) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
pós-data
|
pagination.afterDate | string |
pós-data |
|
limit
|
pagination.limit | integer |
limit |
|
next
|
pagination.next | string |
next |
|
offset
|
pagination.offset | integer |
offset |
|
anterior
|
pagination.previous | string |
anterior |
|
ordenar
|
pagination.sort | string |
ordenar |
|
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 |
|
infoCódigo
|
sleep.infoCode | integer |
infoCódigo |
|
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 |
|
ID de login
|
sleep.logId | integer |
ID de login |
|
logType
|
sleep.logType | string |
logType |
|
minutosDepoisAcordar
|
sleep.minutesAfterWakeup | integer |
minutosDepoisAcordar |
|
minutosAdormecido
|
sleep.minutesAsleep | integer |
minutosAdormecido |
|
minutosAcordado
|
sleep.minutesAwake | integer |
minutosAcordado |
|
minutosToFallAsleep
|
sleep.minutesToFallAsleep | integer |
minutosToFallAsleep |
|
startTime
|
sleep.startTime | string |
startTime |
|
timeInBed
|
sleep.timeInBed | integer |
timeInBed |
|
tipo
|
sleep.type | string |
tipo |
Obter lista de registro de atividades
Recupera uma lista de entradas do log de atividades de um usuário antes ou depois de um determinado dia.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Após a data
|
afterDate | string |
A data posterior (aaaa-mm-dd) |
|
|
Antes da data
|
beforeDate | string |
A data anterior (aaaa-mm-dd) |
|
|
Ordenar
|
sort | string |
A ordem de classificação das entradas por data. |
|
|
Limite
|
limit | integer |
O número de entradas retornadas. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
activities
|
activities | array of object |
activities |
|
activeDuration
|
activities.activeDuration | integer |
A quantidade de tempo (milissegundos) dentro de cada activityLevel. |
|
nível de atividade
|
activities.activityLevel | array of object |
nível de atividade |
|
minutes
|
activities.activityLevel.minutes | integer |
minutes |
|
nome
|
activities.activityLevel.name | string |
nome |
|
activityName
|
activities.activityName | string |
Nome do exercício registado. |
|
activityTypeId
|
activities.activityTypeId | integer |
O número identificador do activityName. |
|
Calorias
|
activities.calories | integer |
Número de calorias queimadas durante o exercício. |
|
caloriasLink
|
activities.caloriesLink | string |
Ponto de extremidade da API da Web para chamar para obter as calorias específicas queimadas para o exercício nomeado. |
|
duration
|
activities.duration | integer |
A duração no tempo (milissegundos) após a edição do exercício. Se o exercício não foi editado, a duração = originalDuration. Este valor conterá pausas durante o exercício. |
|
elevaçãoGanho
|
activities.elevationGain | float |
Elevação obtida durante o exercício. |
|
últimaModificação
|
activities.lastModified | string |
O carimbo de data/hora do exercício foi modificado pela última vez. |
|
ID de login
|
activities.logId | integer |
O identificador do registro de atividades para o exercício. |
|
logType
|
activities.logType | string |
auto_detected | manual | mobile_run | rastreador | o nome do pedido da 3ª parte |
|
Calorias
|
activities.manualValuesSpecified.calories | boolean |
Um valor booleano informando se as calorias foram fornecidas ao registrar o exercício. |
|
distance
|
activities.manualValuesSpecified.distance | boolean |
Um valor booleano que indica se a distância foi fornecida durante o registo do exercício. |
|
steps
|
activities.manualValuesSpecified.steps | boolean |
Um valor booleano informando se as etapas foram fornecidas ao registrar o exercício. |
|
originalDuração
|
activities.originalDuration | integer |
A duração inicial em tempo (milissegundos) em que o exercício foi registado. Este valor conterá pausas durante o exercício. |
|
originalStartTime
|
activities.originalStartTime | string |
A data de início inicial em que o exercício foi registado. |
|
startTime
|
activities.startTime | string |
A data de início após a edição do exercício. Se o exercício não foi editado, o startTime = originalStartTime. |
|
steps
|
activities.steps | integer |
Número de passos dados durante o exercício. |
|
tcxLink
|
activities.tcxLink | string |
URL para baixar o arquivo TCX. |
|
pós-data
|
pagination.afterDate | string |
pós-data |
|
limit
|
pagination.limit | integer |
limit |
|
next
|
pagination.next | string |
next |
|
offset
|
pagination.offset | integer |
offset |
|
anterior
|
pagination.previous | string |
anterior |
|
ordenar
|
pagination.sort | string |
ordenar |
Obter Log de Gordura Corporal
Recupera uma lista de todas as entradas de log de gordura corporal do usuário para uma determinada data.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato aaaa-mm-dd. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
gordura
|
fat | array of object |
gordura |
|
date
|
fat.date | string |
A data em que o log de gordura corporal foi registrado. |
|
gordura
|
fat.fat | integer |
A percentagem de gordura corporal. |
|
ID de login
|
fat.logId | integer |
O log de gordura corporal Id. |
|
origem
|
fat.source | string |
O local de origem dos dados relativos à gordura corporal. |
|
time
|
fat.time | string |
O carimbo de data/hora quando o log de gordura corporal foi registrado. |
Obter log de suspensão por intervalo de datas
Retorna uma lista das entradas do log de suspensão de um usuário para um intervalo de datas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Data de início
|
startDate | True | string |
A data para o primeiro log de sono a ser retornado (aaaa-mm-dd) |
|
Data de fim
|
endDate | True | string |
A data para o último log de sono a ser retornado (aaaa-mm-dd) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sleep
|
sleep | array of object |
sleep |
|
dateOfSleep
|
sleep.dateOfSleep | string |
A data em que o log de sono terminou. |
|
duration
|
sleep.duration | integer |
Duração do sono em milissegundos. |
|
eficiência
|
sleep.efficiency | integer |
Escore de eficiência do sono calculado. Esta não é a pontuação de sono disponível no aplicativo móvel. |
|
endTime
|
sleep.endTime | string |
Hora em que o log de sono terminou. |
|
infoCódigo
|
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 insuficientes sobre a frequência cardíaca. 2 = O período de sono 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 |
|
ID de login
|
sleep.logId | integer |
ID do log de suspensão. |
|
minutosDepoisAcordar
|
sleep.minutesAfterWakeup | integer |
O número total de minutos após o usuário acordar. |
|
minutosAdormecido
|
sleep.minutesAsleep | integer |
O número total de minutos em que o usuário esteve dormindo. |
|
minutosAcordado
|
sleep.minutesAwake | integer |
A soma total de minutos de "vigília" apenas. Não inclui antes de adormecer ou depois de acordar. |
|
minutosToFallAsleep
|
sleep.minutesToFallAsleep | integer |
O número total de minutos antes de o utilizador adormecer. Esse valor geralmente é 0 para logs de suspensão criados automaticamente. |
|
logType
|
sleep.logType | string |
auto_detected | Manual |
|
startTime
|
sleep.startTime | string |
Hora em que o registo de sono começa |
|
timeInBed
|
sleep.timeInBed | integer |
Número total de minutos em que o usuário esteve na cama |
|
tipo
|
sleep.type | string |
clássico | estágios |
Obter Meta de Sono
Especifique o ID codificado do usuário. Use "-" (traço) para o usuário conectado atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
flowId
|
consistency.flowId | integer |
0 = Uma meta de sono é definida, mas não há registros de sono suficientes registrados. 1 = O usuário perdeu sua meta de sono ou nenhuma meta foi definida, mas há registros de sono suficientes registrados. 2 = Uma meta de sono não está definida e não há registros de sono suficientes registrados. 3 = O usuário atingiu seu objetivo de sono |
|
minDuração
|
goal.minDuration | integer |
Duração do período de meta de sono em minutos. |
|
updatedOn
|
goal.updatedOn | string |
O carimbo de data/hora em que a meta foi criada/atualizada. |
Obter Metas Corporais
Recupera os objetivos de gordura corporal e peso de um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Tipo de objetivo
|
goal-type | True | string |
Tipo de objetivo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de golo
|
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. |
|
weight
|
goal.weight | float |
A meta de peso a alcançar. |
|
pesoLimiar
|
goal.weightThreshold | float |
A quantidade recomendada de peso a perder a cada semana para atingir e manter o objetivo. |
Obter Objetivos de Atividade
Recupera as metas atuais de atividades diárias ou semanais de um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Período
|
period | True | string |
Diariamente| semanalmente |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Minutos ativos
|
goals.activeMinutes | integer |
Meta diária de minutos ativos. Um valor não é devolvido para metas semanais. |
|
activeZoneMinutos
|
goals.activeZoneMinutes | integer |
Meta diária ou semanal de minutos ativos na zona. |
|
caloriasOut
|
goals.caloriesOut | integer |
Meta diária de calorias queimadas. Um valor não é devolvido para metas semanais. |
|
distance
|
goals.distance | float |
Meta de distância diária ou semanal. |
|
pavimentos
|
goals.floors | integer |
Pisos diários ou semanais subiram meta. |
|
steps
|
goals.steps | integer |
Passos diários ou semanais tomados meta. |
Obter perfil
Recupera os dados de perfil do usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sobreMim
|
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 |
|
médiaDailySteps
|
user.averageDailySteps | string |
Média de passos diários calculados para o utilizador. |
|
desafiosBeta
|
user.challengesBeta | string |
desafiosBeta |
|
clockTimeDisplayFormat
|
user.clockTimeDisplayFormat | string |
clockTimeDisplayFormat |
|
country
|
user.country | string |
country |
|
societário
|
user.corporate | string |
societário |
|
administrador corporativo
|
user.corporateAdmin | string |
administrador corporativo |
|
dateOfBirth
|
user.dateOfBirth | string |
dateOfBirth |
|
nome de exibição
|
user.displayName | string |
nome de exibição |
|
displayNameSetting
|
user.displayNameSetting | string |
displayNameSetting |
|
distânciaUnidade
|
user.distanceUnit | string |
distânciaUnidade |
|
encodedId
|
user.encodedId | string |
encodedId |
|
exercícioObjetivo
|
user.features.exerciseGoal | string |
exercícioObjetivo |
|
primeiroNome
|
user.firstName | string |
primeiroNome |
|
alimentosLocale
|
user.foodsLocale | string |
alimentosLocale |
|
Nome completo
|
user.fullName | string |
Nome completo |
|
Género
|
user.gender | string |
Género |
|
glucoseUnit
|
user.glucoseUnit | string |
glucoseUnit |
|
altura
|
user.height | string |
O valor de altura especificado nas configurações da conta do usuário. |
|
alturaUnidade
|
user.heightUnit | string |
alturaUnidade |
|
isBugReportEnabled
|
user.isBugReportEnabled | string |
isBugReportEnabled |
|
isCriança
|
user.isChild | string |
isCriança |
|
isCoach
|
user.isCoach | string |
isCoach |
|
idiomaLocale
|
user.languageLocale | string |
idiomaLocale |
|
sobrenome
|
user.lastName | string |
sobrenome |
|
legalTermsAcceptRequired
|
user.legalTermsAcceptRequired | string |
legalTermsAcceptRequired |
|
região
|
user.locale | string |
região |
|
membroDesde
|
user.memberSince | string |
membroDesde |
|
mfaAtivado
|
user.mfaEnabled | string |
mfaAtivado |
|
offsetFromUTCMillis
|
user.offsetFromUTCMillis | string |
offsetFromUTCMillis |
|
sdkDeveloper
|
user.sdkDeveloper | string |
sdkDeveloper |
|
sleepTracking [en]
|
user.sleepTracking | string |
sleepTracking [en] |
|
inícioDiadeSemana
|
user.startDayOfWeek | string |
inícioDiadeSemana |
|
state
|
user.state | string |
state |
|
strideLengthRunning
|
user.strideLengthRunning | string |
strideLengthRunning |
|
strideLengthRunningType
|
user.strideLengthRunningType | string |
strideLengthRunningType |
|
strideLengthCaminhada
|
user.strideLengthWalking | string |
strideLengthCaminhada |
|
strideLengthWalkingType
|
user.strideLengthWalkingType | string |
strideLengthWalkingType |
|
swimUnit
|
user.swimUnit | string |
swimUnit |
|
unidade de temperatura
|
user.temperatureUnit | string |
unidade de temperatura |
|
timezone
|
user.timezone | string |
timezone |
|
topEmblemas
|
user.topBadges | string |
Uma matriz listando os selos Fitbit atualmente ganhos pelo usuário. |
|
Unidade de água
|
user.waterUnit | string |
Unidade de água |
|
waterUnitName
|
user.waterUnitName | string |
waterUnitName |
|
weight
|
user.weight | string |
weight |
|
unidade de peso
|
user.weightUnit | string |
unidade de peso |
Obter registro de peso
Recupera uma lista de todas as entradas de log de peso do usuário para uma determinada data.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato aaaa-mm-dd |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
weight
|
weight | array of object |
weight |
|
IMC
|
weight.bmi | float |
IMC calculado no formato X.XX |
|
date
|
weight.date | string |
Data de entrada do registo no formato aaaa-mm-dd. |
|
gordura
|
weight.fat | integer | |
|
ID de login
|
weight.logId | integer |
Os IDs de log de peso são exclusivos para o usuário, mas não globalmente exclusivos. |
|
origem
|
weight.source | string |
origem |
|
time
|
weight.time | string |
Tempo da medição; horas e minutos no formato HH:mm:ss, definido para o último segundo do dia, se não for fornecido. |
|
weight
|
weight.weight | integer |
Peso no formato X.XX, no sistema de unidades que corresponde ao cabeçalho Accept-Language fornecido ou se não fornecido em métrica. |
Obter registro de sono por data
Retorna uma lista de entradas do log de suspensão de um usuário para uma determinada data
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
AAAA-MM-DD |
Devoluções
| Name | 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 |
Duração do sono em milissegundos. |
|
eficiência
|
sleep.efficiency | integer |
Escore de eficiência do sono calculado. Esta não é a pontuação de sono disponível no aplicativo móvel. |
|
endTime
|
sleep.endTime | string |
Hora em que o log de sono terminou. |
|
infoCódigo
|
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 insuficientes sobre a frequência cardíaca. 2 = O período de sono 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 |
|
ID de login
|
sleep.logId | integer |
ID do log de suspensão. |
|
minutosDepoisAcordar
|
sleep.minutesAfterWakeup | integer |
O número total de minutos após o usuário acordar. |
|
minutosAdormecido
|
sleep.minutesAsleep | integer |
O número total de minutos em que o usuário esteve dormindo. |
|
minutosAcordado
|
sleep.minutesAwake | integer |
A soma total de minutos de "vigília" apenas. Não inclui antes de adormecer ou depois de acordar. |
|
minutosToFallAsleep
|
sleep.minutesToFallAsleep | integer |
O número total de minutos antes de o utilizador adormecer. Esse valor geralmente é 0 para logs de suspensão criados automaticamente. |
|
logType
|
sleep.logType | string |
auto_detected | Manual |
|
startTime
|
sleep.startTime | string |
Hora em que o log de sono começa. |
|
timeInBed
|
sleep.timeInBed | integer |
Número total de minutos em que o usuário esteve na cama. |
|
tipo
|
sleep.type | string |
clássico | estágios |
|
Profundo
|
summary.stages.deep | integer |
Profundo |
|
luz
|
summary.stages.light | integer |
luz |
|
rem
|
summary.stages.rem | integer |
rem |
|
velório
|
summary.stages.wake | integer |
velório |
|
totalMinutosDormindo
|
summary.totalMinutesAsleep | integer |
Número total de minutos em que o usuário esteve dormindo em todos os registros de sono no registro de sono. |
|
totalSleepRecords
|
summary.totalSleepRecords | integer |
O número de registros de suspensão no log de suspensão. |
|
totalTimeInBed
|
summary.totalTimeInBed | integer |
Número total de minutos em que o usuário esteve na cama em todos os registros no registro de sono. |
Obter Resumo da Atividade Diária
Recupera um resumo e uma lista das atividades e entradas do log de atividades de um usuário para um determinado dia.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
Date |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
activities
|
activities | array of |
activities |
|
Minutos ativos
|
goals.activeMinutes | integer |
Minutos ativos |
|
caloriasOut
|
goals.caloriesOut | integer |
caloriasOut |
|
distance
|
goals.distance | float |
distance |
|
pavimentos
|
goals.floors | integer |
pavimentos |
|
steps
|
goals.steps | integer |
steps |
|
activeScore
|
summary.activeScore | integer |
activeScore |
|
atividadeCalorias
|
summary.activityCalories | integer |
atividadeCalorias |
|
calorieEstimationMu
|
summary.calorieEstimationMu | integer |
calorieEstimationMu |
|
caloriasBMR
|
summary.caloriesBMR | integer |
caloriasBMR |
|
caloriasOut
|
summary.caloriesOut | integer |
caloriasOut |
|
caloriasOutNão estimado
|
summary.caloriesOutUnestimated | integer |
caloriasOutNão estimado |
|
customHeartRateZones
|
summary.customHeartRateZones | array of object |
customHeartRateZones |
|
caloriasOut
|
summary.customHeartRateZones.caloriesOut | integer |
caloriasOut |
|
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 |
|
actividade
|
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 percorreu durante o dia exibida nas unidades definidas pelo cabeçalho Accept-Language. |
|
fairlyActiveMinutes
|
summary.fairlyActiveMinutes | integer |
Total de minutos em que o usuário foi justo/moderadamente ativo. |
|
pavimentos
|
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 |
|
caloriasOut
|
summary.heartRateZones.caloriesOut | integer |
caloriasOut |
|
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 frequência cardíaca é necessário para ver esse valor. Fora do Alcance | Queima de gordura | Cardio | Pico |
|
lightlyActiveMinutes
|
summary.lightlyActiveMinutes | integer |
Total de minutos o usuário estava levemente ativo. |
|
marginais Calorias
|
summary.marginalCalories | integer |
Total marginal estimado de calorias queimadas para o dia. |
|
repousoFrequência cardíaca
|
summary.restingHeartRate | integer |
O escopo Frequência cardíaca é necessário para ver esse valor. |
|
sedentárioMinutos
|
summary.sedentaryMinutes | integer |
Total de minutos em que o usuário foi sedentário. |
|
steps
|
summary.steps | integer |
Total de passos dados para o dia. |
|
useEstimation
|
summary.useEstimation | boolean |
Valor booleano que indica se as estimativas são utilizadas nos cálculos. |
|
veryActiveMinutes
|
summary.veryActiveMinutes | integer |
Total de minutos o usuário foi muito ativo. |
Obter Resumo da Frequência Respiratória por Data
Este parâmetro de avaliação devolve dados de frequência respiratória média para uma única data. Os dados da Frequência Respiratória aplicam-se especificamente ao "sono principal" de um utilizador, que é o período de tempo mais longo durante o qual esteve a dormir numa determinada data.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato aaaa-mm-dd ou hoje. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
br
|
br | array of object |
br |
|
respiraçãoRitmo
|
br.value.breathingRate | float |
O número médio de respirações tomadas por minuto. |
|
data e hora
|
br.dateTime | string |
A data do log de suspensão especificada no formato AAAA-MM-DD. |
Obter Resumo HRV por Data
Este ponto de extremidade retorna os dados de Variabilidade da Frequência Cardíaca (VFC) para uma única data
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato aaaa-MM-dd ou hoje. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
HRV
|
hrv | array of object |
HRV |
|
diariamenteRmssd
|
hrv.value.dailyRmssd | float |
A raiz quadrada média de diferenças sucessivas (RMSSD) entre os batimentos cardíacos. Ele mede a variabilidade a curto prazo na frequência cardíaca diária do usuário em milissegundos (ms). |
|
deepRmssd
|
hrv.value.deepRmssd | float |
A raiz quadrada média de diferenças sucessivas (RMSSD) entre os batimentos cardíacos. Ele mede a variabilidade a curto prazo na frequência cardíaca do usuário durante o sono profundo, em milissegundos (ms). |
|
data e hora
|
hrv.dateTime | string |
A data do log de suspensão especificada no formato AAAA-MM-DD. |
Obter Série Temporal de Peso por Data
Recupera uma lista de todas as entradas do log de peso do usuário para um determinado período.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data final do período especificado no formato aaaa-mm-dd ou hoje. |
|
Período
|
period | True | string |
O intervalo para o qual os dados serão retornados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
weight
|
weight | array of object |
weight |
|
IMC
|
weight.bmi | float |
IMC calculado no formato X.XX. |
|
date
|
weight.date | string |
Data de entrada do registo no formato aaaa-mm-dd. |
|
gordura
|
weight.fat | integer |
A percentagem de gordura corporal. |
|
ID de login
|
weight.logId | integer |
Os IDs do log de peso. É exclusivo para o usuário, mas não globalmente exclusivo. |
|
origem
|
weight.source | string |
A origem do log de peso. |
|
time
|
weight.time | string |
Tempo da medição; horas e minutos no formato HH:mm:ss, definido para o último segundo do dia, se não for fornecido. |
|
weight
|
weight.weight | integer |
Peso no formato X.XX, no sistema de unidades que corresponde ao cabeçalho Accept-Language fornecido ou se não fornecido em métrica. |
Obter séries cronológicas de atividade por data
Recupera os dados de atividade de um determinado recurso durante um período de tempo, especificando uma data e um período de tempo. A resposta incluirá apenas os valores do resumo diário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
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 final do período especificado no formato aaaa-mm-dd |
|
Período
|
period | True | string |
O intervalo para o qual os dados serão retornados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
atividades-etapas
|
activities-steps | array of object |
atividades-etapas |
|
data e hora
|
activities-steps.dateTime | string |
data e hora |
|
valor
|
activities-steps.value | string |
valor |
Obter séries temporais corporais por data
Recupera uma lista de todos os imc, gordura corporal ou peso do usuário por um determinado período.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Resource
|
resource | True | string |
O recurso do corpo a ser devolvido. |
|
Date
|
date | True | string |
A data final do período especificado no formato aaaa-mm-dd ou hoje. |
|
Período
|
period | True | string |
O intervalo para o qual os dados serão retornados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
peso-corpo
|
body-weight | array of object |
peso-corpo |
|
data e hora
|
body-weight.dateTime | string |
data e hora |
|
valor
|
body-weight.value | string |
valor |
Obter tipo de atividade
Recupera os detalhes de uma única atividade do banco de dados de atividades Fitbit no formato solicitado. Se disponível, os detalhes do nível de atividade serão exibidos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
ID da atividade
|
activity-id | True | string |
ID da atividade |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nível de acesso
|
activity.accessLevel | string |
PÚBLICO | PRIVADO |
|
atividadeNíveis
|
activity.activityLevels | array of object |
atividadeNíveis |
|
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 METs para o 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 |
verdadeiro | 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
activityId
|
activityId | integer |
O ID numérico da 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 gravada. |
|
duration
|
duration | integer |
Quantidade de tempo (milissegundos) para concluir a atividade gravada. |
|
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.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
categories
|
categories | array of object |
categories |
|
activities
|
categories.activities | array of object |
activities |
|
nível de acesso
|
categories.activities.accessLevel | string |
nível de acesso |
|
atividadeNíveis
|
categories.activities.activityLevels | array of object |
atividadeNíveis |
|
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 |
Obter VO2 Max Summary por Data
Devolve os dados do Cardio Fitness Score (também conhecido como VO2 Max) para uma única data. Os valores VO2 Max 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 mais contexto.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
|
Date
|
date | True | string |
A data no formato aaaa-mm-dd ou hoje. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
cardioPontuação
|
cardioScore | array of object |
cardioPontuação |
|
data e hora
|
cardioScore.dateTime | string |
A data especificada no formato AAAA-MM-DD. |
|
vo2Max
|
cardioScore.value.vo2Max | string |
O valor visível do VO2 Max em ml/kg/min |
Tabela de Líderes Obter Amigos
Este ponto de extremidade retorna a tabela de classificação de amigos do usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
user-id | True | string |
A ID codificada do usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object |
dados |
|
tipo
|
data.type | string |
tipo |
|
id
|
data.id | string |
id |
|
escalão-degrau
|
data.attributes.step-rank | integer |
Classificação entre os amigos do usuário. |
|
passo-resumo
|
data.attributes.step-summary | integer |
Contagem semanal de passos. |
|
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 do avatar do usuário. |
|
elemento subordinado
|
included.attributes.child | boolean |
elemento subordinado |
|
amigo
|
included.attributes.friend | boolean |
amigo |
|
nome
|
included.attributes.name | string |
nome |