Scans Reports

Access body composition and health reports for user scans.

Use these endpoints to fetch derived metrics such as body fat, lean mass, circumferences, metabolic outputs and consolidated health reports for each scan. Typical use cases include powering health dashboards, progress tracking, coaching experiences and downstream analytics.

All Scans - Reports endpoints require the following headers:

accept: application/json;v=1
authorization: Bearer {{API_KEY}}
content-type: application/json

Replace {{API_KEY}} with your Prism API key for the selected environment.

Get body measurements of a scan.

get

/scans/{scanId}/measurements

This operation provides the detailed body measurements derived from a specific scan.

Optionally, you can use the unit-system query parameter to receive measurements in metric or imperial units.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan.

Example: unique-scan-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned.

Possible values:

Responses

200Success

application/json;v=1

get

/scans/{scanId}/measurements

GET /scans/{scanId}/measurements HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "neckFit": 1,
  "shoulderFit": 1,
  "upperChestFit": 1,
  "chestFit": 1,
  "lowerChestFit": 1,
  "waistFit": 1,
  "waistNavyFit": 1,
  "stomachFit": 1,
  "hipsFit": 1,
  "upperThighLeftFit": 1,
  "upperThighRightFit": 1,
  "thighLeftFit": 1,
  "thighRightFit": 1,
  "lowerThighLeftFit": 1,
  "lowerThighRightFit": 1,
  "calfLeftFit": 1,
  "calfRightFit": 1,
  "ankleLeftFit": 1,
  "ankleRightFit": 1,
  "midArmRightFit": 1,
  "midArmLeftFit": 1,
  "lowerArmRightFit": 1,
  "lowerArmLeftFit": 1,
  "waistToHipRatio": 1,
  "forearmLeftFit": 1,
  "forearmRightFit": 1,
  "wristLeftFit": 1,
  "wristRightFit": 1,
  "bmiPredicted": 1,
  "bmiConfidence": 1,
  "bodyRoundnessIndex": 1,
  "fullBodyVolume": 1
}

Get body fat of a scan.

get

/scans/{scanId}/bodyfat

This operation provides the body fat result derived from a specific scan.

Optionally, you can use the unit-system query parameter to receive values in metric or imperial units.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan.

Example: unique-scan-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned.

Possible values:

Responses

200Success

application/json;v=1

get

/scans/{scanId}/bodyfat

GET /scans/{scanId}/bodyfat HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "bodyfatMethod": "coco",
  "bodyfatPercentage": 20,
  "leanMassPercentage": 80,
  "fatMass": 16,
  "leanMass": 64,
  "vatPercentage": 1.5,
  "vatMass": 1.2,
  "appendicularLeanMassPercentage": 20,
  "appendicularLeanMass": 16,
  "skeletalMuscleMassPercentage": 20,
  "skeletalMuscleMass": 16
}

Update body fat method of a scan.

patch

/scans/{scanId}/bodyfat

This operation updates the body fat method configuration of a specific scan.

Optionally, you can use the unit-system query parameter to receive values in metric or imperial units.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan.

Example: unique-scan-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned.

Possible values:

Body

bodyfatMethodstring · enumRequired

A new bodyfat method to to use for the scan

Example: cocoPossible values:

Responses

200Success

application/json;v=1

patch

/scans/{scanId}/bodyfat

PATCH /scans/{scanId}/bodyfat HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "bodyfatMethod": "coco"
}

200Success

{
  "bodyfatMethod": "coco",
  "bodyfatPercentage": 20,
  "leanMassPercentage": 80,
  "fatMass": 16,
  "leanMass": 64,
  "vatPercentage": 1.5,
  "vatMass": 1.2,
  "appendicularLeanMassPercentage": 20,
  "appendicularLeanMass": 16,
  "skeletalMuscleMassPercentage": 20,
  "skeletalMuscleMass": 16
}

Get the health report of a scan

get

/scans/{scanId}/health-report

This operation provides a consolidated health report derived from a specific scan.

The health report includes metrics such as body composition indicators and other scan-based health insights that you can use for downstream analysis or to power your product experience.

Please note that this endpoint returns the full set of health report data only when the user's sex is set to Male or Female. When the user's sex is set to Neutral, the endpoint still returns a response with the same overall structure, but only a subset of sections is populated.

