Skip to main content
GET
Get Body Summary

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Open-Wearables-API-Key
string | null

Path Parameters

user_id
string<uuid>
required

Query Parameters

average_period
integer
default:7

Days to average vitals (1-7)

Required range: 1 <= x <= 7
latest_window_hours
integer
default:4

Hours for latest readings to be considered valid (1-24)

Required range: 1 <= x <= 24

Response

BodySummary · object | null

Successful Response

Comprehensive body metrics with semantic grouping.

Metrics are grouped by their temporal characteristics:

  • slow_changing: Slow-changing values (latest measurement)
  • averaged: Vitals averaged over a period (1 or 7 days)
  • latest: Point-in-time readings (only if recent)
source
SourceMetadata · object
required
slow_changing
BodySlowChanging · object
required

Slow-changing body composition metrics.

These are metrics that change infrequently (days/weeks between measurements). Returns the most recent recorded value for each field.

averaged
BodyAveraged · object
required

Vitals averaged over a configurable time period.

These metrics fluctuate daily and are more meaningful as averages. Period can be 1 day (current state) or 7 days (baseline trend).

latest
BodyLatest · object
required

Point-in-time metrics that are only relevant when recent.

These metrics are only returned if measured within a configurable time window. Stale readings return null to avoid displaying outdated data.