深度链接自动化
在 iPhone 或 iPad 上打开 URL 以创建 REST API 自动化。
最后更新: 2026年10月31日
在 iPhone 或 iPad 上打开 URL 以创建 REST API 自动化。深度链接不会配置其他目标。
URL 格式
com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fhealth&name=Daily%20Export
url 为必填。请提供描述性的 name;若省略,默认为 Automation。参数名称不区分大小写。包含空格或保留字符的参数值请进行 URL 编码。
在设备上打开该 URL,或在快捷指令中使用 打开 URL。启用前请在 Health Auto Export 中检查所创建的自动化。
参数参考
布尔值接受 true/false、1/0 或 yes/no。先设置 datatype,再设置其数据专用选项;先设置 format,再设置 aggregatedata,以免后续选择覆盖先前设置。
基本设置
| 参数 | 值或含义 | 默认值 |
|---|---|---|
url |
设备可到达的端点 URL | 必填 |
name |
非空自动化名称 | Automation |
enabled |
启用自动运行 | false |
datatype |
下列数据类型 | healthMetrics |
format |
json、csv、markdown 或 md |
json |
exportversion |
v1、v2、1 或 2 |
v2 |
period |
none、lastsync、today、yesterday、previous7days |
none |
requesttimeout |
整数秒,60–86400 | 60 |
headers |
逗号分隔的键/值对 | 无 |
batchrequests |
布尔值;仅 JSON | false |
有效数据类型为 healthMetrics、workouts、symptoms、ecg、heartRateNotification、stateOfMind、cycleTracking 和 medications。心理状态需要 iOS 18 或更高版本;药物导出需要 iOS 26 或更高版本。
日期范围含义请参阅日期范围。所有深度链接都创建 REST API 自动化;没有 exportDestination 参数。
健康指标
| 参数 | 值或含义 | 默认值 |
|---|---|---|
metrics |
逗号分隔的精确指标名称,例如 Step Count,Heart Rate |
所有可用指标 |
aggregatedata |
布尔值;在支持时对单独读数使用 false |
true |
interval |
none、minutes、hours、days、weeks、months、years |
none |
aggregatesleep |
控制睡眠汇总的布尔值 | true |
metrics、aggregatedata 和 interval 适用于健康指标。选择 CSV 会打开汇总;单独读数请使用 JSON。生成链接时请明确指定所需汇总。
锻炼
| 参数 | 值或含义 | datatype=workouts 时的默认值 |
|---|---|---|
includeroutes |
布尔值 | true |
includeworkoutmetadata |
布尔值 | true |
workoutsmetadatainterval |
minutes 或 seconds;版本 2 |
minutes |
workouttypes |
逗号分隔的无符号 Apple 锻炼类型标识符 | 所有类型 |
不要在锻炼链接中包含健康指标汇总选项。
节奏与通知
| 参数 | 值或含义 | 默认值 |
|---|---|---|
syncinterval |
minutes、hours、days、weeks |
minutes |
syncquantity |
正整数间隔数 | 5 |
notifyonupdate |
布尔值;数据准备后通知 | true |
notifywhenrun |
布尔值;目标操作成功后通知 | true |
节奏仍受后台与健康数据限制约束;不是精确排程。
身份验证与编码
headers 值由交替的键和值组成:
headers=Authorization,Bearer%20YOUR_TOKEN,X-API-Key,YOUR_KEY
每个键都需要值。逗号分隔成对,因此在此链接格式中请避免标头值包含逗号。将空格编码为 %20,加号为 %2B,与号为 %26。当端点 URL 自身带有查询参数时,请对完整端点 URL 进行编码。
示例
选定指标,按小时汇总
com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fmetrics&name=Steps%20and%20Heart%20Rate&datatype=healthMetrics&format=json&metrics=Step%20Count,Heart%20Rate&aggregatedata=true&interval=hours
含路线的锻炼
com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fworkouts&name=Workout%20Export&datatype=workouts&format=json&includeroutes=true&includeworkoutmetadata=true&exportversion=v2&workoutsmetadatainterval=minutes
两个示例在您检查并启用自动化之前都会保持自动运行关闭。
故障排除
- URL 或参数错误: 从最小 URL 开始,检查拼写和编码,然后逐个添加选项。
- 无效指标: 使用精确指标名称,包括空格和大小写。
- 汇总错误: 仅在
datatype=healthMetrics时使用健康指标选项。 - 锻炼设置错误: 将锻炼选项与
datatype=workouts一起使用;按秒分组需要版本 2。 - 批处理错误: 设置
format=json或禁用batchrequests。 - 无效节奏/超时: 使用支持的间隔、正数量,以及 60 到 86400 秒的超时。
- URL 过长: 缩短指标/标头列表,或在 App 中配置其余设置。
创建后,使用 REST API — 导出历史或遗漏的数据 上传选定范围或检查设置。