For the full list of Health Report data sources and how they are used, please contact your Prism representative.

Body fat percentage report

bodyFatPercentage: The percentage of your body that is fat. One of the top predictors of long-term health, lifespan, metabolism and athletic performance. Improve your body fat percentage by losing fat, building muscle or both.
healthLabel: A health standard label.
percentile: How your body fat percentage compares to a reference population (e.g. 50th percentile means you are right at average).

Lean mass report

leanMass: The amount of fat-free tissue in your body (mostly muscle, plus organs, bones and water). Higher lean mass is associated with better strength, metabolism and long-term health.
healthLabel: A health standard label.
percentile: How your lean mass compares to a reference population.

Fat mass report

fatMass: The total amount of fat in your body. Closely linked to body fat percentage and cardiometabolic risk.
healthLabel: A health standard label.
percentile: How your fat mass compares to a reference population.

Waist circumference report

waistCircumference: The circumference around your waist. A key indicator of visceral fat and cardiometabolic risk, often more predictive than weight or BMI alone.
healthLabel: A health standard label.
percentile: How your waist circumference compares to a reference population.

Waist-to-hip ratio report

waistToHipRatio: The ratio of your waist circumference to your hip circumference. Captures fat distribution (apple vs pear shape) and is strongly associated with cardiovascular and metabolic risk.
healthLabel: A health standard label.
percentile: How your waist-to-hip ratio compares to a reference population.

Waist-to-height ratio report

waistToHeightRatio: The ratio of your waist circumference to your height. A simple screening metric where higher values generally indicate higher health risk.
healthLabel: A health standard label.
percentile: How your waist-to-height ratio compares to a reference population.

Metabolism report

basalMetabolicRate: The number of calories your body burns at rest in a typical day. Closely linked to lean mass and overall metabolic health.
energyExpenditures: Estimated daily calorie needs for different activity levels (e.g. sedentary), based on your BMR and profile.
recommendations: Calorie targets and guidance for cutting (fat loss) or building (muscle gain) based on your current body composition and goals.

Metabolic age report

metabolicAgeYears: Your estimated metabolic age based on how many calories you burn and your body composition, compared to people of different ages.
chronologicalAgeYears: Your actual age in years.
ageDeltaYears: The difference between your metabolic age and chronological age (negative is “metabolically younger”, positive is “metabolically older”).
percentile: How your metabolic profile compares to a reference population for your age and sex.

Appendicular lean mass report

appendicularLeanMass: The amount of lean mass in your arms and legs. Often used to assess muscle health, sarcopenia risk and functional strength.
appendicularLeanMassIndexKgPerM2: Appendicular lean mass adjusted for height, which helps compare people of different sizes.
category: A categorical interpretation of your appendicular lean mass (for example “Low”, “Normal” or “High” muscle).
percentile: How your appendicular lean mass compares to a reference population.
references: Scientific references used to derive the cut-offs and norms for appendicular lean mass.
disclaimer: Important notes about clinical interpretation and limitations of this metric.

Skeletal muscle mass report

skeletalMuscleMass: The amount of skeletal muscle in your body, which drives strength, mobility and energy expenditure.
skeletalMuscleMassIndexKgPerM2: Skeletal muscle mass adjusted for height, to allow comparison across body sizes.
category: A categorical interpretation of your skeletal muscle mass (for example “Low”, “Normal” or “High” muscle).
percentile: How your skeletal muscle mass compares to a reference population.
references: Scientific references used to derive the cut-offs and norms for skeletal muscle mass.
disclaimer: Important notes about clinical interpretation and limitations of this metric.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan.

Example: unique-scan-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned.

Possible values:

Responses

200Success

application/json;v=1

get

/scans/{scanId}/health-report

GET /scans/{scanId}/health-report HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "scan": {},
  "user": {},
  "bodyFatPercentageReport": {},
  "leanMassReport": {},
  "fatMassReport": {},
  "waistCircumferenceReport": {},
  "waistToHipRatioReport": {},
  "waistToHeightRatioReport": {},
  "metabolismReport": {},
  "metabolicAgeReport": {},
  "appendicularLeanMassReport": {},
  "skeletalMuscleMassReport": {}
}

PreviousScans Assets NextFuture Me

Last updated 1 month ago