Unified AI Gateway
面向前端、客户端和第三方调用方。本文档按业务 TAB 分组，包含参数字段、字段解释、请求示例、
返回 JSON 示例和返回字段说明。自动生成的 Swagger 仍保留在 /docs。
https://ai.gateway.uahpet.com本地开发常用：http://127.0.0.1:18000
Authorization: Bearer uah_xxx除 GET /health、/demo、/api-docs 外，业务接口都需要 API Key。
图片/视频生成接口先返回 task_id。客户端应按 poll_after_seconds 等待后再查询，避免触发 429。
身份字段规则：所有业务接口调用时都不需要传入 user_id 和 pet_id。服务端会使用统一临时 ID，或在选择 identity_asset_id 后自动从身份资源推导；返回 JSON 中出现的 user_id/pet_id 仅用于内部追踪和兼容展示。
{
"error": {
"code": "invalid_request",
"message": "Request validation failed.",
"request_id": "req_xxx"
}
}| 错误码 | HTTP | 说明 |
|---|---|---|
unauthorized | 401 | 缺少 API Key 或 Key 无效。 |
forbidden | 403 | Key 没有访问该接口、模型或图片/视频生成权限。 |
invalid_request | 422 | 字段缺失、类型错误、枚举值错误、上传格式错误。 |
not_found | 404 | 任务、图片、日记或身份资源不存在。 |
rate_limit_exceeded | 429 | 请求过快或超出当前 Key 限流。 |
provider_error | 502 | 上游模型服务失败。 |
服务健康检查。无需 API Key。
无。
curl https://ai.gateway.uahpet.com/health{
"status": "ok",
"service": "uah-ai-gateway",
"version": "0.3.0"
}| 字段 | 类型 | 说明 |
|---|---|---|
status | string | 服务状态，正常为 ok。 |
service | string | 服务名。 |
version | string | 服务版本。 |
查询当前 API Key 可见模型别名。
| 字段 | 位置 | 必填 | 说明 |
|---|---|---|---|
Authorization | Header | 是 | Bearer uah_xxx。 |
curl -H "Authorization: Bearer uah_xxx" \
https://ai.gateway.uahpet.com/v1/models{
"data": [
{ "id": "uah-general", "type": "text" },
{ "id": "uah-avatar", "type": "image" }
]
}| 字段 | 类型 | 说明 |
|---|---|---|
data | array | 模型列表。 |
data[].id | string | 网关模型别名，调用其他接口时使用。 |
data[].type | string | 模型类型，例如 text、image、video。 |
上传宠物照片或提供图片 URL，创建四姿态头像生成任务。兼容路径：/v1/pet-avatars/generate。
| 字段 | 位置 | 类型 | 必填 | 默认/枚举 | 说明 |
|---|---|---|---|---|---|
Authorization | Header | string | 是 | - | Bearer API Key。需要 uah-avatar 且允许图片生成；当前实现也要求 Key 具备 uah-animation 视频能力，用于后续身份资源联动。 |
source_image | Form file | file | 二选一 | - | 宠物原图文件。与 source_image_url 只能传一个，图片需满足服务端配置的最小尺寸和最大体积限制。 |
source_image_url | Form/JSON | string | 二选一 | HTTP/HTTPS | 宠物原图 URL。后端会下载图片并按上传文件相同规则校验和保存到 COS；兼容复制出的 Markdown 链接格式 [url](url)。 |
species | Form/JSON | string | 是 | dog / cat | 宠物物种，用于提示词、场景和后续日记配图库资源锁定。 |
pet_name | Form/JSON | string | 否 | - | 宠物名，长度 1-128。 |
breed | Form/JSON | string | 否 | - | 品种补充，长度 1-128。 |
pose | Form/JSON | string | 否 | all | 单姿态选择：all、lying、sitting、walking、running。 |
poses | Form repeat/JSON | string[] | 否 | - | 多姿态选择；Form 可重复传字段，JSON 传字符串数组。支持 lying、sitting、walking、running，不能重复。传了 poses 时优先于 pose。 |
locale | Form/JSON | string | 否 | en-US | 语言环境：en-US 或 zh-CN。 |
| 字段 | 枚举值 | 说明 |
|---|---|---|
species | dog / cat | 宠物物种枚举；请求和身份资源返回均使用该取值。 |
items[].species | dog / cat | 请求强校验；身份资源返回同样取值。 |
pose | all / lying / sitting / walking / running | 请求强校验；all 表示全部四姿态。 |
poses[] | lying / sitting / walking / running | 单个姿态枚举。 |
images | lying / sitting / walking / running | 单个姿态枚举。 |
items[].poses | lying / sitting / walking / running | 单个姿态枚举。 |
locale | en-US / zh-CN | 请求强校验；默认 en-US。 |
status | pending / processing / success / partial_success / failed | 头像任务状态。 |
images.*.status | pending / processing / success / failed | 单姿态生成状态。 |
identity.status | success / partial_success / animation_pending / failed | 身份资源状态；animation_pending 表示姿态图可用但动图仍未完成。 |
items[].status | string|null | 身份资源状态，例如 success、partial_success、animation_pending 或 failed。 |
items[].poses.*.animation_status | pending / processing / success / partial_success / failed / delete_failed | 关联动图任务状态，可能为空。 |
curl -X POST "https://ai.gateway.uahpet.com/v1/pet-avatar/generate" \
-H "Authorization: Bearer uah_xxx" \
-F "source_image=@pet_image.png" \
-F "species=dog" \
-F "poses=sitting" \
-F "poses=running"curl -X POST "https://ai.gateway.uahpet.com/v1/pet-avatar/generate" \
-H "Authorization: Bearer uah_xxx" \
-F "source_image_url=https://example.com/pet.png" \
-F "species=dog" \
-F "poses=all"curl -X POST "https://ai.gateway.uahpet.com/v1/pet-avatar/generate" \
-H "Authorization: Bearer uah_xxx" \
-H "Content-Type: application/json" \
-d '{
"pet_name": "yu",
"species": "cat",
"pose": "sitting",
"source_image_url": "https://example.com/pet.png",
"locale": "en-US",
"breed": "Poodle"
}'{
"request_id": "req_xxx",
"task_id": "avatar_task_xxx",
"status": "pending",
"message": "Avatar generation task created.",
"poll_after_seconds": 8
}| 字段 | 类型 | 说明 |
|---|---|---|
request_id | string | 请求 ID。 |
task_id | string | 头像任务 ID，后续查询任务使用。 |
status | string | 初始通常是 pending。 |
message | string | 任务创建说明。 |
poll_after_seconds | integer|null | 建议等待多少秒后查询任务。 |
查询头像任务。兼容路径：/v1/pet-avatars/tasks/{task_id}。
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
Authorization | Header | string | 是 | Bearer API Key，需要 uah-avatar 和图片权限。 |
task_id | Path | string | 是 | 创建任务时返回的头像任务 ID。 |
curl -H "Authorization: Bearer uah_xxx" \
"https://ai.gateway.uahpet.com/v1/pet-avatar/tasks/avatar_task_xxx"{
"request_id": "req_xxx",
"task_id": "avatar_task_xxx",
"status": "success",
"user_id": "temporary",
"pet_id": "temporary",
"provider": "apiyi",
"model": "gpt-image-2-all",
"source_cos_key": "ai-gateway/avatar/source/...",
"source_url": "https://...",
"identity_asset_id": "identity_xxx",
"images": {
"sitting": {
"status": "success",
"generated_cos_key": "ai-gateway/avatar/generated/...",
"generated_url": "https://..."
},
"running": {
"status": "failed",
"error_code": "provider_error",
"error_message": "Avatar generation failed."
}
}
}| 字段 | 类型 | 说明 |
|---|---|---|
status | string | 任务状态：pending、processing、success、partial_success、failed。 |
source_url | string | 原图可访问链接，可能是带有效期的签名 URL。 |
identity_asset_id | string|null | 头像成功后生成的宠物身份资源 ID。日记配图会用它。 |
images | object | 按姿态聚合的结果，key 为 lying/sitting/walking/running。 |
images.*.generated_url | string|null | 姿态图 URL，仅成功时返回。 |
images.*.error_code | string|null | 姿态生成失败时返回。 |
poll_after_seconds | integer|null | 任务未结束时返回，表示建议下次查询间隔。 |
分页查询宠物身份资源。
| 字段 | 位置 | 类型 | 必填 | 默认/限制 | 说明 |
|---|---|---|---|---|---|
Authorization | Header | string | 是 | - | Bearer API Key，需要 uah-avatar 和图片权限。 |
page | Query | integer | 否 | 默认 1，最小 1 | 当前页码。 |
page_size | Query | integer | 否 | 默认 20，1-100 | 每页数量。 |
curl -H "Authorization: Bearer uah_xxx" \
"https://ai.gateway.uahpet.com/v1/pet-avatars?page=1&page_size=20"{
"page": 1,
"page_size": 20,
"total": 1,
"items": [
{
"identity_asset_id": "identity_xxx",
"avatar_task_id": "avatar_task_xxx",
"animation_task_id": "anim_task_xxx",
"user_id": "temporary",
"pet_id": "temporary",
"species": "dog",
"status": "ready",
"source_url": "https://...",
"poses": {
"sitting": {
"image_url": "https://...",
"animation_status": "success",
"webp_url": "https://...",
"mp4_url": "https://..."
}
}
}
]
}| 字段 | 类型 | 说明 |
|---|---|---|
items[].identity_asset_id | string | 身份资源 ID。 |
items[].status | string | 身份资源状态，例如 ready、animation_pending。 |
items[].poses | object | 姿态资源，key 为姿态名。 |
items[].poses.*.image_url | string | 姿态静态图 URL。 |
items[].poses.*.webp_url | string|null | 关联动图 WebP URL，有动图任务成功时返回。 |
查询单个身份资源详情。
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
identity_asset_id | Path | string | 是 | 身份资源 ID。 |
curl -H "Authorization: Bearer uah_xxx" \
"https://ai.gateway.uahpet.com/v1/pet-avatars/identity_xxx"{
"identity_asset_id": "identity_xxx",
"avatar_task_id": "avatar_task_xxx",
"animation_task_id": "anim_task_xxx",
"user_id": "temporary",
"pet_id": "temporary",
"species": "dog",
"status": "ready",
"source_url": "https://...",
"poses": {
"sitting": {
"image_url": "https://...",
"animation_status": "success",
"webp_url": "https://...",
"mp4_url": "https://..."
}
}
}字段含义与列表接口的 items[] 单项一致。
Submit feedback for one or more generated pet-avatar images. Re-submitting a COS key updates its latest feedback.
{
"feedbacks": [
{"cos_key": "ai-gateway/avatars/generated/task-1/sitting.png", "liked": true, "selected": true},
{"cos_key": "ai-gateway/avatars/generated/task-2/walking.png", "liked": false, "selected": false}
]
}feedbacks | array | required | 1–100 image feedback records. |
feedbacks[].cos_key | string | required | Avatar-task generated COS key; unknown or duplicate keys are rejected. |
feedbacks[].liked | boolean | one required | Whether the user likes the image. |
feedbacks[].selected | boolean | one required | Whether the user selected the image. |
Provide liked, selected, or both. An omitted value does not overwrite an existing annotation.
{
"result": {
"code": 200,
"message": "success",
"request_id": "req_xxx"
}
}使用头像任务的姿态图生成 WebP/MP4 动图。
| 字段 | 位置 | 类型 | 必填 | 默认/枚举 | 说明 |
|---|---|---|---|---|---|
avatar_task_id | Body | string | 是 | 1-128 | 已完成或部分成功的头像任务 ID。 |
pose | Body | string | 否 | all | all、lying、sitting、walking、running。 |
| 字段 | 枚举值 | 说明 |
|---|---|---|
pose | all / lying / sitting / walking / running | 请求强校验。 |
images key | lying / sitting / walking / running | 单姿态枚举。 |
status | pending / processing / success / partial_success / failed / deleting / delete_failed | 动图任务状态。 |
images.*.status | pending / processing / success / failed | 单姿态动图状态。 |
output_formats[] | webp / mp4 | 当前输出格式。 |
{
"avatar_task_id": "avatar_task_xxx",
"pose": "all"
}{
"request_id": "req_xxx",
"task_id": "anim_task_xxx",
"status": "pending",
"message": "Animation generation task created.",
"poll_after_seconds": 15
}| 字段 | 类型 | 说明 |
|---|---|---|
task_id | string | 动图任务 ID。 |
status | string | 任务初始状态。 |
poll_after_seconds | integer | 建议查询间隔。 |
查询动图任务。
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
task_id | Path | string | 是 | 动图任务 ID。 |
{
"request_id": "req_xxx",
"task_id": "anim_task_xxx",
"avatar_task_id": "avatar_task_xxx",
"status": "success",
"user_id": "temporary",
"pet_id": "temporary",
"provider": "openrouter",
"model": "bytedance/seedance-2.0-fast",
"duration_seconds": 4,
"output_formats": ["webp", "mp4"],
"images": {
"sitting": {
"status": "success",
"mp4_cos_key": "ai-gateway/animation/generated/.../sitting/result.mp4",
"mp4_url": "https://...",
"webp_cos_key": "ai-gateway/animation/generated/.../sitting/result.webp",
"webp_url": "https://...",
"error_code": null,
"error_message": null
}
}
}| 字段 | 类型 | 说明 |
|---|---|---|
duration_seconds | integer | 生成视频时长。 |
output_formats | string[] | 输出格式，当前为 webp 和 mp4。 |
images.*.webp_cos_key | string|null | WebP 动图 COS 对象 Key，仅成功时返回；可用于后端持久引用或重新签名。 |
images.*.webp_url | string|null | WebP 动图 URL，可能是带有效期的签名 URL。 |
images.*.mp4_cos_key | string|null | MP4 视频 COS 对象 Key，仅成功时返回；可用于后端持久引用或重新签名。 |
images.*.mp4_url | string|null | MP4 视频 URL。 |
images.*.error_code | string|null | 单姿态失败时返回错误码和错误说明。 |
images.*.error_message | string|null | 单姿态失败时返回错误码和错误说明。 |
删除已完成、失败、部分成功或删除失败状态的动图任务和存储文件。
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
task_id | Path | string | 是 | 动图任务 ID。 |
204 No Content，无响应体。
从已生成图库中按日期和事实选择当天最合适的配图。
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
diary_id | Body | string|null | 否 | 关联日记 ID。 |
date | Body | date | 是 | 日记日期，格式 YYYY-MM-DD。 |
facts.species | Body | string | 是 | dog 或 cat。 |
facts.season | Body | string|null | 否 | 季节。 |
facts.weather | Body | string|null | 否 | 天气。 |
facts.location | Body | string|null | 否 | 地点。 |
facts.activity | Body | string|null | 否 | 活动。 |
facts.mood | Body | string|null | 否 | 心情。 |
facts.holiday | Body | string|null | 否 | 节日。 |
{
"date": "2026-07-01",
"facts": {
"species": "dog",
"season": "summer",
"weather": "sunny",
"activity": "walk",
"mood": "happy"
}
}{
"selection_id": "diary_sel_xxx",
"image_id": "diary_lib_img_xxx",
"generated_cos_key": "ai-gateway/diary-images/generated/...",
"scene_id": "outdoor_walk_spring",
"image_url": "https://...",
"match_reason": {
"score": 12,
"matched": ["season", "activity"]
}
}创建日记配图任务。参考图支持三种来源：传 identity_asset_id 使用已生成身份资源，传 source_image_url 使用外部图片 URL，或传 cos_key 直接复用 COS 内已有图片。三者必须且只能传一个。
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
diary_id | Body | string|null | 否 | 关联日记 ID。 |
identity_asset_id | Body | string|null | 三选一 | 宠物身份资源 ID。使用该模式时服务端自动按身份资源物种校验场景。 |
source_image_url | Body | string|null | 三选一 | HTTP/HTTPS 图片 URL。服务端会下载、校验尺寸和格式后保存到 COS，再创建任务。 |
cos_key | Body | string|null | 三选一 | 已存在图片的 COS Object Key。仅接受 ai-gateway/ 前缀且对象必须存在；服务端直接复用该图片，不下载也不复制。 |
species | Body | string | URL/COS Key 模式必填 | 宠物物种：dog 或 cat。身份资源模式以身份资源物种为准。 |
scene_ids | Body | string[] | 是 | 当前默认 V4.3 日记配图库场景 ID 数组。V3.0/V4.0/V4.1/V4.2 仍保留，可通过元数据接口 version 参数切换；单张生成也传数组，例如 ["indoor_curl_sleep"]；多张生成传多个 ID。三种参考图来源都支持。场景目录从 /v1/app-metadata/diary-image-library-scenes 获取。 |
prompt_version | Body | string|null | 否 | 日记配图提示词版本。可传短写 V4.3/V4.2/V4.1/V4.0/V3.0，也可传完整版本号；不传使用默认 V4.3。 |
force_regenerate | Body | boolean | 否 | 多场景图库生成时保留的参数，默认 false。 |
{
"identity_asset_id": "identity_xxx",
"scene_ids": ["indoor_curl_sleep"],
"prompt_version": "V4.3",
"diary_id": "dia_xxx"
}{
"source_image_url": "https://example.com/pet.png",
"species": "dog",
"scene_ids": ["indoor_curl_sleep"],
"diary_id": "dia_xxx"
}{
"cos_key": "ai-gateway/avatar/generated/temporary/avatar_task_xxx/sitting.png",
"species": "dog",
"scene_ids": ["indoor_curl_sleep", "outdoor_walk_spring"],
"prompt_version": "V4.3"
}{
"identity_asset_id": "identity_xxx",
"scene_ids": ["indoor_curl_sleep", "outdoor_walk_spring"],
"force_regenerate": false
}| 字段 | 枚举值 | 说明 |
|---|---|---|
selected_pose | lying / sitting / walking / running | 后端强校验；由场景推荐姿态决定。 |
recommended_pose | lying / sitting / walking / running | 后端强校验；由场景推荐姿态决定。 |
scene.species | all / dog / cat | 日记配图场景适用物种。 |
scene.category | common / federal_holiday / personal / species_day | 日记配图场景分类。 |
status | pending / processing / success / failed | 日记配图任务状态。 |
{
"request_id": "req_xxx",
"task_id": "diary_image_xxx",
"status": "pending",
"selected_pose": "sitting",
"poll_after_seconds": 2
}{
"request_id": "req_xxx",
"task_id": "diary_lib_xxx",
"status": "pending",
"profile": "dog",
"total_count": 2,
"poll_after_seconds": 2
}| 字段 | 类型 | 说明 |
|---|---|---|
request_id | string | 请求 ID。 |
task_id | string | 日记配图任务 ID，用于查询任务结果。 |
status | string | 初始通常为 pending。 |
selected_pose | string | 场景自动选择的参考姿态，枚举见上表。 |
poll_after_seconds | number | 建议客户端等待多少秒后查询任务。 |
查询日记配图任务。
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
task_id | Path | string | 是 | 日记配图任务 ID。 |
{
"task_id": "diary_image_xxx",
"request_id": "req_xxx",
"user_id": "temporary",
"pet_id": "temporary",
"diary_id": "dia_xxx",
"identity_asset_id": null,
"scene_id": "home_sofa",
"selected_pose": "lying",
"status": "success",
"generated_cos_key": "ai-gateway/diary-images/generated/...",
"image_id": "diary_img_xxx",
"image_url": "https://..."
}| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
task_id | string | 任务 ID 与请求追踪 ID。 | |||
request_id | string | 请求 ID。 | |||
user_id | Query | string|null | 否 | 1-128 | 用户 ID；不传时使用临时默认用户。 |
pet_id | Query | string|null | 否 | 1-128 | 宠物 ID；不传时不过滤宠物。 |
diary_id | string|null | 请求中传入的关联日记 ID。 | |||
identity_asset_id | string|null | 身份资源模式返回身份资源 ID；图片 URL 模式为 null。 | |||
scene_id | string | 日记配图场景 ID。 | |||
selected_pose | string | 自动选择的姿态。 | |||
generated_cos_key | string|null | COS 对象 Key，生成成功后返回；与 image_url 指向同一张图。 | |||
status | string | 任务状态，枚举见上表。 | |||
image_id | string|null | 生成成功后的图片 ID。 | |||
image_url | string|null | 生成成功后的图片 URL，可能是带有效期的签名 URL。 | |||
error_code | string|null | 失败时返回的错误码；成功时为空。 | |||
error_message | string|null | Error message returned on failure. | |||
poll_after_seconds | number|null | 处理中任务的建议轮询间隔；终态通常不返回。 |
GET /v1/pet-diary-images 返回分页列表，GET /v1/pet-diary-images/{image_id} 按图片 ID 查询，单项结构同上。
生成首页 AI 洞察卡片。
| 字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
request_id | string | 请求 ID。 | ||
snapshot | Body | object | 是 | 首页数据快照。 |
snapshot.pet.petId | Body | string | 否 | 宠物 ID，用于调试和追踪。 |
snapshot.pet.petName | Body | string | 否 | 宠物昵称，文案会优先使用。 |
snapshot.pet.species | Body | string | 否 | dog 或 cat。 |
snapshot.pet.breed | Body | string|null | No | Breed name. |
snapshot.pet.breedTags | Body | string[] | No | Breed tags. |
snapshot.pet.bodySize | Body | string|null | No | 体型枚举，建议与品种参考基线 body_size_class 对齐：toy=超小型、small=小型、medium=中型、large=大型、giant=超大型。 |
snapshot.pet.ageMonths | Body | number|null | No | Age in months. |
snapshot.pet.ageStage | Body | string|null | No | 生命阶段枚举，建议与品种参考基线幼年/成年/老年三档对齐：puppy=幼年、adult=成年、senior=老年；猫幼年同样传 puppy。 |
snapshot.pet.sex | Body | string|null | No | Sex. |
snapshot.pet.isNeutered | Body | boolean|null | No | Whether the pet is neutered. |
snapshot.pet.weightKg | Body | number|null | No | Weight in kg. |
snapshot.pet.healthTags | Body | string[] | 否 | 健康标签。 |
snapshot.pet.activityGoalMinutes | Body | number|null | No | Activity minutes goal. |
snapshot.pet.stepGoal | Body | number|null | No | Step goal. |
snapshot.current.locationStatus | Body | string|null | No | Current location status, such as known, unknown, or stale. |
snapshot.current.placeType | Body | string|null | No | Current place type, such as home or park. |
snapshot.current.geofenceStatus | Body | string|null | No | Safe-zone status. |
snapshot.current.outsideSafeZoneDurationMin | Body | number|null | No | Minutes outside the safe zone. |
snapshot.current.lostModeStatus | Body | string|null | No | Lost mode status. |
snapshot.current.familyCompanionStatus | Body | string|null | No | Family companion status. |
snapshot.current.connectionStatus | Body | string|null | No | Device connection status. |
snapshot.current.offlineDurationMin | Body | number|null | No | Offline duration in minutes. |
snapshot.current.wearingStatus | Body | string|null | No | Wearing status. |
snapshot.current.notWearingDurationMin | Body | number|null | No | Not-wearing duration in minutes. |
snapshot.current.batteryPct | Body | number|null | No | Battery percentage. |
snapshot.current.chargingStatus | Body | string|null | No | Charging status. |
snapshot.current.currentActivityState | Body | string|null | No | Current activity state. |
snapshot.current.currentPosture | Body | string|null | No | Current posture. |
snapshot.current.lastDeviceSyncAt | Body | datetime | 否 | 最近设备同步时间。 |
snapshot.today.wearingMinutesToday | Body | number|null | No | Wearing minutes today. |
snapshot.today.wearingCoveragePctToday | Body | number|null | No | Wearing coverage today. |
snapshot.today.activeMinutesToday | Body | number|null | No | Active minutes today. |
snapshot.today.stepsToday | Body | number|null | No | Steps today. |
snapshot.today.lowIntensityMinutesToday | Body | number|null | No | Low-intensity active minutes today. |
snapshot.today.mediumIntensityMinutesToday | Body | number|null | No | Medium-intensity active minutes today. |
snapshot.today.highIntensityMinutesToday | Body | number|null | No | High-intensity active minutes today. |
snapshot.today.outdoorMinutesToday | Body | number|null | No | Outdoor minutes today. |
snapshot.today.walkSessionCountToday | Body | number|null | No | Walk session count today. |
snapshot.today.dayRestMinutesToday | Body | number | 否 | 白天休息分钟数。 |
snapshot.today.barkCountToday | Body | number|null | No | Bark count today. |
snapshot.today.barkDurationSecToday | Body | number|null | No | Bark duration today in seconds. |
snapshot.today.barkPeakPeriodToday | Body | string|null | No | Peak barking period today. |
snapshot.today.restingHrToday | Body | number|null | No | Resting heart rate today. |
snapshot.today.restingRrToday | Body | number|null | No | Resting respiratory rate today. |
snapshot.today.hrvRestingToday | Body | number|null | No | Resting HRV today. |
snapshot.today.abnormalStillnessDurationMinToday | Body | number | 否 | 异常静止时长。 |
snapshot.completedDaily.yesterday.wearingCoveragePctYesterday | Body | number | 否 | 昨日佩戴覆盖率，0-1 小数或百分比口径需与业务约定保持一致。 |
snapshot.completedDaily.yesterday.activeMinutesYesterday | Body | number | 否 | 昨日总活动分钟数。 |
snapshot.completedDaily.yesterday.stepsYesterday | Body | number | 否 | 昨日步数。 |
snapshot.completedDaily.yesterday.highIntensityMinutesYesterday | Body | number | 否 | 昨日高强度活动分钟数。 |
snapshot.completedDaily.yesterday.outdoorMinutesYesterday | Body | number | 否 | 昨日户外活动分钟数。 |
snapshot.completedDaily.yesterday.walkSessionCountYesterday | Body | number | 否 | 昨日散步次数。 |
snapshot.completedDaily.yesterday.dayRestMinutesYesterday | Body | number | 否 | 昨日白天休息分钟数。 |
snapshot.completedDaily.yesterday.barkCountYesterday | Body | number | 否 | 昨日叫声次数。 |
snapshot.completedDaily.yesterday.barkDurationSecYesterday | Body | number | 否 | 昨日叫声总时长，单位秒。 |
snapshot.completedDaily.yesterday.barkPeakPeriodYesterday | Body | string | 否 | 昨日叫声高峰时段，例如 18:00-20:00 或业务枚举值。 |
snapshot.completedDaily.yesterday.restingHrYesterday | Body | number | 否 | 昨日静息心率，单位 bpm。 |
snapshot.completedDaily.yesterday.restingRrYesterday | Body | number | 否 | 昨日静息呼吸率，单位 breaths/min。 |
snapshot.completedDaily.yesterday.hrvRestingYesterday | Body | number | 否 | 昨日静息 HRV。 |
snapshot.completedDaily.lastNight.wearingCoveragePctLastNight | Body | number | 否 | 昨晚佩戴覆盖率，0-1 小数或百分比口径需与业务约定保持一致。 |
snapshot.completedDaily.lastNight.sleepDurationLastNight | Body | number|null | No | Last night sleep duration in minutes. |
snapshot.completedDaily.lastNight.wakeCountLastNight | Body | number|null | No | Last night wake count. |
snapshot.completedDaily.lastNight.nightActivityMinutesLastNight | Body | number|null | No | Night activity minutes last night. |
snapshot.completedDaily.lastNight.longestSleepBlockMinutesLastNight | Body | number|null | No | Longest continuous sleep block last night in minutes. |
snapshot.completedDaily.lastNight.sleepFragmentationScoreLastNight | Body | number|null | No | Sleep fragmentation score last night. |
snapshot.completedDaily.lastNight.nightBarkCountLastNight | Body | number|null | No | Night bark count last night. |
snapshot.completedDaily.lastNight.restingHrLastNight | Body | number|null | No | Resting heart rate last night. |
snapshot.completedDaily.lastNight.restingRrLastNight | Body | number|null | No | Resting respiratory rate last night. |
snapshot.completedDaily.lastNight.hrvRestingLastNight | Body | number|null | No | Resting HRV last night. |
snapshot.completedWeek.weekStartDate | Body | date | 否 | 上周统计起始日期，建议 ISO 日期格式 YYYY-MM-DD。 |
snapshot.completedWeek.weekEndDate | Body | date | 否 | 上周统计结束日期，建议 ISO 日期格式 YYYY-MM-DD。 |
snapshot.completedWeek.validDaysLastWeek | Body | number | 否 | 上周有效数据天数。 |
snapshot.completedWeek.wearingCoveragePctLastWeek | Body | number | 否 | 上周佩戴覆盖率，0-1 小数或百分比口径需与业务约定保持一致。 |
snapshot.completedWeek.activeMinutesLastWeek | Body | number | 否 | 上周总活动分钟数。 |
snapshot.completedWeek.activityGoalCompletionRateLastWeek | Body | number | 否 | 上周活动目标完成率。 |
snapshot.completedWeek.avgSleepDurationLastWeek | Body | number | 否 | 上周平均睡眠时长，单位分钟。 |
snapshot.completedWeek.avgRestingHrLastWeek | Body | number | 否 | 上周平均静息心率，单位 bpm。 |
snapshot.completedWeek.avgRestingRrLastWeek | Body | number | 否 | 上周平均静息呼吸率，单位 breaths/min。 |
snapshot.completedWeek.avgHrvRestingLastWeek | Body | number | 否 | 上周平均静息 HRV。 |
snapshot.completedWeek.barkCountLastWeek | Body | number | 否 | 上周叫声次数。 |
snapshot.completedMonth.monthStartDate | Body | date | 否 | 上月统计起始日期，建议 ISO 日期格式 YYYY-MM-DD。 |
snapshot.completedMonth.monthEndDate | Body | date | 否 | 上月统计结束日期，建议 ISO 日期格式 YYYY-MM-DD。 |
snapshot.completedMonth.validDaysLastMonth | Body | number | 否 | 上月有效数据天数。 |
snapshot.completedMonth.wearingCoveragePctLastMonth | Body | number | 否 | 上月佩戴覆盖率，0-1 小数或百分比口径需与业务约定保持一致。 |
snapshot.completedMonth.activeMinutesLastMonth | Body | number | 否 | 上月总活动分钟数。 |
snapshot.completedMonth.avgSleepDurationLastMonth | Body | number | 否 | 上月平均睡眠时长，单位分钟。 |
snapshot.completedMonth.avgRestingHrLastMonth | Body | number | 否 | 上月平均静息心率，单位 bpm。 |
snapshot.completedMonth.avgRestingRrLastMonth | Body | number | 否 | 上月平均静息呼吸率，单位 breaths/min。 |
snapshot.completedMonth.avgHrvRestingLastMonth | Body | number | 否 | 上月平均静息 HRV。 |
snapshot.completedMonth.barkCountLastMonth | Body | number | 否 | 上月叫声次数。 |
snapshot.rollingBaseline.baselineActiveMinutes | Body | object | No | Rolling baseline for active minutes; recommended fields include valueRange, source, validDays, phase, and quality. |
snapshot.rollingBaseline.baselineSleepDuration | Body | object | No | Rolling baseline for sleep duration. |
snapshot.rollingBaseline.baselineWakeCount | Body | object | No | Rolling baseline for wake count. |
snapshot.rollingBaseline.baselineRestingHr | Body | object | No | Rolling baseline for resting heart rate. |
snapshot.reference | Body | object | 否 | 预留参考信息。 |
snapshot.context.weatherToday | Body | object | 否 | 今日天气，常用字段：tempMinC、tempMaxC、currentTempC、feelsLikeC、humidityPct、condition、aqi。 |
snapshot.context.timeOfDay | Body | string|null | No | Time of day. |
snapshot.context.season | Body | string|null | No | Season. |
snapshot.context.weekdayType | Body | string|null | No | Weekday, weekend, or holiday type. |
snapshot.context.knownPlaceType | Body | string|null | No | Known place type. |
snapshot.context.ownerNearby | Body | boolean|null | No | Whether the owner is nearby. |
snapshot.quality.* | Body | string | 否 | 数据质量。常用键：wearingQualityToday、wearingQualityYesterday、wearingQualityLastNight、locationQuality、connectionQuality、activityQuality、sleepQuality、hrQuality、rrQuality、hrvQuality、barkQuality、baselineQuality、weatherQuality、profileQuality。值为 GOOD、FAIR、POOR、MISSING。 |
simulated_fields | Body | string[] | 否 | 标记哪些字段是模拟值。 |
template_id | Body | string|null | No | Template ID for testing or tracing. |
template_version | Body | string|null | No | Template version for testing or tracing. |
| 字段 | 枚举值 | 约束说明 |
|---|---|---|
snapshot.pet.species | dog / cat | 建议枚举；用于物种文案和后续业务分流。 |
snapshot.pet.bodySize | toy / small / medium / large / giant | 建议与品种参考基线 body_size_class 保持一致：toy=超小型、small=小型、medium=中型、large=大型、giant=超大型。 |
snapshot.pet.ageStage | puppy / adult / senior | 建议与基线幼年/成年/老年三档保持一致，猫幼年同样传 puppy。 |
snapshot.pet.sex | male / female / unknown | 建议枚举。 |
snapshot.current.locationStatus | known / unknown / stale | 建议枚举。 |
snapshot.current.placeType | home / park / backyard / unknown | 建议枚举；当前文案会识别 home、park、backyard。 |
snapshot.current.geofenceStatus | inside_safe_zone / outside_safe_zone / inside_forbidden_zone / unknown | 建议枚举；可选值：inside_safe_zone / outside_safe_zone / inside_forbidden_zone / unknown。 |
snapshot.current.lostModeStatus | off / on / recovered_pending_close | 建议枚举。 |
snapshot.current.familyCompanionStatus | with_member / alone / unknown | 建议枚举。 |
snapshot.current.connectionStatus | online / offline / intermittent | 建议枚举。 |
snapshot.current.wearingStatus | wearing / not_wearing / unknown | 建议枚举。 |
snapshot.current.chargingStatus | charging / not_charging / full / unknown | 建议枚举。 |
snapshot.current.currentActivityState | resting / walking / running / sleeping / active / unknown | 建议枚举；引擎还可识别 playing、eating。 |
snapshot.current.currentPosture | lying / sitting / standing / moving / unknown | 建议枚举。 |
snapshot.today.barkPeakPeriodToday | morning / afternoon / evening / night / unknown | 建议枚举。 |
snapshot.rollingBaseline.*.source | individual / species / default | 建议枚举。 |
snapshot.rollingBaseline.*.phase | cold_start / warming / established | 建议枚举。 |
snapshot.context.weatherToday.condition | sunny / rain / thunder / snow / windy / cloudy / hot / unknown | 建议枚举；hot 或高体感温度会触发环境候选。 |
snapshot.context.timeOfDay | morning / afternoon / evening / night | 建议枚举。 |
snapshot.context.season | spring / summer / autumn / winter | 建议枚举。 |
snapshot.context.weekdayType | weekday / weekend / holiday | 建议枚举。 |
snapshot.quality.* | GOOD / FAIR / POOR / MISSING | 后端强校验；所有 quality 字典值必须属于该集合。 |
card.state | P0_SAFETY / ATTENTION / DATA_QUALITY / CALM / RECOVERY | 响应强校验。 |
card.tone | urgent / attention / gentle / calm | 响应强校验。 |
card.nextAction.urgency | urgent / soon / normal | 响应强校验。 |
card.nextAction.target | safety / device / health / activity / data_quality / calm | 响应强校验。 |
card.suppressed[].reason | DEDUPED / COOLDOWN / LOWER_PRIORITY / LOW_CONFIDENCE / NOT_HOME_SURFACE / USER_DISMISSED / DATA_QUALITY_BLOCKED | 响应强校验。 |
card.destinations[].destination | health_detail / weekly_report / monthly_report / diary / device_reminder / audit | 响应强校验。 |
{
"request_id": "req_insight_001",
"snapshot": {
"pet": {
"petId": "pet-1",
"petName": "Milo",
"species": "dog",
"breed": "Labrador",
"bodySize": "large",
"ageMonths": 48,
"weightKg": 28.5,
"activityGoalMinutes": 70,
"stepGoal": 5500
},
"current": {
"placeType": "home",
"geofenceStatus": "inside_safe_zone",
"outsideSafeZoneDurationMin": 0,
"connectionStatus": "online",
"wearingStatus": "wearing",
"batteryPct": 80,
"currentActivityState": "resting",
"currentPosture": "lying"
},
"today": {
"activeMinutesToday": 70,
"stepsToday": 5200,
"restingHrToday": 86,
"barkCountToday": 8
},
"completedDaily": {
"lastNight": {
"sleepDurationLastNight": 540,
"wakeCountLastNight": 2,
"sleepFragmentationScoreLastNight": 25
}
},
"rollingBaseline": {
"baselineSleepDuration": {
"valueRange": { "low": 480, "mid": 540, "high": 660 },
"source": "individual",
"validDays": 21,
"phase": "established",
"quality": "GOOD"
}
},
"context": {
"weatherToday": {
"tempMaxC": 27,
"feelsLikeC": 25,
"condition": "sunny"
},
"timeOfDay": "afternoon",
"season": "summer",
"ownerNearby": true
},
"quality": {
"locationQuality": "GOOD",
"connectionQuality": "GOOD",
"wearingQualityToday": "GOOD",
"activityQuality": "GOOD",
"sleepQuality": "GOOD",
"hrQuality": "GOOD",
"baselineQuality": "GOOD",
"weatherQuality": "GOOD",
"profileQuality": "GOOD"
}
},
"simulated_fields": [],
"template_id": "calm_home",
"template_version": "v1"
}{
"insight_id": "insight_xxx",
"request_id": "req_insight_001",
"user_id": "temporary",
"pet_id": "temporary",
"card": {
"state": "CALM",
"text": {
"zh-CN": "Milo 今天在家休息得挺安稳，按平时来就好。",
"en-US": "Milo seems relaxed at home today, so the usual routine should be fine."
},
"nowText": {
"zh-CN": "Milo 现在在家休息，看起来挺平稳。",
"en-US": "Milo is resting at home and looks settled."
},
"recentText": {
"zh-CN": "今天没有需要优先处理的风险信号。",
"en-US": "There are no high-priority risk signals today."
},
"nextText": {
"zh-CN": "按平时来就好。",
"en-US": "The usual routine should be fine."
},
"nextAction": {
"type": "keep_routine",
"urgency": "normal",
"target": "calm",
"text": {
"zh-CN": "按平时来",
"en-US": "Use the usual routine"
},
"deepLink": null
},
"tone": "calm",
"evidence": [],
"sourceCandidateIds": [],
"suppressed": [],
"destinations": [],
"templateId": "calm_home",
"aiUsed": false,
"safetyCheckPassed": true,
"fallbackReason": null
},
"debug": {
"candidates": [],
"quality": [],
"arbitration": ["selected:calm_fallback"],
"selectedCandidateId": null,
"templateId": "calm_home"
},
"rule_version": "home-insight-v1",
"prompt_version": "home-insight-copy-v1",
"template_id": "calm_home",
"template_version": "v1",
"estimated_cost": null,
"created_at": "2026-07-01T12:00:00Z"
}| 字段 | 类型 | 说明 |
|---|---|---|
insight_id | string | 洞察 ID。 |
request_id | string | 请求 ID。 |
user_id | string | 用户 ID。 |
pet_id | string | 宠物 ID。 |
card.state | string | 首页洞察状态，例如 CALM、ATTENTION。 |
card.text | object | Main card text. |
card.nowText | object | 多语言文案。 |
card.recentText | object | 多语言文案。 |
card.nextText | object | 多语言文案。 |
card.nextAction | object|null | 建议动作。 |
card.nextAction.deepLink | string|null | 建议动作对应的 App 内跳转链接。 |
card.evidence | array | 命中规则使用的证据。 |
quality | object | 输入数据质量。 |
rule_version | string | Rule version. |
prompt_version | string|null | 本次洞察使用的提示词版本。 |
estimated_cost | number|null | 模型费用估算；纯规则生成可能为 null。 |
AI Gateway 是被动洞察服务：主服务传入已标准化的事实，Gateway 校验 Day / Week / Month 日历窗口、推导确定性规则，并仅对已验证结论进行 AI 润色。
schemaVersion：六个指标 activity、rest、hr、hrv、rr、bark 全部固定为 health-detail-v3。locale 仅支持 en-US 或 zh-CN，缺省为 en-US，响应只返回所选语言的 summary。
支持 18 种组合：activity / rest / hr / hrv / rr / bark 各自的 day、week、month。请求不接受旧版 quality、预计算偏离结论或旧字段；响应统一使用 camelCase。
查看完整 v3 字段表、18 个请求示例、校验边界和规则矩阵
# 健康详情 AI 洞察接口接入规范（主服务）
**协议版本：** `health-detail-v3`
**接口：** `POST /v1/health-detail-insights/generate`
**调用方：** 主服务（完成原始数据清洗、聚合和个人基线维护）
**服务方：** AI Gateway（校验输入、执行确定性规则并生成面向用户的洞察）
> 本文是主服务唯一的健康详情接入协议。AI Gateway 是被动服务：不会补齐原始数据、重算调用方已提供的聚合值、诊断疾病或推断确定病因。
## 1. 通用请求契约
六个指标均使用 camelCase：`activity`、`rest`、`hr`、`hrv`、`rr`、`bark`；每个指标支持 `day`、`week`、`month` 三个窗口，共 18 个请求形态。
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `schemaVersion` | string | 是 | 固定为 `health-detail-v3`。旧版本请求不兼容。 |
| `userId` | string | 是 | 主服务中的用户标识。 |
| `petId` | string | 是 | 主服务中的宠物标识。 |
| `metric` | enum | 是 | `activity`、`rest`、`hr`、`hrv`、`rr`、`bark`。 |
| `viewWindow` | enum | 是 | `day`、`week`、`month`。 |
| `locale` | enum | 否 | `zh-CN` 或 `en-US`；缺失时默认 `en-US`，只返回所选语言的 `summary`。 |
| `petProfile` | object | 是 | 宠物资料，字段见下表。 |
| `period` | object | 是 | 本地自然时间窗口，字段见下表。 |
| `metrics` | object | 是 | 当前指标和当前窗口的标准化事实；具体字段见各接口。 |
| `previousPeriod` | object | 否 | 紧邻、同类型、已完成的上一完整 Week 或 Month；仅用于改善或恶化规则。 |
### 1.1 `petProfile`
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `petProfile.name` | string | 是 | 面向用户文案使用的宠物展示名。 |
| `petProfile.species` | enum | 是 | `dog` 或 `cat`。 |
| `petProfile.activityTolerance` | enum | 否 | `low`、`medium`、`high`、`unknown`；仅用于 Activity 的解释和建议。 |
| `petProfile.heatTolerance` | enum | 否 | `low`、`medium`、`high`、`unknown`；仅用于 Activity 热暴露解释。 |
| `petProfile.coldTolerance` | enum | 否 | `low`、`medium`、`high`、`unknown`；仅用于低温解释。 |
| `petProfile.humidHeatSensitivity` | enum | 否 | `low`、`medium`、`high`、`unknown`；仅用于湿热解释。 |
| `petProfile.healthRiskTags` | array<enum> | 否 | `respiratory`、`cardiovascular`、`musculoskeletal`。只能增强已有结论的建议，不能单独触发诊断或提醒。 |
### 1.2 `period`
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `period.startDate` | string(date) | 是 | 本地日期，格式 `YYYY-MM-DD`。Day 必须等于 `endDate`；Week 必须覆盖连续 7 日；Month 必须从自然月 1 日覆盖到月末。 |
| `period.endDate` | string(date) | 是 | 本地日期，格式 `YYYY-MM-DD`。 |
| `period.timezone` | string | 是 | IANA 时区，例如 `Asia/Shanghai`；用于日期、小时数组、夜间和事件的解释。 |
| `period.isCompleted` | boolean | 是 | 窗口是否结束。`false` 时只能输出截至目前的观察，不能输出完整周期的低值、趋势或最终不足结论。 |
| `period.elapsedNights` | integer | Rest、HR、HRV、RR 的 Week/Month 必须 | 已结束、理论可观察的夜晚数；Week 范围 0-7，Month 范围 0-当月天数。 |
| `period.validNights` | integer | Rest、HR、HRV、RR 的 Week/Month 必须 | 有效夜晚数，范围 0-`elapsedNights`。Rest 使用可用休息夜；HR、HRV、RR 使用至少 4 个有效样本的夜晚。 |
## 2. 通用基线契约
所有名为 `baseline` 的对象均使用以下结构。
```json
{
"baselineLower": 40,
"baselineUpper": 80,
"baselineSource": "personal"
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `baselineLower` | number/null | 是 | 个体常见范围下界。`baselineSource=unavailable` 时必须为 `null`。 |
| `baselineUpper` | number/null | 是 | 个体常见范围上界，且不得小于 `baselineLower`。`unavailable` 时必须为 `null`。 |
| `baselineSource` | enum | 是 | `personal`、`blended`、`reference`、`unavailable`。只有 `personal` 可单独触发偏高或偏低结论。 |
Activity、Rest、HR 支持四种来源；HRV、RR 、Bark仅支持 `personal`、`unavailable`。`blended`、`reference` 只能帮助解释，不能单独触发个体偏离提醒。
## 3. 通用响应契约
主服务只应依赖以下字段。结构化证据、质量、展示样式和费用可以由 Gateway 内部保留，但不属于本接口响应契约。
```json
{
"insightId": "hdi_20260723_activity_day_0001",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "day",
"period": {
"startDate": "2026-07-23",
"endDate": "2026-07-23",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "attention",
"severity": "medium",
"summary": "Pocky 今天的活动比平时多一些：活动了 95 分钟，比它平时多 21 分钟。接下来让它多留一点安静休息的时间。",
"generation": {
"ruleId": "ACTIVITY_HIGH_DAY",
"ruleVersion": "health-detail-v3",
"aiPolished": true,
"generatedAt": "2026-07-23T10:00:00+08:00"
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `insightId` | string | 是 | 单条洞察唯一标识。 |
| `petId` | string | 是 | 请求中的宠物标识。 |
| `metric` | enum | 是 | 请求指标。 |
| `viewWindow` | enum | 是 | 请求时间窗口。 |
| `period` | object | 是 | 响应窗口信息。 |
| `period.startDate` | string(date) | 是 | 响应窗口开始日期。 |
| `period.endDate` | string(date) | 是 | 响应窗口结束日期。 |
| `period.isCompleted` | boolean | 是 | 请求窗口完成状态。 |
| `status` | enum | 是 | `attention`、`normal`、`improving`、`data_collecting`、`insufficient_data`。 |
| `severity` | enum | 是 | `none`、`low`、`medium`、`high`。详情页不据此直接推送。 |
| `summary` | string | 是 | 选定语言的一段自然语言，结构为“现象 + 关键依据 + 轻解释或建议”。 |
| `generation` | object | 是 | 生成元数据。 |
| `generation.ruleId` | string | 是 | 命中的确定性规则 ID。 |
| `generation.aiPolished` | boolean | 是 | 是否经 AI 润色；模板结果或 AI 失败回退为 `false`。 |
| `generation.generatedAt` | string(date-time) | 是 | ISO 8601 且带时区的生成时间。 |
优先级为：`insufficient_data` > 高严重度 `attention` > 中严重度 `attention` > 低严重度 `attention` > `improving` > `data_collecting` > `normal`。
# 4. Activity（活动）
`metric` 固定为 `activity`。天气枚举仅允许 `sunny`、`cloudy`、`overcast`、`rainy`、`snowy`、`foggy`、`windy`、`unknown`。
## Day
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"heatTolerance": "low"
},
"period": {
"startDate": "2026-07-23",
"endDate": "2026-07-23",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutes": 1440,
"activityTime": {
"activityMinutes": 95,
"activityMinutesGoal": 60,
"baseline": {
"baselineLower": 56,
"baselineUpper": 84,
"baselineSource": "personal"
},
"hourlyActivityMinutes": [
0,
0,
0,
0,
0,
0,
8,
14,
10,
3,
0,
0,
0,
0,
0,
0,
5,
18,
20,
12,
5,
0,
0,
0
]
},
"steps": {
"steps": 6800,
"stepsGoal": 5000,
"baseline": {
"baselineLower": 4160,
"baselineUpper": 6240,
"baselineSource": "personal"
}
},
"outings": {
"count": 2,
"totalDurationMinutes": 48,
"items": [
{
"startAt": "2026-07-23T07:20:00+08:00",
"endAt": "2026-07-23T07:35:00+08:00",
"durationMinutes": 15
},
{
"startAt": "2026-07-23T16:10:00+08:00",
"endAt": "2026-07-23T16:43:00+08:00",
"durationMinutes": 33
}
]
},
"context": {
"weather": "sunny",
"tempMaxC": 33,
"feelsLikeMaxC": 37,
"humidityPct": 74
}
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.wearingMinutes` | integer | 是 | 当日有效佩戴分钟，范围 0-1440。 |
| `metrics.activityTime.activityMinutes` | integer | 是 | 当日活动分钟，范围 0-1440。 |
| `metrics.activityTime.activityMinutesGoal` | integer/null | 否 | 当日活动目标，只用于解释和达标文案。 |
| `metrics.activityTime.baseline` | Baseline | 是 | 活动分钟基线。 |
| `metrics.activityTime.hourlyActivityMinutes` | array<integer/null> | 是 | 固定 24 项，对应本地 0-23 时；非空项范围 0-60，非空项之和必须等于 `activityMinutes`。`null` 是未采集，不是静止。 |
| `metrics.steps` | object | 否 | 设备支持步数时传入。 |
| `metrics.steps.steps` | integer | 条件必填 | 传入 `steps` 时必填的总步数。 |
| `metrics.steps.stepsGoal` | integer/null | 否 | 当日步数目标。 |
| `metrics.steps.baseline` | Baseline | 条件必填 | 步数基线。 |
| `metrics.outings` | object | 否 | 外出汇总和片段。 |
| `metrics.outings.count` | integer | 条件必填 | 必须等于 `items` 长度。 |
| `metrics.outings.totalDurationMinutes` | integer | 条件必填 | 必须等于各片段时长之和。 |
| `metrics.outings.items[].startAt` | string(date-time) | 是 | 带时区且位于请求 Day 内。 |
| `metrics.outings.items[].endAt` | string(date-time) | 是 | 带时区、晚于开始时间且位于请求 Day 内。 |
| `metrics.outings.items[].durationMinutes` | integer | 是 | 必须与起止时间间隔一致。 |
| `metrics.context.weather` | enum | 否 | 上述天气枚举。 |
| `metrics.context.tempMaxC` | number | 否 | 最高环境温度，摄氏度。 |
| `metrics.context.feelsLikeMaxC` | number | 否 | 最高体感温度，摄氏度。 |
| `metrics.context.humidityPct` | number | 否 | 相对湿度，范围 0-100。 |
Day 未完成时，允许输出已超过上限、热暴露或集中活动事实；不得输出当天活动不足或最终未达标。
## Week
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "week",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutesByDay": [
1440,
1440,
1440,
1440,
1440,
1440,
1440
],
"activityTime": {
"averageDailyActivityMinutes": 72,
"activityMinutesGoal": 60,
"baseline": {
"baselineLower": 56,
"baselineUpper": 84,
"baselineSource": "personal"
},
"dailyActivityMinutes": [
70,
55,
80,
68,
90,
75,
66
]
},
"steps": {
"averageDailySteps": 5314,
"stepsGoal": 5000,
"baseline": {
"baselineLower": 4160,
"baselineUpper": 6240,
"baselineSource": "personal"
},
"dailySteps": [
5000,
4300,
5900,
5100,
6700,
5400,
4800
]
},
"dailyOutings": [
{
"date": "2026-07-13",
"count": 2,
"totalDurationMinutes": 30
}
],
"dailyWeather": [
{
"date": "2026-07-13",
"weather": "cloudy",
"tempMaxC": 29,
"feelsLikeMaxC": 31,
"humidityPct": 68
}
]
},
"previousPeriod": {
"startDate": "2026-07-06",
"endDate": "2026-07-12",
"isCompleted": true,
"averageDailyActivityMinutes": 80,
"averageDailySteps": 5900
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.wearingMinutesByDay` | array<integer/null> | 是 | 固定 7 项，按日期排列；非空范围 0-1440。 |
| `metrics.activityTime.averageDailyActivityMinutes` | number | 是 | 非空 `dailyActivityMinutes` 的均值。 |
| `metrics.activityTime.activityMinutesGoal` | integer/null | 否 | 每日活动目标。 |
| `metrics.activityTime.baseline` | Baseline | 是 | 日均活动基线。 |
| `metrics.activityTime.dailyActivityMinutes` | array<integer/null> | 是 | 固定 7 项，非空项均值必须等于日均值。 |
| `metrics.steps.averageDailySteps` | number | 条件必填 | 提供 `steps` 时，为非空 `dailySteps` 的均值。 |
| `metrics.steps.stepsGoal` | integer/null | 否 | 每日步数目标。 |
| `metrics.steps.dailySteps` | array<integer/null> | 条件必填 | 提供 `steps` 时固定 7 项。 |
| `metrics.dailyOutings` | array<object> | 否 | 每日外出汇总；日期在窗口内且唯一。未出现日期表示未知，不代表 0。 |
| `metrics.dailyWeather` | array<object> | 否 | 每日天气上下文；日期在窗口内且唯一。 |
| `previousPeriod.averageDailyActivityMinutes` | number | 条件必填 | 提供上一周期时必填。 |
| `previousPeriod.averageDailySteps` | number | 否 | 可用时提供。 |
## Month
请求结构与 Activity Week 相同；`startDate` 必须为月初，`endDate` 必须为月末，`wearingMinutesByDay`、`dailyActivityMinutes`、`dailySteps` 的长度必须等于当月天数。`previousPeriod` 必须是紧邻上一完整自然月。
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "month",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-02-01",
"endDate": "2026-02-28",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutesByDay": [
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440,
1440
],
"activityTime": {
"averageDailyActivityMinutes": 70,
"activityMinutesGoal": 60,
"baseline": {
"baselineLower": 56,
"baselineUpper": 84,
"baselineSource": "personal"
},
"dailyActivityMinutes": [
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70,
70
]
},
"steps": {
"averageDailySteps": 5000,
"stepsGoal": 5000,
"baseline": {
"baselineLower": 4160,
"baselineUpper": 6240,
"baselineSource": "personal"
},
"dailySteps": [
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000,
5000
]
}
},
"previousPeriod": {
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"isCompleted": true,
"averageDailyActivityMinutes": 76
}
}
```
示例数组已按 2026-02 的完整自然月补齐 28 项。字段语义与 Week 相同。
# 5. Rest（休息）
`metric` 固定为 `rest`。Rest Day 以选中日期结束的上一夜为主，当日休息仅作为辅助证据。
## Day
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": [
"respiratory"
]
},
"period": {
"startDate": "2026-07-23",
"endDate": "2026-07-23",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"night": {
"startAt": "2026-07-22T21:30:00+08:00",
"endAt": "2026-07-23T07:00:00+08:00",
"isCompleted": true,
"wearingMinutes": 550,
"nightRest": {
"minutes": 420,
"baseline": {
"baselineLower": 390,
"baselineUpper": 510,
"baselineSource": "personal"
}
},
"interruptions": {
"count": 4,
"baseline": {
"baselineLower": 0,
"baselineUpper": 3,
"baselineSource": "personal"
}
},
"longestRestBlockMinutes": 150,
"nightActivity": {
"minutes": 24,
"baseline": {
"baselineLower": 0,
"baselineUpper": 16,
"baselineSource": "personal"
}
},
"restSegments": []
},
"day": {
"wearingMinutes": 600,
"hourlyRestMinutes": [
0,
0,
0,
0,
0,
0,
0,
0,
12,
18,
0,
0,
20,
25,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"dayRestBaseline": {
"baselineLower": 20,
"baselineUpper": 55,
"baselineSource": "personal"
}
}
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.night.startAt` / `endAt` | string(date-time) | 是 | 带时区的上一夜窗口，允许跨自然日。 |
| `metrics.night.isCompleted` | boolean | 是 | 夜晚是否结束；`false` 时不能形成夜间主判断。 |
| `metrics.night.wearingMinutes` | integer | 是 | 夜间有效佩戴分钟。少于 300 时为数据不足。 |
| `metrics.night.nightRest.minutes` | integer | 是 | 夜间总休息分钟。 |
| `metrics.night.nightRest.baseline` | Baseline | 是 | 夜间总休息基线。 |
| `metrics.night.interruptions.count` | integer | 是 | 夜间中断次数。 |
| `metrics.night.interruptions.baseline` | Baseline | 是 | 夜间中断基线。 |
| `metrics.night.longestRestBlockMinutes` | integer | 是 | 最长连续休息分钟。 |
| `metrics.night.nightActivity.minutes` | integer | 是 | 夜间活动分钟。 |
| `metrics.night.nightActivity.baseline` | Baseline | 是 | 夜间活动基线。 |
| `metrics.night.restSegments` | array<object>/null | 是 | `null` 表示设备不提供分段能力；未覆盖时段为未知。元素含 `startAt`、`endAt`、`durationMinutes`、`type`，其中 `type` 为 `awake`、`lightMovement`、`deepRest`。 |
| `metrics.day.wearingMinutes` | integer | 是 | 选中自然日有效佩戴分钟。 |
| `metrics.day.hourlyRestMinutes` | array<integer/null> | 是 | 固定 24 项，非空范围 0-60；`null` 表示该小时不可用。 |
| `metrics.day.dayRestBaseline` | Baseline | 是 | 白天总休息分钟基线。 |
## Week
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "week",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 7,
"validNights": 6
},
"metrics": {
"nightRest": {
"averageMinutes": 405,
"baseline": {
"baselineLower": 390,
"baselineUpper": 510,
"baselineSource": "personal"
}
},
"interruptions": {
"averageCount": 4,
"baseline": {
"baselineLower": 0,
"baselineUpper": 3,
"baselineSource": "personal"
}
},
"nightActivity": {
"averageMinutes": 24,
"baseline": {
"baselineLower": 0,
"baselineUpper": 16,
"baselineSource": "personal"
}
},
"dayRest": {
"averageMinutes": 48,
"baseline": {
"baselineLower": 20,
"baselineUpper": 55,
"baselineSource": "personal"
}
},
"anomalyNights": {
"lowNightRestCount": 2,
"highInterruptionCount": 3,
"highNightActivityCount": 1
},
"nightlyRestDurations": [
{
"nightDate": "2026-07-13",
"lightMovementMinutes": 45,
"deepRestMinutes": 360
},
{
"nightDate": "2026-07-14",
"lightMovementMinutes": 45,
"deepRestMinutes": 360
},
{
"nightDate": "2026-07-15",
"lightMovementMinutes": 45,
"deepRestMinutes": 360
},
{
"nightDate": "2026-07-16",
"lightMovementMinutes": 45,
"deepRestMinutes": 360
},
{
"nightDate": "2026-07-17",
"lightMovementMinutes": 45,
"deepRestMinutes": 360
},
{
"nightDate": "2026-07-18",
"lightMovementMinutes": 45,
"deepRestMinutes": 360
},
{
"nightDate": "2026-07-19",
"lightMovementMinutes": null,
"deepRestMinutes": null
}
]
},
"previousPeriod": {
"startDate": "2026-07-06",
"endDate": "2026-07-12",
"isCompleted": true,
"validNights": 6,
"nightRestAverageMinutes": 455,
"interruptionsAverageCount": 2,
"nightActivityAverageMinutes": 12,
"dayRestAverageMinutes": 30,
"lowNightRestCount": 0,
"highInterruptionCount": 1,
"highNightActivityCount": 0
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.nightRest.averageMinutes` | number/null | 是 | 有效夜平均夜间总休息；`validNights=0` 时为 `null`。 |
| `metrics.interruptions.averageCount` | number/null | 是 | 有效夜平均中断次数。 |
| `metrics.nightActivity.averageMinutes` | number/null | 是 | 有效夜平均夜间活动分钟。 |
| `metrics.dayRest.averageMinutes` | number/null | 是 | 有效日平均白天休息分钟。 |
| 上述四项 `baseline` | Baseline | 是 | 对应指标的独立基线。 |
| `metrics.anomalyNights` | object | 是 | `lowNightRestCount`、`highInterruptionCount`、`highNightActivityCount`；均在 0-`validNights`。 |
| `metrics.nightlyRestDurations` | array<object> | 是 | 固定 7 项，按 `nightDate` 升序；无效夜的 `lightMovementMinutes`、`deepRestMinutes` 必须同时为 `null`。 |
| `previousPeriod` | object | 否 | 紧邻已完成上一周；必须包含日期、`validNights`、四项均值和三项异常夜计数。 |
Week 少于 3 个有效夜晚时不输出周期趋势或稳定结论。
## Month
请求结构与 Rest Week 相同，窗口必须为完整自然月；`elapsedNights`、`nightlyRestDurations` 长度等于当月天数，`previousPeriod` 必须是紧邻上一完整自然月。Month 少于 10 个有效夜晚时不输出周期趋势或稳定结论。
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "month",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-02-01",
"endDate": "2026-02-28",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 28,
"validNights": 25
},
"metrics": {
"nightRest": {
"averageMinutes": 450,
"baseline": {
"baselineLower": 390,
"baselineUpper": 510,
"baselineSource": "personal"
}
},
"interruptions": {
"averageCount": 2,
"baseline": {
"baselineLower": 0,
"baselineUpper": 3,
"baselineSource": "personal"
}
},
"nightActivity": {
"averageMinutes": 12,
"baseline": {
"baselineLower": 0,
"baselineUpper": 16,
"baselineSource": "personal"
}
},
"dayRest": {
"averageMinutes": 30,
"baseline": {
"baselineLower": 20,
"baselineUpper": 55,
"baselineSource": "personal"
}
},
"anomalyNights": {
"lowNightRestCount": 0,
"highInterruptionCount": 1,
"highNightActivityCount": 0
},
"nightlyRestDurations": [
{
"nightDate": "2026-02-01",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-02",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-03",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-04",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-05",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-06",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-07",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-08",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-09",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-10",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-11",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-12",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-13",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-14",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-15",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-16",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-17",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-18",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-19",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-20",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-21",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-22",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-23",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-24",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-25",
"lightMovementMinutes": 45,
"deepRestMinutes": 405
},
{
"nightDate": "2026-02-26",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-02-27",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-02-28",
"lightMovementMinutes": null,
"deepRestMinutes": null
}
]
}
}
```
# 6. HR（静息心率）
`metric` 固定为 `hr`，单位为 `bpm`。仅接收静息心率，不接收运动心率。夜间静息心率为主判断，全天静息心率只可作为同方向辅助证据。
## Day
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": [
"cardiovascular"
]
},
"period": {
"startDate": "2026-07-23",
"endDate": "2026-07-23",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"night": {
"startAt": "2026-07-22T21:30:00+08:00",
"endAt": "2026-07-23T07:00:00+08:00",
"isCompleted": true
},
"nightRestHrAverage": {
"value": 66,
"sampleCount": 6,
"baseline": {
"baselineLower": 58,
"baselineUpper": 64,
"baselineSource": "personal"
}
},
"allDayRestHrAverage": {
"value": 70,
"sampleCount": 13,
"baseline": {
"baselineLower": 62,
"baselineUpper": 68,
"baselineSource": "personal"
}
},
"hourlyPoints": [
[],
[],
[
68
],
[
66,
67
],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
],
"context": {
"weather": "cloudy",
"temperatureCelsius": 28,
"humidityPct": 72
}
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.night` | object | 是 | 以选中日结束的上一夜，含带时区的 `startAt`、`endAt` 和 `isCompleted`。 |
| `metrics.nightRestHrAverage` | object | 是 | 夜间主指标，含 `value`、`sampleCount`、`baseline`。`sampleCount` 至少 4 才能主判断。 |
| `metrics.allDayRestHrAverage` | object | 否 | 全天静息心率，含 `value`、`sampleCount`、`baseline`；至少 8 个同方向样本才可增强已触发结论。 |
| `metrics.hourlyPoints` | array<array<number>> | 否 | 固定 24 项；每项是该小时零到多个静息样本，空数组表示无样本。只解释已触发异常时段。 |
| `metrics.context` | object | 否 | `weather`、`temperatureCelsius`、`humidityPct`；只解释已有结论。 |
`value` 样本不足时为 `null`；`sampleCount=0` 时 `value` 必须为 `null`。上述 `baseline` 支持四种通用来源。
## Week
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "week",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 7,
"validNights": 6
},
"metrics": {
"nightRestHrAverage": {
"value": 66,
"sampleCount": 36,
"baseline": {
"baselineLower": 58,
"baselineUpper": 64,
"baselineSource": "personal"
}
},
"allDayRestHrAverage": {
"value": 68,
"sampleCount": 78,
"baseline": {
"baselineLower": 62,
"baselineUpper": 68,
"baselineSource": "personal"
}
},
"dailyNightRestHr": [
{
"date": "2026-07-13",
"nightRestHrAverage": 66,
"sampleCount": 6
},
{
"date": "2026-07-14",
"nightRestHrAverage": 66,
"sampleCount": 6
},
{
"date": "2026-07-15",
"nightRestHrAverage": 66,
"sampleCount": 6
},
{
"date": "2026-07-16",
"nightRestHrAverage": 66,
"sampleCount": 6
},
{
"date": "2026-07-17",
"nightRestHrAverage": 66,
"sampleCount": 6
},
{
"date": "2026-07-18",
"nightRestHrAverage": 66,
"sampleCount": 6
},
{
"date": "2026-07-19",
"nightRestHrAverage": null,
"sampleCount": 0
}
]
},
"previousPeriod": {
"startDate": "2026-07-06",
"endDate": "2026-07-12",
"isCompleted": true,
"validNights": 6,
"nightRestHrAverage": 61,
"allDayRestHrAverage": 65,
"highNightRestHrCount": 0,
"lowNightRestHrCount": 1
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.nightRestHrAverage` | object | 是 | 当前周期夜间平均；字段同 Day，`sampleCount` 是周期样本总数。 |
| `metrics.allDayRestHrAverage` | object | 否 | 当前周期全天平均；字段同 Day。 |
| `metrics.dailyNightRestHr` | array<object> | 是 | 固定 7 项，元素为 `date`、`nightRestHrAverage`、`sampleCount`。无效夜为 `null` 和 0。 |
| `previousPeriod` | object | 否 | 紧邻完整上一周；含日期、`validNights`、夜间/全天均值、`highNightRestHrCount`、`lowNightRestHrCount`。 |
Week 少于 3 个有效夜晚时不输出趋势结论。
## Month
请求结构与 HR Week 相同；必须覆盖完整自然月，逐夜数组长度等于当月天数，`previousPeriod` 是紧邻上一完整月。Month 少于 10 个有效夜晚时不输出趋势结论。
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "month",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-02-01",
"endDate": "2026-02-28",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 28,
"validNights": 25
},
"metrics": {
"nightRestHrAverage": {
"value": 65,
"sampleCount": 150,
"baseline": {
"baselineLower": 58,
"baselineUpper": 64,
"baselineSource": "personal"
}
},
"dailyNightRestHr": [
{
"date": "2026-02-01",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-02",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-03",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-04",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-05",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-06",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-07",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-08",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-09",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-10",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-11",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-12",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-13",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-14",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-15",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-16",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-17",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-18",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-19",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-20",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-21",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-22",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-23",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-24",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-25",
"nightRestHrAverage": 65,
"sampleCount": 6
},
{
"date": "2026-02-26",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-02-27",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-02-28",
"nightRestHrAverage": null,
"sampleCount": 0
}
]
}
}
```
# 7. HRV（恢复状态）
`metric` 固定为 `hrv`。用户文案称“恢复状态”，数据证据是静息 HRV 的 RMSSD，单位 `ms`。不接收原始 RR 间期，不将 HRV 表述为压力、疾病或恢复能力评分。
## Day
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-07-23",
"endDate": "2026-07-23",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"night": {
"startAt": "2026-07-22T21:30:00+08:00",
"endAt": "2026-07-23T07:00:00+08:00",
"isCompleted": true
},
"nightRestRmssdAverage": {
"value": 42,
"sampleCount": 6,
"baseline": {
"baselineLower": 45,
"baselineUpper": 63,
"baselineSource": "personal"
}
},
"allDayRestRmssdAverage": {
"value": 44,
"sampleCount": 11,
"baseline": {
"baselineLower": 46,
"baselineUpper": 65,
"baselineSource": "personal"
}
},
"hourlyRmssdPoints": [
[],
[],
[
41
],
[
39,
42
],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
],
"context": {
"weather": "cloudy",
"temperatureCelsius": 28,
"humidityPct": 72
}
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.night` | object | 是 | 字段和夜间完成规则同 HR Day。 |
| `metrics.nightRestRmssdAverage` | object | 是 | 夜间主指标，含 `value`、有效 RMSSD 片段数 `sampleCount`、`baseline`；至少 4 片段才能主判断。 |
| `metrics.allDayRestRmssdAverage` | object | 否 | 全天辅助指标；至少 8 个同方向片段才可增强结论。 |
| `metrics.hourlyRmssdPoints` | array<array<number>> | 否 | 固定 24 项，每项为该小时零到多个有效 RMSSD 片段；空数组表示无片段。 |
| `metrics.context` | object | 否 | 环境上下文，只解释已触发结论。 |
HRV 的所有基线仅允许 `personal`、`unavailable`。
## Week
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "week",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 7,
"validNights": 6
},
"metrics": {
"nightRestRmssdAverage": {
"value": 42,
"sampleCount": 36,
"baseline": {
"baselineLower": 45,
"baselineUpper": 63,
"baselineSource": "personal"
}
},
"dailyNightRestRmssd": [
{
"date": "2026-07-13",
"nightRestRmssdAverage": 42,
"sampleCount": 6
},
{
"date": "2026-07-14",
"nightRestRmssdAverage": 42,
"sampleCount": 6
},
{
"date": "2026-07-15",
"nightRestRmssdAverage": 42,
"sampleCount": 6
},
{
"date": "2026-07-16",
"nightRestRmssdAverage": 42,
"sampleCount": 6
},
{
"date": "2026-07-17",
"nightRestRmssdAverage": 42,
"sampleCount": 6
},
{
"date": "2026-07-18",
"nightRestRmssdAverage": 42,
"sampleCount": 6
},
{
"date": "2026-07-19",
"nightRestRmssdAverage": null,
"sampleCount": 0
}
]
},
"previousPeriod": {
"startDate": "2026-07-06",
"endDate": "2026-07-12",
"isCompleted": true,
"validNights": 6,
"nightRestRmssdAverage": 51,
"allDayRestRmssdAverage": 53,
"lowNightRestRmssdCount": 1
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.nightRestRmssdAverage` | object | 是 | 当前周期夜间平均，字段同 Day。 |
| `metrics.allDayRestRmssdAverage` | object | 否 | 当前周期全天平均，字段同 Day。 |
| `metrics.dailyNightRestRmssd` | array<object> | 是 | 固定 7 项，元素为 `date`、`nightRestRmssdAverage`、`sampleCount`。 |
| `previousPeriod` | object | 否 | 紧邻完整上一周；含日期、有效夜晚、夜间/全天均值和 `lowNightRestRmssdCount`。 |
Week 少于 3 个有效夜晚时不输出周期主判断。
## Month
请求结构与 HRV Week 相同；完整自然月、逐夜数组长度和上一周期要求同 HR Month。Month 少于 10 个有效夜晚时不输出周期主判断。
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "month",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-02-01",
"endDate": "2026-02-28",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 28,
"validNights": 25
},
"metrics": {
"nightRestRmssdAverage": {
"value": 48,
"sampleCount": 150,
"baseline": {
"baselineLower": 45,
"baselineUpper": 63,
"baselineSource": "personal"
}
},
"dailyNightRestRmssd": [
{
"date": "2026-02-01",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-02",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-03",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-04",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-05",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-06",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-07",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-08",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-09",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-10",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-11",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-12",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-13",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-14",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-15",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-16",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-17",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-18",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-19",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-20",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-21",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-22",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-23",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-24",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-25",
"nightRestRmssdAverage": 48,
"sampleCount": 6
},
{
"date": "2026-02-26",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-02-27",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-02-28",
"nightRestRmssdAverage": null,
"sampleCount": 0
}
]
}
}
```
# 8. RR（呼吸状态）
`metric` 固定为 `rr`。用户文案称“呼吸状态”，数据证据是静息呼吸频率，单位 `breaths/min`。不接收呼吸波形、绝对医学阈值、品种参考或上游预计算风险评级。
## Day
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": [
"respiratory"
]
},
"period": {
"startDate": "2026-07-23",
"endDate": "2026-07-23",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"night": {
"startAt": "2026-07-22T21:30:00+08:00",
"endAt": "2026-07-23T07:00:00+08:00",
"isCompleted": true
},
"nightRestRrAverage": {
"value": 24,
"sampleCount": 6,
"baseline": {
"baselineLower": 16,
"baselineUpper": 21,
"baselineSource": "personal"
}
},
"allDayRestRrAverage": {
"value": 23,
"sampleCount": 12,
"baseline": {
"baselineLower": 16,
"baselineUpper": 21,
"baselineSource": "personal"
}
},
"hourlyPoints": [
[],
[],
[
22
],
[
24,
23
],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
],
"context": {
"weather": "cloudy",
"temperatureCelsius": 28,
"humidityPct": 72
}
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.night` | object | 是 | 字段和夜间完成规则同 HR Day。 |
| `metrics.nightRestRrAverage` | object | 是 | 夜间主指标，含 `value`、`sampleCount`、`baseline`；至少 4 样本才能主判断。 |
| `metrics.allDayRestRrAverage` | object | 否 | 全天辅助指标；至少 8 个同方向样本才可增强结论。 |
| `metrics.hourlyPoints` | array<array<number>> | 否 | 固定 24 项；单小时零到多个有效静息呼吸样本。 |
| `metrics.context` | object | 否 | 环境上下文，只解释已触发结论。 |
RR 的所有基线仅允许 `personal`、`unavailable`。
## Week
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "week",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 7,
"validNights": 6
},
"metrics": {
"nightRestRrAverage": {
"value": 22,
"sampleCount": 36,
"baseline": {
"baselineLower": 16,
"baselineUpper": 21,
"baselineSource": "personal"
}
},
"dailyNightRestRr": [
{
"date": "2026-07-13",
"nightRestRrAverage": 22,
"sampleCount": 6
},
{
"date": "2026-07-14",
"nightRestRrAverage": 22,
"sampleCount": 6
},
{
"date": "2026-07-15",
"nightRestRrAverage": 22,
"sampleCount": 6
},
{
"date": "2026-07-16",
"nightRestRrAverage": 22,
"sampleCount": 6
},
{
"date": "2026-07-17",
"nightRestRrAverage": 22,
"sampleCount": 6
},
{
"date": "2026-07-18",
"nightRestRrAverage": 22,
"sampleCount": 6
},
{
"date": "2026-07-19",
"nightRestRrAverage": null,
"sampleCount": 0
}
]
},
"previousPeriod": {
"startDate": "2026-07-06",
"endDate": "2026-07-12",
"isCompleted": true,
"validNights": 6,
"nightRestRrAverage": 20,
"allDayRestRrAverage": 20,
"highNightRestRrCount": 0
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.nightRestRrAverage` | object | 是 | 当前周期夜间平均，字段同 Day。 |
| `metrics.allDayRestRrAverage` | object | 否 | 当前周期全天平均，字段同 Day。 |
| `metrics.dailyNightRestRr` | array<object> | 是 | 固定 7 项，元素为 `date`、`nightRestRrAverage`、`sampleCount`。 |
| `previousPeriod` | object | 否 | 紧邻完整上一周；含日期、有效夜晚、夜间/全天均值和 `highNightRestRrCount`。 |
Week 少于 3 个有效夜晚时不输出周期主判断。
## Month
请求结构与 RR Week 相同；完整自然月、逐夜数组长度和上一周期要求同 HR Month。Month 少于 10 个有效夜晚时不输出周期主判断。
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "month",
"locale": "en-US",
"petProfile": {
"name": "Pocky",
"species": "dog"
},
"period": {
"startDate": "2026-02-01",
"endDate": "2026-02-28",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 28,
"validNights": 25
},
"metrics": {
"nightRestRrAverage": {
"value": 20,
"sampleCount": 150,
"baseline": {
"baselineLower": 16,
"baselineUpper": 21,
"baselineSource": "personal"
}
},
"dailyNightRestRr": [
{
"date": "2026-02-01",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-02",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-03",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-04",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-05",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-06",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-07",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-08",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-09",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-10",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-11",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-12",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-13",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-14",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-15",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-16",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-17",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-18",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-19",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-20",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-21",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-22",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-23",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-24",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-25",
"nightRestRrAverage": 20,
"sampleCount": 6
},
{
"date": "2026-02-26",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-02-27",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-02-28",
"nightRestRrAverage": null,
"sampleCount": 0
}
]
}
}
```
# 9. Bark（吠叫状态）
`metric` 固定为 `bark`，时长单位为秒。Bark 基线仅允许 `personal`、`unavailable`。不接收原始音频、声学特征、具体地址、坐标、绝对医学阈值或疾病风险评分。
## Day
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Milo",
"species": "dog"
},
"period": {
"startDate": "2026-07-23",
"endDate": "2026-07-23",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutes": 960,
"barkDurationSeconds": 106,
"barkEventCount": 2,
"longestBarkEventDurationSeconds": 84,
"baseline": {
"baselineLower": 80,
"baselineUpper": 160,
"baselineSource": "personal"
},
"barkEvents": [
{
"startAt": "2026-07-23T18:42:10+08:00",
"endAt": "2026-07-23T18:42:32+08:00",
"durationSeconds": 22,
"intensity": "medium",
"locationType": "home"
},
{
"startAt": "2026-07-23T20:03:30+08:00",
"endAt": "2026-07-23T20:04:54+08:00",
"durationSeconds": 84,
"intensity": "high",
"locationType": "home"
}
]
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.wearingMinutes` | integer | 是 | 唯一覆盖指标，范围 0-1440；少于 720 时只展示已识别事实。 |
| `metrics.barkDurationSeconds` | integer | 是 | 必须等于所有事件 `durationSeconds` 之和。 |
| `metrics.barkEventCount` | integer | 是 | 必须等于 `barkEvents` 长度。 |
| `metrics.longestBarkEventDurationSeconds` | integer | 是 | 必须等于事件最大时长；无事件时为 0。 |
| `metrics.baseline` | Baseline | 是 | 吠叫总时长基线，仅可使用 `personal`、`unavailable`。 |
| `metrics.barkEvents` | array<object> | 是 | 当天事件明细；无事件传空数组。 |
| `metrics.barkEvents[].startAt` / `endAt` | string(date-time) | 是 | 带时区、位于请求 Day 内，且结束晚于开始。 |
| `metrics.barkEvents[].durationSeconds` | integer | 是 | 必须与起止时间差一致。 |
| `metrics.barkEvents[].intensity` | enum | 是 | `low`、`medium`、`high`；由上游识别，Gateway 不按时长推断。 |
| `metrics.barkEvents[].locationType` | enum | 是 | `home`、`outdoor`、`unknown`；不传具体地址或坐标。 |
## Week
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "week",
"locale": "zh-CN",
"petProfile": {
"name": "Milo",
"species": "dog"
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutes": 5940,
"averageDailyBarkDurationSeconds": 139.0,
"barkEventCount": 31,
"anomalyDayCount": 2,
"dailyBarkDurations": [
{
"date": "2026-07-13",
"wearingMinutes": 840,
"barkDurationSeconds": 80,
"isAnomaly": false
},
{
"date": "2026-07-14",
"wearingMinutes": 900,
"barkDurationSeconds": 260,
"isAnomaly": true
},
{
"date": "2026-07-15",
"wearingMinutes": 840,
"barkDurationSeconds": 120,
"isAnomaly": true
},
{
"date": "2026-07-16",
"wearingMinutes": 840,
"barkDurationSeconds": 130,
"isAnomaly": false
},
{
"date": "2026-07-17",
"wearingMinutes": 840,
"barkDurationSeconds": 127,
"isAnomaly": false
},
{
"date": "2026-07-18",
"wearingMinutes": 840,
"barkDurationSeconds": 128,
"isAnomaly": false
},
{
"date": "2026-07-19",
"wearingMinutes": 840,
"barkDurationSeconds": 128,
"isAnomaly": false
}
]
},
"previousPeriod": {
"startDate": "2026-07-06",
"endDate": "2026-07-12",
"isCompleted": true,
"averageDailyBarkDurationSeconds": 90,
"barkEventCount": 22,
"anomalyDayCount": 1
}
}
```
| 字段名 | 数据类型 | 必须 | 详细说明 |
|---|---|---:|---|
| `metrics.wearingMinutes` | integer | 是 | 当前周总佩戴分钟，仅用于说明；周期判断由逐日佩戴决定。 |
| `metrics.averageDailyBarkDurationSeconds` | number | 是 | 可用逐日时长的日均值。 |
| `metrics.barkEventCount` | integer | 是 | 周期内识别事件总数。 |
| `metrics.anomalyDayCount` | integer | 是 | 必须等于 `isAnomaly=true` 的日期数。 |
| `metrics.dailyBarkDurations` | array<object> | 是 | 固定 7 项，按日期连续排列。元素含 `date`、`wearingMinutes`、`barkDurationSeconds`、`isAnomaly`。 |
| `metrics.dailyBarkDurations[].isAnomaly` | boolean/null | 是 | `true` 表示上游已在佩戴达标且个人基线可用时判为高于上限；`false` 为已判断未偏高；`null` 为不可判断。 |
| `previousPeriod` | object | 否 | 紧邻完整上一周；含日均时长、事件数、异常日数。 |
Week 少于 3 个佩戴至少 720 分钟的日期时返回数据不足。
## Month
请求结构与 Bark Week 相同；必须覆盖完整自然月，`dailyBarkDurations` 长度等于当月天数，`previousPeriod` 是紧邻上一完整月。Month 少于 10 个佩戴至少 720 分钟的日期时返回数据不足。
```json
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "month",
"locale": "en-US",
"petProfile": {
"name": "Milo",
"species": "dog"
},
"period": {
"startDate": "2026-02-01",
"endDate": "2026-02-28",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutes": 23520,
"averageDailyBarkDurationSeconds": 100,
"barkEventCount": 140,
"anomalyDayCount": 0,
"dailyBarkDurations": [
{
"date": "2026-02-01",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-02",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-03",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-04",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-05",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-06",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-07",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-08",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-09",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-10",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-11",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-12",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-13",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-14",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-15",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-16",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-17",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-18",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-19",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-20",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-21",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-22",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-23",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-24",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-25",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-26",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-27",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
},
{
"date": "2026-02-28",
"wearingMinutes": 840,
"barkDurationSeconds": 100,
"isAnomaly": false
}
]
},
"previousPeriod": {
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"isCompleted": true,
"averageDailyBarkDurationSeconds": 96,
"barkEventCount": 104,
"anomalyDayCount": 1
}
}
```
## 10. 主服务调用检查清单
1. 所有请求使用 `health-detail-v3`。
2. 主服务按 `period.timezone` 切分本地自然日、自然周和自然月。
3. 固定长度数组按日期升序补齐；文档中的请求 JSON 示例必须可直接通过本契约校验。
4. 统计值、计数和最长值必须从同一批事实聚合并满足文中相等关系。
5. 没有数据时按字段要求传 `null`，不能以 0 伪造缺失数据。
6. 基线不可用时使用 `unavailable` 和两个 `null` 边界。
7. `previousPeriod` 只能是根级、紧邻、同类型且已完成的上一周期；缺失时只跳过环比规则。
8. 收到 `422` 时按 `details[].loc` 修复调用方字段或聚合，不应对同一非法请求重试。
Activity day request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutes": 1440,
"activityTime": {
"activityMinutes": 60,
"baseline": {
"baselineLower": 40,
"baselineUpper": 80,
"baselineSource": "personal"
},
"hourlyActivityMinutes": [60, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
}
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Day requires the same start and end date. |
period.endDate | string(date) | 是 | Day requires the same start and end date. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
metrics.wearingMinutes | integer | 是 | Daily wearing minutes. |
metrics.activityTime | object | 是 | Activity summary. |
metrics.activityTime.activityMinutes | integer | 是 | Daily activity minutes. |
metrics.activityTime.baseline | object | 是 | Activity baseline baseline. |
metrics.activityTime.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.activityTime.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.activityTime.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.activityTime.hourlyActivityMinutes | array<integer|null> | 是 | 24 hourly activity values. |
metrics.steps | object | 否 | Optional step summary. |
metrics.steps.steps | integer | 是 | Daily steps. |
metrics.steps.baseline | object | 是 | Steps baseline baseline. |
metrics.steps.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.steps.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.steps.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.outings | object | 否 | Optional outing facts. |
metrics.outings.count | integer | 是 | Outing count. |
metrics.outings.totalDurationMinutes | integer | 是 | Total outing duration. |
metrics.outings.items | array<object> | 是 | Outing items. |
metrics.outings.items[].startAt | string(date-time) | 是 | Outing start time. |
metrics.outings.items[].endAt | string(date-time) | 是 | Outing end time. |
metrics.outings.items[].durationMinutes | integer | 是 | Outing duration minutes. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "day",
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
Activity week request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "week",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutesByDay": [1440, 1440, 1440, 1440, 1440, 1440, 1440],
"activityTime": {
"averageDailyActivityMinutes": 60,
"baseline": {
"baselineLower": 40,
"baselineUpper": 80,
"baselineSource": "personal"
},
"dailyActivityMinutes": [60, 60, 60, 60, 60, 60, 60]
}
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.endDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.averageDailyActivityMinutes | number | 是 | Previous average daily activity minutes. |
previousPeriod.averageDailySteps | number | 否 | Previous average daily steps. |
metrics.wearingMinutesByDay | array<integer|null> | 是 | Per-day wearing minutes. |
metrics.activityTime | object | 是 | Average activity summary. |
metrics.activityTime.averageDailyActivityMinutes | number | 是 | Average daily activity minutes. |
metrics.activityTime.baseline | object | 是 | Activity baseline baseline. |
metrics.activityTime.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.activityTime.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.activityTime.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.activityTime.dailyActivityMinutes | array<integer|null> | 是 | Daily activity minutes aligned to calendar order. |
metrics.steps | object | 否 | Optional step summary. |
metrics.steps.averageDailySteps | number | 是 | Average daily steps. |
metrics.steps.baseline | object | 是 | Steps baseline baseline. |
metrics.steps.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.steps.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.steps.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.steps.dailySteps | array<integer|null> | 是 | Daily steps aligned to calendar order. |
metrics.dailyOutings | array<object> | 否 | Optional daily outing rows. |
metrics.dailyOutings[].date | string(date) | 是 | Calendar date. |
metrics.dailyOutings[].count | integer | 是 | Outing count. |
metrics.dailyOutings[].totalDurationMinutes | integer | 是 | Outing duration. |
metrics.dailyWeather | array<object> | 否 | Optional daily weather rows. |
metrics.dailyWeather[].date | string(date) | 是 | Calendar date. |
metrics.dailyWeather[].weather | enum | 否 | Weather code. |
metrics.dailyWeather[].tempMaxC | number | 否 | Max temperature. |
metrics.dailyWeather[].feelsLikeMaxC | number | 否 | Max feels-like temperature. |
metrics.dailyWeather[].temperatureCelsius | number | 否 | Observed temperature. |
metrics.dailyWeather[].humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "week",
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
Activity month request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "month",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutesByDay": [1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440],
"activityTime": {
"averageDailyActivityMinutes": 60,
"baseline": {
"baselineLower": 40,
"baselineUpper": 80,
"baselineSource": "personal"
},
"dailyActivityMinutes": [60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60, 60]
}
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Month requires one complete natural month. |
period.endDate | string(date) | 是 | Month requires one complete natural month. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.averageDailyActivityMinutes | number | 是 | Previous average daily activity minutes. |
previousPeriod.averageDailySteps | number | 否 | Previous average daily steps. |
metrics.wearingMinutesByDay | array<integer|null> | 是 | Per-day wearing minutes. |
metrics.activityTime | object | 是 | Average activity summary. |
metrics.activityTime.averageDailyActivityMinutes | number | 是 | Average daily activity minutes. |
metrics.activityTime.baseline | object | 是 | Activity baseline baseline. |
metrics.activityTime.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.activityTime.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.activityTime.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.activityTime.dailyActivityMinutes | array<integer|null> | 是 | Daily activity minutes aligned to calendar order. |
metrics.steps | object | 否 | Optional step summary. |
metrics.steps.averageDailySteps | number | 是 | Average daily steps. |
metrics.steps.baseline | object | 是 | Steps baseline baseline. |
metrics.steps.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.steps.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.steps.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.steps.dailySteps | array<integer|null> | 是 | Daily steps aligned to calendar order. |
metrics.dailyOutings | array<object> | 否 | Optional daily outing rows. |
metrics.dailyOutings[].date | string(date) | 是 | Calendar date. |
metrics.dailyOutings[].count | integer | 是 | Outing count. |
metrics.dailyOutings[].totalDurationMinutes | integer | 是 | Outing duration. |
metrics.dailyWeather | array<object> | 否 | Optional daily weather rows. |
metrics.dailyWeather[].date | string(date) | 是 | Calendar date. |
metrics.dailyWeather[].weather | enum | 否 | Weather code. |
metrics.dailyWeather[].tempMaxC | number | 否 | Max temperature. |
metrics.dailyWeather[].feelsLikeMaxC | number | 否 | Max feels-like temperature. |
metrics.dailyWeather[].temperatureCelsius | number | 否 | Observed temperature. |
metrics.dailyWeather[].humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "activity",
"viewWindow": "month",
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
Rest day request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"night": {
"startAt": "2026-07-20T22:00:00+08:00",
"endAt": "2026-07-21T08:00:00+08:00",
"isCompleted": true,
"wearingMinutes": 600,
"nightRest": {
"minutes": 500,
"baseline": {
"baselineLower": 420,
"baselineUpper": 560,
"baselineSource": "personal"
}
},
"interruptions": {
"count": 2,
"baseline": {
"baselineLower": 0,
"baselineUpper": 3,
"baselineSource": "personal"
}
},
"longestRestBlockMinutes": 180,
"nightActivity": {
"minutes": 20,
"baseline": {
"baselineLower": 0,
"baselineUpper": 30,
"baselineSource": "personal"
}
},
"restSegments": [
{
"startAt": "2026-07-20T22:00:00+08:00",
"endAt": "2026-07-21T06:20:00+08:00",
"durationMinutes": 500,
"type": "deepRest"
}
]
},
"day": {
"wearingMinutes": 1440,
"hourlyRestMinutes": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
"dayRestBaseline": {
"baselineLower": 0,
"baselineUpper": 90,
"baselineSource": "personal"
}
}
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Day requires the same start and end date. |
period.endDate | string(date) | 是 | Day requires the same start and end date. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
metrics.night | object | 是 | Night segment. |
metrics.night.startAt | string(date-time) | 是 | Night start. |
metrics.night.endAt | string(date-time) | 是 | Night end. |
metrics.night.isCompleted | boolean | 否 | Whether night collection is complete. |
metrics.night.wearingMinutes | integer | 是 | Night wearing minutes. |
metrics.night.nightRest | object | 是 | Night rest fact. |
metrics.night.nightRest.minutes | integer | 是 | Night rest minutes. |
metrics.night.nightRest.baseline | object | 是 | Night rest baseline baseline. |
metrics.night.nightRest.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.night.nightRest.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.night.nightRest.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.night.interruptions | object | 是 | Night interruptions. |
metrics.night.interruptions.count | integer | 是 | Interruption count. |
metrics.night.interruptions.baseline | object | 是 | Interruption baseline baseline. |
metrics.night.interruptions.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.night.interruptions.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.night.interruptions.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.night.longestRestBlockMinutes | integer | 是 | Longest rest block minutes. |
metrics.night.nightActivity | object | 是 | Night activity. |
metrics.night.nightActivity.minutes | integer | 是 | Night activity minutes. |
metrics.night.nightActivity.baseline | object | 是 | Night activity baseline baseline. |
metrics.night.nightActivity.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.night.nightActivity.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.night.nightActivity.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.night.restSegments | array<object> | 是 | Night rest segments. |
metrics.night.restSegments[].startAt | string(date-time) | 是 | Segment start. |
metrics.night.restSegments[].endAt | string(date-time) | 是 | Segment end. |
metrics.night.restSegments[].durationMinutes | integer | 是 | Segment duration. |
metrics.night.restSegments[].type | enum | 是 | Segment type. |
metrics.day | object | 是 | Day segment. |
metrics.day.wearingMinutes | integer | 是 | Day wearing minutes. |
metrics.day.hourlyRestMinutes | array<integer|null> | 是 | 24 hourly rest values. |
metrics.day.dayRestBaseline | object | 是 | Day rest baseline baseline. |
metrics.day.dayRestBaseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.day.dayRestBaseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.day.dayRestBaseline.baselineSource | enum | 是 | Baseline source. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "day",
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
Rest week request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "week",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 7,
"validNights": 1
},
"metrics": {
"nightRest": {
"averageMinutes": 500,
"baseline": {
"baselineLower": 420,
"baselineUpper": 560,
"baselineSource": "personal"
}
},
"interruptions": {
"averageCount": 2,
"baseline": {
"baselineLower": 0,
"baselineUpper": 3,
"baselineSource": "personal"
}
},
"nightActivity": {
"averageMinutes": 20,
"baseline": {
"baselineLower": 0,
"baselineUpper": 30,
"baselineSource": "personal"
}
},
"dayRest": {
"averageMinutes": 30,
"baseline": {
"baselineLower": 0,
"baselineUpper": 90,
"baselineSource": "personal"
}
},
"anomalyNights": {
"lowNightRestCount": 0,
"highInterruptionCount": 0,
"highNightActivityCount": 0
},
"nightlyRestDurations": [
{
"nightDate": "2026-07-13",
"lightMovementMinutes": 20,
"deepRestMinutes": 480
},
{
"nightDate": "2026-07-14",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-15",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-16",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-17",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-18",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-19",
"lightMovementMinutes": null,
"deepRestMinutes": null
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.endDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer | 是 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer | 是 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.validNights | integer | 是 | Previous valid nights. |
previousPeriod.nightRestAverageMinutes | number | 是 | Previous night-rest average minutes. |
previousPeriod.interruptionsAverageCount | number | 是 | Previous interruption average count. |
previousPeriod.nightActivityAverageMinutes | number | 是 | Previous night-activity average minutes. |
previousPeriod.dayRestAverageMinutes | number | 是 | Previous day-rest average minutes. |
previousPeriod.lowNightRestCount | integer | 是 | Previous low-night-rest count. |
previousPeriod.highInterruptionCount | integer | 是 | Previous high-interruption count. |
previousPeriod.highNightActivityCount | integer | 是 | Previous high-night-activity count. |
metrics.nightRest | object | 是 | Night rest average. |
metrics.nightRest.averageMinutes | number | 是 | Night rest average value. |
metrics.nightRest.baseline | object | 是 | Night rest baseline baseline. |
metrics.nightRest.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRest.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRest.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.interruptions | object | 是 | Interruptions average. |
metrics.interruptions.averageCount | number | 是 | Interruptions average value. |
metrics.interruptions.baseline | object | 是 | Interruptions baseline baseline. |
metrics.interruptions.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.interruptions.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.interruptions.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.nightActivity | object | 是 | Night activity average. |
metrics.nightActivity.averageMinutes | number | 是 | Night activity average value. |
metrics.nightActivity.baseline | object | 是 | Night activity baseline baseline. |
metrics.nightActivity.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightActivity.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightActivity.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.dayRest | object | 是 | Day rest average. |
metrics.dayRest.averageMinutes | number | 是 | Day rest average value. |
metrics.dayRest.baseline | object | 是 | Day rest baseline baseline. |
metrics.dayRest.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.dayRest.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.dayRest.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.anomalyNights | object | 是 | Night anomaly counters. |
metrics.anomalyNights.lowNightRestCount | integer | 是 | Low night-rest count. |
metrics.anomalyNights.highInterruptionCount | integer | 是 | High interruption count. |
metrics.anomalyNights.highNightActivityCount | integer | 是 | High night-activity count. |
metrics.nightlyRestDurations | array<object> | 是 | Nightly rest rows. |
metrics.nightlyRestDurations[].nightDate | string(date) | 是 | Night date. |
metrics.nightlyRestDurations[].lightMovementMinutes | integer|null | 是 | Light movement minutes. |
metrics.nightlyRestDurations[].deepRestMinutes | integer|null | 是 | Deep rest minutes. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "week",
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
Rest month request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "month",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 31,
"validNights": 1
},
"metrics": {
"nightRest": {
"averageMinutes": 500,
"baseline": {
"baselineLower": 420,
"baselineUpper": 560,
"baselineSource": "personal"
}
},
"interruptions": {
"averageCount": 2,
"baseline": {
"baselineLower": 0,
"baselineUpper": 3,
"baselineSource": "personal"
}
},
"nightActivity": {
"averageMinutes": 20,
"baseline": {
"baselineLower": 0,
"baselineUpper": 30,
"baselineSource": "personal"
}
},
"dayRest": {
"averageMinutes": 30,
"baseline": {
"baselineLower": 0,
"baselineUpper": 90,
"baselineSource": "personal"
}
},
"anomalyNights": {
"lowNightRestCount": 0,
"highInterruptionCount": 0,
"highNightActivityCount": 0
},
"nightlyRestDurations": [
{
"nightDate": "2026-07-01",
"lightMovementMinutes": 20,
"deepRestMinutes": 480
},
{
"nightDate": "2026-07-02",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-03",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-04",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-05",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-06",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-07",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-08",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-09",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-10",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-11",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-12",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-13",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-14",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-15",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-16",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-17",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-18",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-19",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-20",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-21",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-22",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-23",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-24",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-25",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-26",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-27",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-28",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-29",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-30",
"lightMovementMinutes": null,
"deepRestMinutes": null
},
{
"nightDate": "2026-07-31",
"lightMovementMinutes": null,
"deepRestMinutes": null
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Month requires one complete natural month. |
period.endDate | string(date) | 是 | Month requires one complete natural month. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer | 是 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer | 是 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.validNights | integer | 是 | Previous valid nights. |
previousPeriod.nightRestAverageMinutes | number | 是 | Previous night-rest average minutes. |
previousPeriod.interruptionsAverageCount | number | 是 | Previous interruption average count. |
previousPeriod.nightActivityAverageMinutes | number | 是 | Previous night-activity average minutes. |
previousPeriod.dayRestAverageMinutes | number | 是 | Previous day-rest average minutes. |
previousPeriod.lowNightRestCount | integer | 是 | Previous low-night-rest count. |
previousPeriod.highInterruptionCount | integer | 是 | Previous high-interruption count. |
previousPeriod.highNightActivityCount | integer | 是 | Previous high-night-activity count. |
metrics.nightRest | object | 是 | Night rest average. |
metrics.nightRest.averageMinutes | number | 是 | Night rest average value. |
metrics.nightRest.baseline | object | 是 | Night rest baseline baseline. |
metrics.nightRest.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRest.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRest.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.interruptions | object | 是 | Interruptions average. |
metrics.interruptions.averageCount | number | 是 | Interruptions average value. |
metrics.interruptions.baseline | object | 是 | Interruptions baseline baseline. |
metrics.interruptions.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.interruptions.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.interruptions.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.nightActivity | object | 是 | Night activity average. |
metrics.nightActivity.averageMinutes | number | 是 | Night activity average value. |
metrics.nightActivity.baseline | object | 是 | Night activity baseline baseline. |
metrics.nightActivity.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightActivity.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightActivity.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.dayRest | object | 是 | Day rest average. |
metrics.dayRest.averageMinutes | number | 是 | Day rest average value. |
metrics.dayRest.baseline | object | 是 | Day rest baseline baseline. |
metrics.dayRest.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.dayRest.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.dayRest.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.anomalyNights | object | 是 | Night anomaly counters. |
metrics.anomalyNights.lowNightRestCount | integer | 是 | Low night-rest count. |
metrics.anomalyNights.highInterruptionCount | integer | 是 | High interruption count. |
metrics.anomalyNights.highNightActivityCount | integer | 是 | High night-activity count. |
metrics.nightlyRestDurations | array<object> | 是 | Nightly rest rows. |
metrics.nightlyRestDurations[].nightDate | string(date) | 是 | Night date. |
metrics.nightlyRestDurations[].lightMovementMinutes | integer|null | 是 | Light movement minutes. |
metrics.nightlyRestDurations[].deepRestMinutes | integer|null | 是 | Deep rest minutes. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "rest",
"viewWindow": "month",
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
HR day request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"night": {
"startAt": "2026-07-20T22:00:00+08:00",
"endAt": "2026-07-21T08:00:00+08:00",
"isCompleted": true
},
"nightRestHrAverage": {
"value": 82,
"sampleCount": 8,
"baseline": {
"baselineLower": 72,
"baselineUpper": 92,
"baselineSource": "personal"
}
},
"allDayRestHrAverage": {
"value": 82,
"sampleCount": 8,
"baseline": {
"baselineLower": 72,
"baselineUpper": 92,
"baselineSource": "personal"
}
},
"hourlyPoints": [
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Day requires the same start and end date. |
period.endDate | string(date) | 是 | Day requires the same start and end date. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
metrics.night | object | 是 | Night segment. |
metrics.night.startAt | string(date-time) | 是 | Night start. |
metrics.night.endAt | string(date-time) | 是 | Night end. |
metrics.night.isCompleted | boolean | 是 | Whether night collection is complete. |
metrics.nightRestHrAverage | object | 是 | Night-rest HR average. |
metrics.nightRestHrAverage.value | number|null | 是 | Average value. |
metrics.nightRestHrAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestHrAverage.baseline | object | 是 | Night-rest HR baseline baseline. |
metrics.nightRestHrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestHrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestHrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestHrAverage | object | 是 | All-day rest HR average. |
metrics.allDayRestHrAverage.value | number|null | 是 | Average value. |
metrics.allDayRestHrAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestHrAverage.baseline | object | 是 | All-day rest HR baseline baseline. |
metrics.allDayRestHrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestHrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestHrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.hourlyPoints | array<array<number>> | 是 | 24 buckets of sampled points. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "day",
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
HR week request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "week",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 7,
"validNights": 1
},
"metrics": {
"nightRestHrAverage": {
"value": 82,
"sampleCount": 8,
"baseline": {
"baselineLower": 72,
"baselineUpper": 92,
"baselineSource": "personal"
}
},
"allDayRestHrAverage": {
"value": 82,
"sampleCount": 8,
"baseline": {
"baselineLower": 72,
"baselineUpper": 92,
"baselineSource": "personal"
}
},
"dailyNightRestHr": [
{
"date": "2026-07-13",
"nightRestHrAverage": 82,
"sampleCount": 8
},
{
"date": "2026-07-14",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-15",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-16",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-17",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-18",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-19",
"nightRestHrAverage": null,
"sampleCount": 0
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.endDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer | 是 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer | 是 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.validNights | integer | 是 | Previous valid nights. |
previousPeriod.nightRestHrAverage | number | 是 | Previous night-rest HR average. |
previousPeriod.allDayRestHrAverage | number|null | 是 | Previous all-day rest HR average. |
previousPeriod.highNightRestHrCount | integer | 是 | Previous high night-rest HR count. |
previousPeriod.lowNightRestHrCount | integer | 是 | Previous low night-rest HR count. |
metrics.nightRestHrAverage | object | 是 | Night-rest HR average. |
metrics.nightRestHrAverage.value | number|null | 是 | Average value. |
metrics.nightRestHrAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestHrAverage.baseline | object | 是 | Night-rest HR baseline baseline. |
metrics.nightRestHrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestHrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestHrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestHrAverage | object | 是 | All-day rest HR average. |
metrics.allDayRestHrAverage.value | number|null | 是 | Average value. |
metrics.allDayRestHrAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestHrAverage.baseline | object | 是 | All-day rest HR baseline baseline. |
metrics.allDayRestHrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestHrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestHrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.dailyNightRestHr | array<object> | 是 | Daily vital rows. |
metrics.dailyNightRestHr[].date | string(date) | 是 | Calendar date. |
metrics.dailyNightRestHr[].nightRestHrAverage | number|null | 是 | Daily night-rest value. |
metrics.dailyNightRestHr[].sampleCount | integer | 是 | Daily sample count. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "week",
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
HR month request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "month",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 31,
"validNights": 1
},
"metrics": {
"nightRestHrAverage": {
"value": 82,
"sampleCount": 8,
"baseline": {
"baselineLower": 72,
"baselineUpper": 92,
"baselineSource": "personal"
}
},
"allDayRestHrAverage": {
"value": 82,
"sampleCount": 8,
"baseline": {
"baselineLower": 72,
"baselineUpper": 92,
"baselineSource": "personal"
}
},
"dailyNightRestHr": [
{
"date": "2026-07-01",
"nightRestHrAverage": 82,
"sampleCount": 8
},
{
"date": "2026-07-02",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-03",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-04",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-05",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-06",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-07",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-08",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-09",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-10",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-11",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-12",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-13",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-14",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-15",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-16",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-17",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-18",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-19",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-20",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-21",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-22",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-23",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-24",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-25",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-26",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-27",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-28",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-29",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-30",
"nightRestHrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-31",
"nightRestHrAverage": null,
"sampleCount": 0
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Month requires one complete natural month. |
period.endDate | string(date) | 是 | Month requires one complete natural month. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer | 是 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer | 是 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.validNights | integer | 是 | Previous valid nights. |
previousPeriod.nightRestHrAverage | number | 是 | Previous night-rest HR average. |
previousPeriod.allDayRestHrAverage | number|null | 是 | Previous all-day rest HR average. |
previousPeriod.highNightRestHrCount | integer | 是 | Previous high night-rest HR count. |
previousPeriod.lowNightRestHrCount | integer | 是 | Previous low night-rest HR count. |
metrics.nightRestHrAverage | object | 是 | Night-rest HR average. |
metrics.nightRestHrAverage.value | number|null | 是 | Average value. |
metrics.nightRestHrAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestHrAverage.baseline | object | 是 | Night-rest HR baseline baseline. |
metrics.nightRestHrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestHrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestHrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestHrAverage | object | 是 | All-day rest HR average. |
metrics.allDayRestHrAverage.value | number|null | 是 | Average value. |
metrics.allDayRestHrAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestHrAverage.baseline | object | 是 | All-day rest HR baseline baseline. |
metrics.allDayRestHrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestHrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestHrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.dailyNightRestHr | array<object> | 是 | Daily vital rows. |
metrics.dailyNightRestHr[].date | string(date) | 是 | Calendar date. |
metrics.dailyNightRestHr[].nightRestHrAverage | number|null | 是 | Daily night-rest value. |
metrics.dailyNightRestHr[].sampleCount | integer | 是 | Daily sample count. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "hr",
"viewWindow": "month",
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
HRV day request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"night": {
"startAt": "2026-07-20T22:00:00+08:00",
"endAt": "2026-07-21T08:00:00+08:00",
"isCompleted": true
},
"nightRestRmssdAverage": {
"value": 48,
"sampleCount": 8,
"baseline": {
"baselineLower": 38,
"baselineUpper": 58,
"baselineSource": "personal"
}
},
"allDayRestRmssdAverage": {
"value": 48,
"sampleCount": 8,
"baseline": {
"baselineLower": 38,
"baselineUpper": 58,
"baselineSource": "personal"
}
},
"hourlyRmssdPoints": [
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Day requires the same start and end date. |
period.endDate | string(date) | 是 | Day requires the same start and end date. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
metrics.night | object | 是 | Night segment. |
metrics.night.startAt | string(date-time) | 是 | Night start. |
metrics.night.endAt | string(date-time) | 是 | Night end. |
metrics.night.isCompleted | boolean | 是 | Whether night collection is complete. |
metrics.nightRestRmssdAverage | object | 是 | Night-rest HRV average. |
metrics.nightRestRmssdAverage.value | number|null | 是 | Average value. |
metrics.nightRestRmssdAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestRmssdAverage.baseline | object | 是 | Night-rest HRV baseline baseline. |
metrics.nightRestRmssdAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestRmssdAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestRmssdAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestRmssdAverage | object | 是 | All-day rest HRV average. |
metrics.allDayRestRmssdAverage.value | number|null | 是 | Average value. |
metrics.allDayRestRmssdAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestRmssdAverage.baseline | object | 是 | All-day rest HRV baseline baseline. |
metrics.allDayRestRmssdAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestRmssdAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestRmssdAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.hourlyRmssdPoints | array<array<number>> | 是 | 24 buckets of sampled points. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "day",
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
HRV week request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "week",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 7,
"validNights": 1
},
"metrics": {
"nightRestRmssdAverage": {
"value": 48,
"sampleCount": 8,
"baseline": {
"baselineLower": 38,
"baselineUpper": 58,
"baselineSource": "personal"
}
},
"allDayRestRmssdAverage": {
"value": 48,
"sampleCount": 8,
"baseline": {
"baselineLower": 38,
"baselineUpper": 58,
"baselineSource": "personal"
}
},
"dailyNightRestRmssd": [
{
"date": "2026-07-13",
"nightRestRmssdAverage": 48,
"sampleCount": 8
},
{
"date": "2026-07-14",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-15",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-16",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-17",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-18",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-19",
"nightRestRmssdAverage": null,
"sampleCount": 0
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.endDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer | 是 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer | 是 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.validNights | integer | 是 | Previous valid nights. |
previousPeriod.nightRestRmssdAverage | number | 是 | Previous night-rest RMSSD average. |
previousPeriod.allDayRestRmssdAverage | number|null | 是 | Previous all-day rest RMSSD average. |
previousPeriod.lowNightRestRmssdCount | integer | 是 | Previous low night-rest RMSSD count. |
metrics.nightRestRmssdAverage | object | 是 | Night-rest HRV average. |
metrics.nightRestRmssdAverage.value | number|null | 是 | Average value. |
metrics.nightRestRmssdAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestRmssdAverage.baseline | object | 是 | Night-rest HRV baseline baseline. |
metrics.nightRestRmssdAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestRmssdAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestRmssdAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestRmssdAverage | object | 是 | All-day rest HRV average. |
metrics.allDayRestRmssdAverage.value | number|null | 是 | Average value. |
metrics.allDayRestRmssdAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestRmssdAverage.baseline | object | 是 | All-day rest HRV baseline baseline. |
metrics.allDayRestRmssdAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestRmssdAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestRmssdAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.dailyNightRestRmssd | array<object> | 是 | Daily vital rows. |
metrics.dailyNightRestRmssd[].date | string(date) | 是 | Calendar date. |
metrics.dailyNightRestRmssd[].nightRestRmssdAverage | number|null | 是 | Daily night-rest value. |
metrics.dailyNightRestRmssd[].sampleCount | integer | 是 | Daily sample count. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "week",
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
HRV month request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "month",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 31,
"validNights": 1
},
"metrics": {
"nightRestRmssdAverage": {
"value": 48,
"sampleCount": 8,
"baseline": {
"baselineLower": 38,
"baselineUpper": 58,
"baselineSource": "personal"
}
},
"allDayRestRmssdAverage": {
"value": 48,
"sampleCount": 8,
"baseline": {
"baselineLower": 38,
"baselineUpper": 58,
"baselineSource": "personal"
}
},
"dailyNightRestRmssd": [
{
"date": "2026-07-01",
"nightRestRmssdAverage": 48,
"sampleCount": 8
},
{
"date": "2026-07-02",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-03",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-04",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-05",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-06",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-07",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-08",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-09",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-10",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-11",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-12",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-13",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-14",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-15",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-16",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-17",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-18",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-19",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-20",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-21",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-22",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-23",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-24",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-25",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-26",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-27",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-28",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-29",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-30",
"nightRestRmssdAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-31",
"nightRestRmssdAverage": null,
"sampleCount": 0
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Month requires one complete natural month. |
period.endDate | string(date) | 是 | Month requires one complete natural month. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer | 是 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer | 是 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.validNights | integer | 是 | Previous valid nights. |
previousPeriod.nightRestRmssdAverage | number | 是 | Previous night-rest RMSSD average. |
previousPeriod.allDayRestRmssdAverage | number|null | 是 | Previous all-day rest RMSSD average. |
previousPeriod.lowNightRestRmssdCount | integer | 是 | Previous low night-rest RMSSD count. |
metrics.nightRestRmssdAverage | object | 是 | Night-rest HRV average. |
metrics.nightRestRmssdAverage.value | number|null | 是 | Average value. |
metrics.nightRestRmssdAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestRmssdAverage.baseline | object | 是 | Night-rest HRV baseline baseline. |
metrics.nightRestRmssdAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestRmssdAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestRmssdAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestRmssdAverage | object | 是 | All-day rest HRV average. |
metrics.allDayRestRmssdAverage.value | number|null | 是 | Average value. |
metrics.allDayRestRmssdAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestRmssdAverage.baseline | object | 是 | All-day rest HRV baseline baseline. |
metrics.allDayRestRmssdAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestRmssdAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestRmssdAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.dailyNightRestRmssd | array<object> | 是 | Daily vital rows. |
metrics.dailyNightRestRmssd[].date | string(date) | 是 | Calendar date. |
metrics.dailyNightRestRmssd[].nightRestRmssdAverage | number|null | 是 | Daily night-rest value. |
metrics.dailyNightRestRmssd[].sampleCount | integer | 是 | Daily sample count. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "hrv",
"viewWindow": "month",
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
RR day request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"night": {
"startAt": "2026-07-20T22:00:00+08:00",
"endAt": "2026-07-21T08:00:00+08:00",
"isCompleted": true
},
"nightRestRrAverage": {
"value": 22,
"sampleCount": 8,
"baseline": {
"baselineLower": 12,
"baselineUpper": 32,
"baselineSource": "personal"
}
},
"allDayRestRrAverage": {
"value": 22,
"sampleCount": 8,
"baseline": {
"baselineLower": 12,
"baselineUpper": 32,
"baselineSource": "personal"
}
},
"hourlyPoints": [
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Day requires the same start and end date. |
period.endDate | string(date) | 是 | Day requires the same start and end date. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
metrics.night | object | 是 | Night segment. |
metrics.night.startAt | string(date-time) | 是 | Night start. |
metrics.night.endAt | string(date-time) | 是 | Night end. |
metrics.night.isCompleted | boolean | 是 | Whether night collection is complete. |
metrics.nightRestRrAverage | object | 是 | Night-rest RR average. |
metrics.nightRestRrAverage.value | number|null | 是 | Average value. |
metrics.nightRestRrAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestRrAverage.baseline | object | 是 | Night-rest RR baseline baseline. |
metrics.nightRestRrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestRrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestRrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestRrAverage | object | 是 | All-day rest RR average. |
metrics.allDayRestRrAverage.value | number|null | 是 | Average value. |
metrics.allDayRestRrAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestRrAverage.baseline | object | 是 | All-day rest RR baseline baseline. |
metrics.allDayRestRrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestRrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestRrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.hourlyPoints | array<array<number>> | 是 | 24 buckets of sampled points. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "day",
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
RR week request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "week",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 7,
"validNights": 1
},
"metrics": {
"nightRestRrAverage": {
"value": 22,
"sampleCount": 8,
"baseline": {
"baselineLower": 12,
"baselineUpper": 32,
"baselineSource": "personal"
}
},
"allDayRestRrAverage": {
"value": 22,
"sampleCount": 8,
"baseline": {
"baselineLower": 12,
"baselineUpper": 32,
"baselineSource": "personal"
}
},
"dailyNightRestRr": [
{
"date": "2026-07-13",
"nightRestRrAverage": 22,
"sampleCount": 8
},
{
"date": "2026-07-14",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-15",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-16",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-17",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-18",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-19",
"nightRestRrAverage": null,
"sampleCount": 0
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.endDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer | 是 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer | 是 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.validNights | integer | 是 | Previous valid nights. |
previousPeriod.nightRestRrAverage | number | 是 | Previous night-rest RR average. |
previousPeriod.allDayRestRrAverage | number|null | 是 | Previous all-day rest RR average. |
previousPeriod.highNightRestRrCount | integer | 是 | Previous high night-rest RR count. |
metrics.nightRestRrAverage | object | 是 | Night-rest RR average. |
metrics.nightRestRrAverage.value | number|null | 是 | Average value. |
metrics.nightRestRrAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestRrAverage.baseline | object | 是 | Night-rest RR baseline baseline. |
metrics.nightRestRrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestRrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestRrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestRrAverage | object | 是 | All-day rest RR average. |
metrics.allDayRestRrAverage.value | number|null | 是 | Average value. |
metrics.allDayRestRrAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestRrAverage.baseline | object | 是 | All-day rest RR baseline baseline. |
metrics.allDayRestRrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestRrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestRrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.dailyNightRestRr | array<object> | 是 | Daily vital rows. |
metrics.dailyNightRestRr[].date | string(date) | 是 | Calendar date. |
metrics.dailyNightRestRr[].nightRestRrAverage | number|null | 是 | Daily night-rest value. |
metrics.dailyNightRestRr[].sampleCount | integer | 是 | Daily sample count. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "week",
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
RR month request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "month",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true,
"elapsedNights": 31,
"validNights": 1
},
"metrics": {
"nightRestRrAverage": {
"value": 22,
"sampleCount": 8,
"baseline": {
"baselineLower": 12,
"baselineUpper": 32,
"baselineSource": "personal"
}
},
"allDayRestRrAverage": {
"value": 22,
"sampleCount": 8,
"baseline": {
"baselineLower": 12,
"baselineUpper": 32,
"baselineSource": "personal"
}
},
"dailyNightRestRr": [
{
"date": "2026-07-01",
"nightRestRrAverage": 22,
"sampleCount": 8
},
{
"date": "2026-07-02",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-03",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-04",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-05",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-06",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-07",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-08",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-09",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-10",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-11",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-12",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-13",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-14",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-15",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-16",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-17",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-18",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-19",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-20",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-21",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-22",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-23",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-24",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-25",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-26",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-27",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-28",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-29",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-30",
"nightRestRrAverage": null,
"sampleCount": 0
},
{
"date": "2026-07-31",
"nightRestRrAverage": null,
"sampleCount": 0
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Month requires one complete natural month. |
period.endDate | string(date) | 是 | Month requires one complete natural month. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer | 是 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer | 是 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.validNights | integer | 是 | Previous valid nights. |
previousPeriod.nightRestRrAverage | number | 是 | Previous night-rest RR average. |
previousPeriod.allDayRestRrAverage | number|null | 是 | Previous all-day rest RR average. |
previousPeriod.highNightRestRrCount | integer | 是 | Previous high night-rest RR count. |
metrics.nightRestRrAverage | object | 是 | Night-rest RR average. |
metrics.nightRestRrAverage.value | number|null | 是 | Average value. |
metrics.nightRestRrAverage.sampleCount | integer | 是 | Sample count. |
metrics.nightRestRrAverage.baseline | object | 是 | Night-rest RR baseline baseline. |
metrics.nightRestRrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.nightRestRrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.nightRestRrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.allDayRestRrAverage | object | 是 | All-day rest RR average. |
metrics.allDayRestRrAverage.value | number|null | 是 | Average value. |
metrics.allDayRestRrAverage.sampleCount | integer | 是 | Sample count. |
metrics.allDayRestRrAverage.baseline | object | 是 | All-day rest RR baseline baseline. |
metrics.allDayRestRrAverage.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.allDayRestRrAverage.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.allDayRestRrAverage.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.dailyNightRestRr | array<object> | 是 | Daily vital rows. |
metrics.dailyNightRestRr[].date | string(date) | 是 | Calendar date. |
metrics.dailyNightRestRr[].nightRestRrAverage | number|null | 是 | Daily night-rest value. |
metrics.dailyNightRestRr[].sampleCount | integer | 是 | Daily sample count. |
metrics.context | object | 否 | Optional environment context. |
metrics.context.weather | enum | 否 | Weather code. |
metrics.context.tempMaxC | number | 否 | Max temperature in Celsius. |
metrics.context.feelsLikeMaxC | number | 否 | Max feels-like temperature in Celsius. |
metrics.context.temperatureCelsius | number | 否 | Observed temperature in Celsius. |
metrics.context.humidityPct | number | 否 | Humidity percentage. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "rr",
"viewWindow": "month",
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
Bark day request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "day",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"barkEventCount": 2,
"longestBarkEventDurationSeconds": 70,
"baseline": {
"baselineLower": 20,
"baselineUpper": 150,
"baselineSource": "personal"
},
"barkEvents": [
{
"startAt": "2026-07-21T09:00:00+08:00",
"endAt": "2026-07-21T09:01:10+08:00",
"durationSeconds": 70,
"intensity": "high",
"locationType": "home"
},
{
"startAt": "2026-07-21T18:00:00+08:00",
"endAt": "2026-07-21T18:00:50+08:00",
"durationSeconds": 50,
"intensity": "medium",
"locationType": "outdoor"
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Day requires the same start and end date. |
period.endDate | string(date) | 是 | Day requires the same start and end date. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
metrics.wearingMinutes | integer | 是 | Daily wearing minutes. |
metrics.barkDurationSeconds | integer | 是 | Total bark duration seconds. |
metrics.barkEventCount | integer | 是 | Bark event count. |
metrics.longestBarkEventDurationSeconds | integer | 是 | Longest bark event duration seconds. |
metrics.baseline | object | 是 | Bark baseline baseline. |
metrics.baseline.baselineLower | number|null | 是 | Baseline lower bound. |
metrics.baseline.baselineUpper | number|null | 是 | Baseline upper bound. |
metrics.baseline.baselineSource | enum | 是 | Baseline source. |
metrics.barkEvents | array<object> | 是 | Bark event list. |
metrics.barkEvents[].startAt | string(date-time) | 是 | Bark event start. |
metrics.barkEvents[].endAt | string(date-time) | 是 | Bark event end. |
metrics.barkEvents[].durationSeconds | integer | 是 | Bark event duration seconds. |
metrics.barkEvents[].intensity | enum | 是 | Bark event intensity. |
metrics.barkEvents[].locationType | enum | 是 | Bark event location type. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "day",
"period": {
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
Bark week request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "week",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutes": 10080,
"averageDailyBarkDurationSeconds": 120,
"barkEventCount": 14,
"anomalyDayCount": 0,
"dailyBarkDurations": [
{
"date": "2026-07-13",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-14",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-15",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-16",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-17",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-18",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-19",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.endDate | string(date) | 是 | Week requires seven consecutive calendar days. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.averageDailyBarkDurationSeconds | number | 是 | Previous average daily bark duration. |
previousPeriod.barkEventCount | integer | 是 | Previous bark event count. |
previousPeriod.anomalyDayCount | integer | 是 | Previous anomaly day count. |
metrics.wearingMinutes | integer | 是 | Aggregate wearing minutes. |
metrics.averageDailyBarkDurationSeconds | number | 是 | Average daily bark duration seconds. |
metrics.barkEventCount | integer | 是 | Aggregate bark event count. |
metrics.anomalyDayCount | integer | 是 | Anomaly day count. |
metrics.dailyBarkDurations | array<object> | 是 | Daily bark rows. |
metrics.dailyBarkDurations[].date | string(date) | 是 | Calendar date. |
metrics.dailyBarkDurations[].wearingMinutes | integer|null | 是 | Daily wearing minutes. |
metrics.dailyBarkDurations[].barkDurationSeconds | integer|null | 是 | Daily bark duration seconds. |
metrics.dailyBarkDurations[].isAnomaly | boolean|null | 是 | Whether the day is anomalous. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "week",
"period": {
"startDate": "2026-07-13",
"endDate": "2026-07-19",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
Bark month request and response contract.
{
"schemaVersion": "health-detail-v3",
"userId": "user-1",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "month",
"locale": "zh-CN",
"petProfile": {
"name": "Pocky",
"species": "dog",
"healthRiskTags": []
},
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"metrics": {
"wearingMinutes": 44640,
"averageDailyBarkDurationSeconds": 120,
"barkEventCount": 62,
"anomalyDayCount": 0,
"dailyBarkDurations": [
{
"date": "2026-07-01",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-02",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-03",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-04",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-05",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-06",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-07",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-08",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-09",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-10",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-11",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-12",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-13",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-14",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-15",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-16",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-17",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-18",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-19",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-20",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-21",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-22",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-23",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-24",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-25",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-26",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-27",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-28",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-29",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-30",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
},
{
"date": "2026-07-31",
"wearingMinutes": 1440,
"barkDurationSeconds": 120,
"isAnomaly": false
}
]
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
schemaVersion | string | 是 | Fixed to health-detail-v3. |
userId | string | 是 | Caller user ID. |
petId | string | 是 | Caller pet ID. |
metric | enum | 是 | Metric selector. |
viewWindow | enum | 是 | View window selector. |
locale | enum | 否 | Summary locale. |
petProfile | object | 是 | Pet profile. |
petProfile.name | string | 是 | Display name. |
petProfile.species | enum | 是 | Pet species. |
petProfile.activityTolerance | enum|null | 否 | Activity tolerance. |
petProfile.heatTolerance | enum|null | 否 | Heat tolerance. |
petProfile.coldTolerance | enum|null | 否 | Cold tolerance. |
petProfile.humidHeatSensitivity | enum|null | 否 | Humid heat sensitivity. |
petProfile.healthRiskTags | array<enum> | 否 | Known risk tags. |
period | object | 是 | Requested period. |
period.startDate | string(date) | 是 | Month requires one complete natural month. |
period.endDate | string(date) | 是 | Month requires one complete natural month. |
period.timezone | string | 是 | IANA timezone, for example Asia/Shanghai. |
period.isCompleted | boolean | 是 | Whether the current period is complete. |
period.elapsedNights | integer|null | 否 | Elapsed nights for aggregate sleep/vital windows. |
period.validNights | integer|null | 否 | Valid nights for aggregate sleep/vital windows. |
metrics | object | 是 | Metric facts for the selected surface. |
previousPeriod | object | 否 | Optional adjacent previous period facts. |
previousPeriod.startDate | string(date) | 是 | Previous period start date. |
previousPeriod.endDate | string(date) | 是 | Previous period end date. |
previousPeriod.isCompleted | boolean | 是 | Must be true. |
previousPeriod.averageDailyBarkDurationSeconds | number | 是 | Previous average daily bark duration. |
previousPeriod.barkEventCount | integer | 是 | Previous bark event count. |
previousPeriod.anomalyDayCount | integer | 是 | Previous anomaly day count. |
metrics.wearingMinutes | integer | 是 | Aggregate wearing minutes. |
metrics.averageDailyBarkDurationSeconds | number | 是 | Average daily bark duration seconds. |
metrics.barkEventCount | integer | 是 | Aggregate bark event count. |
metrics.anomalyDayCount | integer | 是 | Anomaly day count. |
metrics.dailyBarkDurations | array<object> | 是 | Daily bark rows. |
metrics.dailyBarkDurations[].date | string(date) | 是 | Calendar date. |
metrics.dailyBarkDurations[].wearingMinutes | integer|null | 是 | Daily wearing minutes. |
metrics.dailyBarkDurations[].barkDurationSeconds | integer|null | 是 | Daily bark duration seconds. |
metrics.dailyBarkDurations[].isAnomaly | boolean|null | 是 | Whether the day is anomalous. |
{
"insightId": "health_detail_01J",
"petId": "pet-1",
"metric": "bark",
"viewWindow": "month",
"period": {
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"timezone": "Asia/Shanghai",
"isCompleted": true
},
"status": "normal",
"severity": "none",
"summary": "Metric is stable.",
"generation": {
"ruleId": "DOCUMENTATION_EXAMPLE",
"ruleVersion": "health-detail-v3",
"generatedAt": "2026-07-23T10:00:00Z",
"aiPolished": false
}
}| 字段名 | 数据类型 | 是否必需 | 详细说明 |
|---|---|---|---|
insightId | string | 是 | Gateway insight ID. |
petId | string | 是 | Echoed pet ID. |
metric | enum | 是 | Echoed metric. |
viewWindow | enum | 是 | Echoed window. |
period | object | 是 | Normalized request period. |
status | enum | 是 | Primary status. |
severity | enum | 是 | Primary severity. |
summary | string | 是 | Localized summary. |
generation | object | 是 | Generation metadata. |
/v1/pet-diaries/generate 使用 V2 请求结构。主服务传 user_id、可选 locale，以及完整 dailyDiarySnapshot；pet_id 从 dailyDiarySnapshot.petProfile.petId 派生，不再作为顶层字段传入。
根据当天事实快照生成宠物日记。默认响应只返回主服务展示、落库和配图选择需要的字段；include_debug=true 时才返回调试字段。
调用语义：同一 user_id、dailyDiarySnapshot.petProfile.petId 与日期的成功日记会直接返回已保存结果，不会重复调用模型；hasActiveP0=true 时保留可信正文，但推送候选文案和宠物一句话均为空。
| 字段 | 位置 | 类型 | 必填 | 枚举/范围 | 说明 |
|---|---|---|---|---|---|
Authorization | Header | string | 是 | Bearer API Key | 需要允许访问 /v1/pet-diaries/generate 且允许模型 uah-diary。 |
X-Request-ID | Header | string | 否 | 1-128 | 调用方链路追踪 ID。 |
request_id | Body | string|null | 否 | 1-128 | 请求链路 ID。 |
user_id | Body | string | 否 | 1-128 | 用户 ID；未传时使用默认临时 ID。 |
locale | Body | string|null | 否 | zh-CN / en-US / null | 不传或传 null 时返回中英双语。 |
dailyDiarySnapshot | Body | object | 是 | DailyDiarySnapshotV2 | 当天事实快照根对象。 |
dailyDiarySnapshot.petProfile.petId | Body | string | 是 | 1-128 | 宠物 ID；必须与 dailyDiarySnapshot.diaryTimeline.petId 一致。 |
dailyDiarySnapshot.petProfile.petName | Body | string | 是 | 1-128 | 宠物昵称。 |
dailyDiarySnapshot.petProfile.species | Body | string | 是 | dog / cat | 宠物类型。 |
dailyDiarySnapshot.petProfile.breed | Body | string|null | 否 | 0-128 | 品种名称。 |
dailyDiarySnapshot.petProfile.breedTags[] | Body | string[] | 否 | - | 品种标签。 |
dailyDiarySnapshot.petProfile.bodySize | Body | string|null | 否 | toy / small / medium / large / giant | 体型枚举，对齐品种基线 body_size_class。 |
dailyDiarySnapshot.petProfile.ageMonths | Body | integer|null | 否 | >= 0 | 宠物月龄。 |
dailyDiarySnapshot.petProfile.ageStage | Body | string|null | 否 | puppy / adult / senior | 生命阶段；猫幼年也使用 puppy。 |
dailyDiarySnapshot.environmentContext.date | Body | date | 是 | YYYY-MM-DD | 日记日期；必须与 dailyDiarySnapshot.diaryTimeline.date 一致。 |
dailyDiarySnapshot.environmentContext.timezone | Body | string | 是 | 1-64 | 日记时区。 |
dailyDiarySnapshot.environmentContext.weekday | Body | string|null | 否 | - | 规范英文星期名；日期行的星期由 date 按 locale 渲染。 |
dailyDiarySnapshot.environmentContext.weather | Body | string|null | 否 | - | 天气文本。 |
dailyDiarySnapshot.environmentContext.temperature | Body | object|null | 否 | currentC / minC / maxC 均为 number|null | 温度对象；不接受数值或字符串简写。 |
dailyDiarySnapshot.environmentContext.season | Body | string|null | 否 | spring / summer / autumn / winter | 季节。 |
dailyDiarySnapshot.environmentContext.specialDay | Body | string|null | 否 | 0-128 | 生日、节日、纪念日等重要日期。 |
dailyDiarySnapshot.previousNightSleep.totalMinutes | Body | integer | 是 | 0-1440 | 昨晚总睡眠分钟数；对象存在时必填。 |
dailyDiarySnapshot.previousNightSleep.wakeCount | Body | integer|null | 否 | >= 0 | 昨晚醒动次数。 |
dailyDiarySnapshot.eveningRestStart.startedAt | Body | string | 是 | HH:mm | 当晚开始安静的本地时刻；对象存在时必填。 |
dailyDiarySnapshot.dailyActivity.activeMinutes | Body | integer|null | 否 | >= 0 | 当天累计活动分钟数。 |
dailyDiarySnapshot.dailyActivity.steps | Body | integer|null | 否 | >= 0 | 当天累计步数。 |
dailyDiarySnapshot.dailyActivity.outdoorMinutes | Body | integer|null | 否 | >= 0 | 当天累计户外分钟数。 |
dailyDiarySnapshot.diaryTimeline.schemaVersion | Body | string | 是 | 1-32 | 时间线 schema 版本。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[] | Body | array | 否 | MainSceneSegment[] | 当天主场景分段。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].sceneType | Body | string | 是 | home / away | 主场景类型；不接受 unknown。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].startTime | Body | string|null | 否 | 0-64 | 开始时间文本。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].endTime | Body | string|null | 否 | 0-64 | 结束时间文本。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].placeSummary.placeName | Body | string|null | 否 | 0-128 | 地点名称。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].placeSummary.placeType | Body | string|null | 否 | 0-64 | 地点类型，如 home、park、clinic。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].outingActivityType | Body | string|null | 否 | walk / other | 外出活动类型；仅 away 时可传。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].walkMetrics.durationMin | Body | integer|null | 否 | >= 0 | 步行时长分钟数；仅 away + walk 时传。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].walkMetrics.distanceKm | Body | number|null | 否 | >= 0 | 步行距离公里数。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].walkMetrics.steps | Body | integer|null | 否 | >= 0 | 步行步数。 |
dailyDiarySnapshot.diaryTimeline.mainSceneSegments[].companionName | Body | string|null | 否 | 0-128 | 陪同人姓名；仅高可信时传。 |
dailyDiarySnapshot.diaryTimeline.outingTimeline[] | Body | array | 否 | OutingTimelineEvent[] | 外出过程事件列表，用于表达从出门、到达地点、离开地点到回家的顺序。 |
dailyDiarySnapshot.diaryTimeline.outingTimeline[].type | Body | string | 是 | depart / arrive_place / leave_place / return_home / enter_zone / leave_zone | 外出时间线事件类型；区域事件必须携带 place.zoneRole。 |
dailyDiarySnapshot.diaryTimeline.outingTimeline[].occurredTime | Body | string|null | 否 | 0-64 | 事件发生时间文本，建议传本地时间，如 14:05。 |
dailyDiarySnapshot.diaryTimeline.outingTimeline[].place.placeName | Body | string|null | 否 | 0-128 | 事件关联地点名称。 |
dailyDiarySnapshot.diaryTimeline.outingTimeline[].place.placeType | Body | string|null | 否 | 0-64 | 事件关联地点类型。 |
dailyDiarySnapshot.diaryTimeline.healthTimeline[] | Body | array | 否 | HealthTimelineEvent[] | 健康指标事实列表，只表达 HR / HRV / RR 的可信数值事实，不承载诊断、原因解释或展示文案。 |
dailyDiarySnapshot.diaryTimeline.healthTimeline[].type | Body | string | 是 | heart_rate / hrv / respiration_rate | 健康指标类型。 |
dailyDiarySnapshot.diaryTimeline.healthTimeline[].occurredTime | Body | string|null | 否 | 0-64 | 指标发生时间文本，建议传本地时间或时间段，如 20:10、night。 |
dailyDiarySnapshot.diaryTimeline.healthTimeline[].heartRateBpm | Body | number|null | 否 | > 0 | 心率，单位 bpm；仅 type=heart_rate 时使用。 |
dailyDiarySnapshot.diaryTimeline.healthTimeline[].hrvMs | Body | number|null | 否 | > 0 | HRV，单位 ms；仅 type=hrv 时使用。 |
dailyDiarySnapshot.diaryTimeline.healthTimeline[].respirationRateRpm | Body | number|null | 否 | > 0 | 呼吸率，单位 rpm；仅 type=respiration_rate 时使用。 |
dailyDiarySnapshot.diaryTimeline.healthTimeline[].baselineValue | Body | number|null | 否 | > 0 | 对应指标的个体基线值，单位与当前指标一致。 |
dailyDiarySnapshot.diaryTimeline.healthTimeline[].baselineDiffPercent | Body | number|null | 否 | - | 当前值相对个体基线的变化百分比；正数表示高于基线，负数表示低于基线。 |
dailyDiarySnapshot.diaryTimeline.behaviorTimeline[] | Body | array | 否 | BehaviorTimelineEvent[] | 行为时间线事件列表，用于表达叫声、进食、喝水、抓挠、转圈、甩头、舔舐等行为。 |
dailyDiarySnapshot.diaryTimeline.behaviorTimeline[].type | Body | string | 是 | bark / drink / eat / scratch / circle / head_shake / lick | 行为时间线事件类型。 |
dailyDiarySnapshot.diaryTimeline.behaviorTimeline[].occurredTime | Body | string|null | 否 | 0-64 | 行为发生时间文本，建议传本地时间或时间段，如 16:20、afternoon。 |
dailyDiarySnapshot.diaryTimeline.behaviorTimeline[].durationMin | Body | integer|null | 否 | >= 0 | 行为持续分钟数。 |
dailyDiarySnapshot.imageHistory.recentImages[] | Body | array | 否 | 由近到远 | 已实际展示给该宠物的配图历史；缺省等价于空数组。 |
dailyDiarySnapshot.imageHistory.recentImages[].sceneId | Body | string|null | 否 | 1-128 | 已展示配图所属的图库场景 ID；配图冷却按它计算。 |
dailyDiarySnapshot.imageHistory.recentImages[].imageId | Body | string|null | 否 | 1-128 | 图库图片 ID；只传 imageId 时由网关反查场景。与 sceneId 至少提供一个。 |
dailyDiarySnapshot.imageHistory.recentImages[].usedDate | Body | date | 是 | YYYY-MM-DD | 该配图实际展示的本地日期。 |
template_id | Body | string|null | 否 | 1-128 | 模板 ID，仅用于测试或追踪。 |
template_version | Body | string|null | 否 | 1-64 | 模板版本，仅用于测试或追踪。 |
dailyDiarySnapshot.imageHistory 与配图冷却响应里的 image_scene_id 从当前物种的全部图库场景中选出（狗 54 个、猫 50 个）：带 date_rule 的节日和季节场景只在该日期规则成立时参选；再按季节、天气、在家/外出、活动匹配打分；最后对冷却窗口（默认 14 天）内已用过的场景降权，实现轮换。
冷却历史来自三处并集：本次请求的 imageHistory.recentImages、网关已保存日记的历史配图、网关自身的每日选图记录。因此主服务即使暂时不回传历史，同一场景也不会连日重复。
{
"imageHistory": {
"recentImages": [
{ "sceneId": "outdoor_walk_autumn", "usedDate": "2026-06-28" },
{ "sceneId": "indoor_curl_sleep", "usedDate": "2026-06-26" }
]
}
}三个时间线都按时间顺序传入。外出和行为事件使用固定枚举；健康时间线只保留 HR / HRV / RR 指标事实。
{
"outingTimeline": [
{
"type": "depart",
"occurredTime": "14:05",
"place": {
"placeName": "Home",
"placeType": "home"
}
},
{
"type": "arrive_place",
"occurredTime": "14:22",
"place": {
"placeName": "Central Park",
"placeType": "park"
}
},
{
"type": "leave_place",
"occurredTime": "15:35",
"place": {
"placeName": "Central Park",
"placeType": "park"
}
},
{
"type": "return_home",
"occurredTime": "15:52",
"place": {
"placeName": "Home",
"placeType": "home"
}
}
],
"healthTimeline": [
{
"type": "heart_rate",
"occurredTime": "20:10",
"heartRateBpm": 110,
"baselineValue": 73,
"baselineDiffPercent": 50.7
},
{
"type": "hrv",
"occurredTime": "night",
"hrvMs": 42,
"baselineValue": 50,
"baselineDiffPercent": -16
},
{
"type": "respiration_rate",
"occurredTime": "21:00",
"respirationRateRpm": 28,
"baselineValue": 22,
"baselineDiffPercent": 27.3
}
],
"behaviorTimeline": [
{
"type": "bark",
"occurredTime": "16:20",
"durationMin": 4
},
{
"type": "eat",
"occurredTime": "18:10",
"durationMin": 8
}
]
}{
"request_id": "req_diary_001",
"user_id": "temporary",
"locale": null,
"dailyDiarySnapshot": {
"petProfile": {
"petId": "temporary",
"petName": "Milo",
"species": "dog",
"breed": "Labrador",
"breedTags": ["retriever"],
"bodySize": "large",
"ageStage": "adult",
"ageMonths": 48
},
"environmentContext": {
"date": "2026-07-01",
"timezone": "Asia/Shanghai",
"weekday": "Wednesday",
"weather": "sunny",
"temperature": {
"currentC": 26
},
"season": "summer",
"specialDay": "birthday"
},
"previousNightSleep": {
"totalMinutes": 540,
"wakeCount": 2
},
"eveningRestStart": {
"startedAt": "21:30"
},
"dailyActivity": {
"activeMinutes": 70,
"steps": 5200,
"outdoorMinutes": 60
},
"diaryTimeline": {
"schemaVersion": "1.0",
"mainSceneSegments": [
{
"sceneType": "away",
"startTime": "14:05",
"endTime": "15:52",
"placeSummary": {
"placeName": "Central Park",
"placeType": "park"
},
"outingActivityType": "walk",
"walkMetrics": {
"durationMin": 107,
"distanceKm": 1.3,
"steps": 1900
}
}
],
"outingTimeline": [
{
"type": "depart",
"occurredTime": "14:05",
"place": {
"placeName": "Home",
"placeType": "home"
}
},
{
"type": "arrive_place",
"occurredTime": "14:22",
"place": {
"placeName": "Central Park",
"placeType": "park"
}
},
{
"type": "return_home",
"occurredTime": "15:52",
"place": {
"placeName": "Home",
"placeType": "home"
}
}
],
"healthTimeline": [
{
"type": "heart_rate",
"occurredTime": "20:10",
"heartRateBpm": 110,
"baselineValue": 73,
"baselineDiffPercent": 50.7
}
],
"behaviorTimeline": [
{
"type": "bark",
"occurredTime": "16:20",
"durationMin": 4
}
]
},
"imageHistory": {
"recentImages": [
{ "sceneId": "outdoor_walk_summer", "usedDate": "2026-06-30" },
{ "sceneId": "indoor_curl_sleep", "usedDate": "2026-06-28" }
]
}
},
"template_id": "park_day",
"template_version": "v2"
}diary_id | string | yes | dia_* | Diary record ID. |
request_id | string | yes | 1-128 | Request trace ID. |
date | date | yes | YYYY-MM-DD | Diary date. |
image_scene_id | string|null | no | scene ID or null | Recommended diary image scene ID. |
contents | object | yes | zh-CN / en-US | Localized diary contents. Default bilingual requests return both keys; explicit locale requests return the requested key only. |
contents.zh-CN.date_line | string | conditional | - | Chinese display date line. |
contents.zh-CN.paragraphs[] | string[] | conditional | - | Chinese diary paragraphs. |
contents.zh-CN.pet_one_liner | string | conditional | - | Chinese pet one-liner. |
contents.zh-CN.push_title | string|null | conditional | - | Chinese recommended push title. |
contents.zh-CN.push_body | string|null | conditional | - | Chinese recommended push body. |
contents.en-US.date_line | string | conditional | - | English display date line. |
contents.en-US.paragraphs[] | string[] | conditional | - | English diary paragraphs. |
contents.en-US.pet_one_liner | string | conditional | - | English pet one-liner. |
contents.en-US.push_title | string|null | conditional | - | English recommended push title. |
contents.en-US.push_body | string|null | conditional | - | English recommended push body. |
generation_status | string | yes | GENERATED / GENERATED_PUSH_SUPPRESSED_BY_SAFETY / DATA_INSUFFICIENT / FAILED_GENERATION / FAILED_SAFE_CHECK | Generation status. |
failure_reason | string|null | no | reason code or null | Failure reason. |
{
"diary_id": "dia_xxx",
"request_id": "req_diary_001",
"date": "2026-07-01",
"image_scene_id": "birthday_outdoor",
"contents": {
"zh-CN": {
"date_line": "2026-07-01 Wednesday",
"paragraphs": [
"Milo had a birthday walk at Central Park today.",
"Milo barked briefly around 16:20, like a small report about the day."
],
"pet_one_liner": "I remember the park.",
"push_title": "Milo had a birthday walk today",
"push_body": "Milo spent a little over an hour at the park."
},
"en-US": {
"date_line": "Wednesday, July 1, 2026",
"paragraphs": [
"Today was Milo's birthday. In the afternoon, Milo went to Central Park and walked for a little over an hour.",
"Around 16:20, Milo barked briefly, almost like reporting the day's discoveries."
],
"pet_one_liner": "Birthday grass. I remember.",
"push_title": "Milo had a birthday walk today",
"push_body": "Milo spent a little over an hour at the park and gave a small report afterward."
}
},
"generation_status": "GENERATED",
"failure_reason": null
}user_id | Query | string|null | no | 1-128 | Filter by user ID. |
items[].diary_id | string | yes | dia_* | Diary record ID. |
items[].contents.zh-CN.paragraphs[] | string[] | conditional | - | Chinese diary paragraphs. |
items[].contents.en-US.paragraphs[] | string[] | conditional | - | English diary paragraphs. |
{
"items": [
{
"diary_id": "dia_xxx",
"contents": {
"zh-CN": {
"paragraphs": ["Milo spent a little over an hour at the park today."]
},
"en-US": {
"paragraphs": ["Milo spent a little over an hour at the park today."]
}
}
}
]
}diary_id | Path | string | yes | dia_* | Diary record ID. |
diary_id | string | yes | dia_* | Diary record ID. |
contents.zh-CN.paragraphs[] | string[] | conditional | - | Chinese diary paragraphs. |
contents.en-US.paragraphs[] | string[] | conditional | - | English diary paragraphs. |
{
"diary_id": "dia_xxx",
"contents": {
"zh-CN": {
"paragraphs": ["Milo spent a little over an hour at the park today."]
},
"en-US": {
"paragraphs": ["Milo spent a little over an hour at the park today."]
}
}
}Submit feedback for an AI diary. Re-submitting a diary ID replaces its latest feedback.
{
"diary_id": "dia_123456",
"liked": true,
"shared": false
}diary_id | string | required | AI diary ID; the diary must already exist. |
liked | boolean | one required | Whether the user likes the diary. |
shared | boolean | one required | Whether the user shared the diary. |
Provide liked, shared, or both. An omitted value does not overwrite an existing annotation.
{
"result": {
"code": 200,
"message": "success",
"request_id": "req_xxx"
}
}