curl --request GET \
--url https://api.example.com/api/v1/users/{user_id}/summaries/body \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/users/{user_id}/summaries/body"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/users/{user_id}/summaries/body', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/users/{user_id}/summaries/body",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/users/{user_id}/summaries/body"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/users/{user_id}/summaries/body")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/users/{user_id}/summaries/body")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"source": {
"provider": "apple",
"device_name": "<string>",
"source": "Connect",
"device": "iPhone15,2",
"device_type": "phone"
},
"slow_changing": {
"weight_kg": 72.5,
"height_cm": 175.5,
"body_fat_percent": 18.5,
"muscle_mass_kg": 58.2,
"bmi": 23.5,
"age": 32
},
"averaged": {
"period_days": 7,
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"resting_heart_rate_bpm": 62,
"avg_hrv_sdnn_ms": 45.2,
"avg_hrv_rmssd_ms": 42
},
"latest": {
"body_temperature_celsius": 36.6,
"body_temperature_measured_at": "2023-11-07T05:31:56Z",
"skin_temperature_celsius": 36.6,
"skin_temperature_measured_at": "2023-11-07T05:31:56Z",
"blood_pressure": {
"avg_systolic_mmhg": 120,
"avg_diastolic_mmhg": 80,
"max_systolic_mmhg": 135,
"max_diastolic_mmhg": 90,
"min_systolic_mmhg": 110,
"min_diastolic_mmhg": 72,
"reading_count": 5
},
"blood_pressure_measured_at": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Get Body Summary
Returns comprehensive body metrics with semantic grouping.
Response is organized into three categories:
- static: Slow-changing values (weight, height, body fat, muscle mass, BMI, age) Returns the most recent recorded value for each field.
- averaged: Vitals averaged over a period (resting HR, HRV)
Period is configurable via
average_periodparameter (1-7 days). - latest: Point-in-time readings (body temperature, blood pressure)
Only returned if measured within
latest_window_hours(default 4 hours).
Returns null if no body data exists for the user.
curl --request GET \
--url https://api.example.com/api/v1/users/{user_id}/summaries/body \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/users/{user_id}/summaries/body"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/users/{user_id}/summaries/body', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/users/{user_id}/summaries/body",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/users/{user_id}/summaries/body"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/users/{user_id}/summaries/body")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/users/{user_id}/summaries/body")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"source": {
"provider": "apple",
"device_name": "<string>",
"source": "Connect",
"device": "iPhone15,2",
"device_type": "phone"
},
"slow_changing": {
"weight_kg": 72.5,
"height_cm": 175.5,
"body_fat_percent": 18.5,
"muscle_mass_kg": 58.2,
"bmi": 23.5,
"age": 32
},
"averaged": {
"period_days": 7,
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"resting_heart_rate_bpm": 62,
"avg_hrv_sdnn_ms": 45.2,
"avg_hrv_rmssd_ms": 42
},
"latest": {
"body_temperature_celsius": 36.6,
"body_temperature_measured_at": "2023-11-07T05:31:56Z",
"skin_temperature_celsius": 36.6,
"skin_temperature_measured_at": "2023-11-07T05:31:56Z",
"blood_pressure": {
"avg_systolic_mmhg": 120,
"avg_diastolic_mmhg": 80,
"max_systolic_mmhg": 135,
"max_diastolic_mmhg": 90,
"min_systolic_mmhg": 110,
"min_diastolic_mmhg": 72,
"reading_count": 5
},
"blood_pressure_measured_at": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Path Parameters
Query Parameters
Days to average vitals (1-7)
1 <= x <= 7Hours for latest readings to be considered valid (1-24)
1 <= x <= 24Response
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)
Show child attributes
Show child attributes
Slow-changing body composition metrics.
These are metrics that change infrequently (days/weeks between measurements). Returns the most recent recorded value for each field.
Show child attributes
Show child attributes
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).
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Was this page helpful?

