FitBaus Public API

公开只读健康数据 API

面向其他项目复用 Fitbit 本地缓存数据。接口按版本路径输出，分成完整缓存数据集、轻量趋势序列、公开仪表盘摘要和可直接嵌入的 SVG 图表，不开放创建、授权、删除等管理操作。

http://fitbit.lucius7.dev/api/public/v1
版本

当前公开版本

路径固定在 /api/public/v1，方便其他项目稳定集成。

示例档案

Lucius7

所有示例链接都基于当前可公开访问的首个档案生成。

输出类型

JSON + SVG

既可以拿结构化数据，也可以直接嵌入趋势图资源。

OpenAPI JSON Markdown 文档
Quick Start

推荐从这里开始

如果你是第一次接入，先拿公开档案列表，再读某个档案的 catalog 或 dashboard。这样能最快确认你的项目需要哪个数据域，再决定是否读取完整数据集或轻量趋势。

Step 1

列出公开档案

先拿所有可公开读取的 profile，再决定用哪个档案做集成。

GET http://fitbit.lucius7.dev/api/public/v1/profiles
Step 2

读取结构化数据地图

先用 catalog 看睡眠、活动、恢复、体征、生活和账户各自的数据状态。

GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/catalog
Step 3

切到轻量趋势接口

前端图表或其他服务只需要少量时间序列时，改用 series 或 SVG。

GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/series/daily?metrics=sleep_score,steps,hrv&limit=30
Resource Layers

资源分层

接口按“数据地图、完整缓存、轻量趋势、摘要卡片、表格、快照、图表”分层。这样其他项目可以先确认数据域状态，再按体积和场景选择。

Dashboard

完整公开仪表盘

适合复用 FitBaus 中文健康页的数据结构，包含 overview、coverage、stats、charts、tables。

Catalog

结构化数据地图

/catalog 按健康数据域返回状态、覆盖、核心指标和来源，适合先做接入判断。

Datasets / Series

缓存与趋势双模式

/datasets 取结构化缓存，/series 取轻量时间序列，两者职责明确。

Snapshot / SVG

快照和图形资源

/snapshot 用来复用 Fitbit 元数据，/charts/*.svg 适合直接嵌入页面或报告。

只读公开接口 JSON 统一版本化路径 快照已净化，不含 token 元数据
Endpoint Groups

端点分组

布局按最常用的调用路径重新整理，不再只靠几块示例卡片展示。每组给出主入口和用途，方便你快速定位到正确层级。

Profiles & Dashboard

档案与公开仪表盘

  • GET http://fitbit.lucius7.dev/api/public/v1返回 API 索引和公开文档链接。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles返回公开档案列表和快捷链接。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7返回单个公开档案的概要信息、覆盖范围和可调用链接。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/catalog返回按数据域整理的 catalog，适合先看结构和质量。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/dashboard返回完整公开 dashboard 数据，适合页面复用。
Datasets

完整缓存数据集

  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/datasets列出所有可用 dataset。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/datasets/activity?limit=120读取活动历史缓存。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/datasets/sleep?limit=120读取睡眠历史缓存。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/datasets/daily?limit=90读取服务端聚合后的日趋势数据。
Series & Sections

轻量趋势与摘要结构

  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/series/daily?metrics=sleep_score,steps,hrv&limit=30返回轻量级日趋势序列。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/sections返回 body、vitals、lifestyle、account 摘要卡片。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/tables返回 sleep、activity、devices 等表格结构。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/metrics返回页面指标卡和趋势信息。
Snapshot & Charts

快照缓存与 SVG 图表

  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/snapshot返回净化后的 Fitbit 快照缓存。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/snapshot/endpoints/profile读取某个 Fitbit 快照端点。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/charts/overview-trend.svg直接返回预置趋势图 SVG。
  • GET http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/charts/series.svg?granularity=daily&metrics=sleep_score,hrv,rhr&limit=30按粒度和指标自定义轻量 SVG 走势。
Parameters

常用参数

趋势、数据集和 SVG 图都支持轻量参数控制。这里单独列出来，避免你在文档正文里来回找。

Series / Datasets
  • limit：取最后 N 条记录，适合前端图表按窗口加载。
  • offset：分页读取完整 dataset 或 tables。
  • metrics：逗号分隔的指标列表，只返回需要的时间序列列。
  • granularity：支持 daily、weekly、monthly。
SVG Charts
  • width / height：控制 SVG 尺寸，适合嵌入不同容器。
  • theme：支持 light 与 transparent。
  • metrics：多指标会单独归一化，用来比较趋势形状而不是绝对值。
  • limit：建议前端图表默认取 14 / 30 / 90 等固定窗口。
Examples

调用示例

给其他前端项目或服务端脚本接入时，最常用的通常就是这几类：公开档案、完整 dashboard、轻量 series、完整 dataset 和 SVG 图表。

Profiles / Dashboard
curl "http://fitbit.lucius7.dev/api/public/v1/profiles"

curl "http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/dashboard"
Series / Datasets / Snapshot
curl "http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/series/daily?metrics=sleep_score,steps,hrv&limit=30"

curl "http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/datasets/activity?limit=120"
curl "http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/snapshot/endpoints/profile"
SVG Charts
curl "http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/charts/overview-trend.svg"

curl "http://fitbit.lucius7.dev/api/public/v1/profiles/Lucius7/charts/series.svg?granularity=daily&metrics=sleep_score,hrv,rhr&limit=30"
Docs
GET http://fitbit.lucius7.dev/api/public/v1/openapi.json
GET http://fitbit.lucius7.dev/api/public/v1/docs.md
说明：如果你的目标是“尽快把数据接到别的项目里”，优先从 /profiles → /dashboard 或 /series 开始；如果你需要完全可控的数据结构，再切到 /datasets 和 /tables。