Summary

Retrieve processed body summary data for a specific user, including weight, body fat, and BMI measurements.

GET /v2/summary/body/{user_id}

cURL

curl --request GET \
     --url {{BASE_URL}}/v2/summary/body/{user_id} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.body.get(
    "<user_id>",
    start_date="2022-05-01",
    end_date="2022-06-01",
)

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.body.get({
    userId: "<user_id>",
    startDate: "2022-05-01",
    endDate: "2022-06-01",
});

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.body.requests.GetBodyRequest;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.body().get(
    "<user_id>",
    GetBodyRequest.builder()
        .startDate("2022-05-01")
        .endDate("2022-06-01")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

endDate := "2022-06-01"
response, err := c.Body.Get(context.TODO(), &junction.GetBodyRequest{
    UserId:    "<user_id>",
    StartDate: "2022-05-01",
    EndDate:   &endDate,
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

200

{
  "body": [
    {
      "body_mass_index": 22.3,
      "bone_mass_percentage": 4.3,
      "calendar_date": "2023-02-27",
      "created_at": "2023-02-27T20:31:24+00:00",
      "date": "2023-02-27T12:31:24+00:00",
      "fat": 30,
      "height": 183,
      "id": "8be1306e-01fc-46b1-b5d1-a9e39052db09",
      "lean_body_mass_kilogram": 40.1,
      "muscle_mass_percentage": 40.2,
      "source": {
        "device_id": "550e8400-e29b-41d4-a716-446655440000",
        "logo": "https://logo_url.com",
        "name": "Withings",
        "slug": "withings"
      },
      "updated_at": "2023-02-28T01:22:38+00:00",
      "user_id": "1449752e-0d8a-40e0-9206-91ab099b2537",
      "visceral_fat_index": 4.5,
      "waist_circumference_centimeter": 86.36,
      "water_percentage": 55.4,
      "weight": 80
    }
  ]
}

{
  "detail": "<unknown>"
}

cURL

curl --request GET \
     --url {{BASE_URL}}/v2/summary/body/{user_id} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.body.get(
    "<user_id>",
    start_date="2022-05-01",
    end_date="2022-06-01",
)

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.body.get({
    userId: "<user_id>",
    startDate: "2022-05-01",
    endDate: "2022-06-01",
});

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.body.requests.GetBodyRequest;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.body().get(
    "<user_id>",
    GetBodyRequest.builder()
        .startDate("2022-05-01")
        .endDate("2022-06-01")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

endDate := "2022-06-01"
response, err := c.Body.Get(context.TODO(), &junction.GetBodyRequest{
    UserId:    "<user_id>",
    StartDate: "2022-05-01",
    EndDate:   &endDate,
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Path Parameters

user_id · string<uuid> · required

Query Parameters

provider · string · default: ""

Provider oura/strava etc

start_date · string · required

Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

end_date · string | null

Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59

Response

200

application/json

Successful Response

body · ClientFacingBody · object[] · required

Show child attributes