# 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:
```http
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.
> \
> 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.
````json
{"openapi":"3.0.3","info":{"title":"Prism Hosted API","version":"1"},"tags":[{"name":"Scans - Reports","description":"### Access body composition and health reports for user scans.\n\nUse these endpoints to fetch derived metrics such as body fat, lean mass, circumferences, metabolic outputs and consolidated health reports for each scan.\nTypical use cases include powering health dashboards, progress tracking, coaching experiences and downstream analytics.\n\nAll Scans - Reports endpoints require the following headers:\n```http\naccept: application/json;v=1\nauthorization: Bearer {{API_KEY}}\ncontent-type: application/json\n```\nReplace `{{API_KEY}}` with your Prism API key for the selected environment.","parent":"Scans"}],"servers":[{"url":"https://api.hosted.prismlabs.tech","description":"Production environment for Prism Hosted API"},{"url":"https://sandbox-api.hosted.prismlabs.tech","description":"Sandbox environment for Prism Hosted API"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","name":"Authorization","in":"header"}},"schemas":{"MeasurementDto":{"type":"object","properties":{"neckFit":{"type":"number"},"shoulderFit":{"type":"number"},"upperChestFit":{"type":"number"},"chestFit":{"type":"number"},"lowerChestFit":{"type":"number"},"waistFit":{"type":"number"},"waistNavyFit":{"type":"number"},"stomachFit":{"type":"number"},"hipsFit":{"type":"number"},"upperThighLeftFit":{"type":"number"},"upperThighRightFit":{"type":"number"},"thighLeftFit":{"type":"number"},"thighRightFit":{"type":"number"},"lowerThighLeftFit":{"type":"number"},"lowerThighRightFit":{"type":"number"},"calfLeftFit":{"type":"number"},"calfRightFit":{"type":"number"},"ankleLeftFit":{"type":"number"},"ankleRightFit":{"type":"number"},"midArmRightFit":{"type":"number"},"midArmLeftFit":{"type":"number"},"lowerArmRightFit":{"type":"number"},"lowerArmLeftFit":{"type":"number"},"waistToHipRatio":{"type":"number"},"forearmLeftFit":{"type":"number"},"forearmRightFit":{"type":"number"},"wristLeftFit":{"type":"number"},"wristRightFit":{"type":"number"},"bmiPredicted":{"type":"number"},"bmiConfidence":{"type":"number"},"bodyRoundnessIndex":{"type":"number"},"fullBodyVolume":{"type":"number"}},"required":["neckFit","shoulderFit","upperChestFit","chestFit","lowerChestFit","waistFit","waistNavyFit","stomachFit","hipsFit","upperThighLeftFit","upperThighRightFit","thighLeftFit","thighRightFit","lowerThighLeftFit","lowerThighRightFit","calfLeftFit","calfRightFit","ankleLeftFit","ankleRightFit","midArmRightFit","midArmLeftFit","lowerArmRightFit","lowerArmLeftFit","waistToHipRatio","forearmLeftFit","forearmRightFit","wristLeftFit","wristRightFit","bmiPredicted","bmiConfidence","bodyRoundnessIndex","fullBodyVolume"]}}},"paths":{"/scans/{scanId}/measurements":{"get":{"description":"\nThis operation provides the detailed **body measurements** derived from a specific **scan**.\n\nOptionally, you can use the `unit-system` query parameter to receive measurements in **metric** or **imperial** units.\n","operationId":"MeasurementController_findOne_1","parameters":[{"name":"scanId","required":true,"in":"path","description":"The unique ID of the scan.","schema":{"type":"string"}},{"name":"unit-system","required":false,"in":"query","description":"The unit system in which values will be returned.","schema":{"enum":["metric","imperial"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json;v=1":{"schema":{"$ref":"#/components/schemas/MeasurementDto"}}}}},"summary":"Get body measurements of a scan.","tags":["Scans - Reports"]}}}}
````
## Get body fat of a scan.
> \
> 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.
````json
{"openapi":"3.0.3","info":{"title":"Prism Hosted API","version":"1"},"tags":[{"name":"Scans - Reports","description":"### Access body composition and health reports for user scans.\n\nUse these endpoints to fetch derived metrics such as body fat, lean mass, circumferences, metabolic outputs and consolidated health reports for each scan.\nTypical use cases include powering health dashboards, progress tracking, coaching experiences and downstream analytics.\n\nAll Scans - Reports endpoints require the following headers:\n```http\naccept: application/json;v=1\nauthorization: Bearer {{API_KEY}}\ncontent-type: application/json\n```\nReplace `{{API_KEY}}` with your Prism API key for the selected environment.","parent":"Scans"}],"servers":[{"url":"https://api.hosted.prismlabs.tech","description":"Production environment for Prism Hosted API"},{"url":"https://sandbox-api.hosted.prismlabs.tech","description":"Sandbox environment for Prism Hosted API"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","name":"Authorization","in":"header"}},"schemas":{"BodyfatDto":{"type":"object","properties":{"bodyfatMethod":{"type":"string","enum":["adam","army","army_athlete","coco","coco_bri","coco_legacy","coco2","coco2_oc","extended_navy_thinboost","tina_fit"],"description":"Bodyfat method for the scan"},"bodyfatPercentage":{"type":"number","nullable":true,"description":"Bodyfat percentage"},"leanMassPercentage":{"type":"number","nullable":true,"description":"Lean mass percentage"},"fatMass":{"type":"number","nullable":true,"description":"fat mass in kg"},"leanMass":{"type":"number","nullable":true,"description":"lean mass in kg"},"vatPercentage":{"type":"number","nullable":true,"description":"visceral adipose tissue (VAT) in %"},"vatMass":{"type":"number","nullable":true,"description":"visceral adipose tissue (VAT) in kg"},"appendicularLeanMassPercentage":{"type":"number","nullable":true,"description":"appendicular lean mass (ALM) in %"},"appendicularLeanMass":{"type":"number","nullable":true,"description":"appendicular lean mass (ALM) in kg"},"skeletalMuscleMassPercentage":{"type":"number","nullable":true,"description":"skeletal muscle mass (SMM) in %"},"skeletalMuscleMass":{"type":"number","nullable":true,"description":"skeletal muscle mass (SMM) in kg"}},"required":["bodyfatMethod","bodyfatPercentage","leanMassPercentage","fatMass","leanMass","vatPercentage","vatMass","appendicularLeanMassPercentage","appendicularLeanMass","skeletalMuscleMassPercentage","skeletalMuscleMass"]}}},"paths":{"/scans/{scanId}/bodyfat":{"get":{"description":"\nThis operation provides the **body fat** result derived from a specific **scan**.\n\nOptionally, you can use the `unit-system` query parameter to receive values in **metric** or **imperial** units.\n","operationId":"BodyfatController_findOne_1","parameters":[{"name":"scanId","required":true,"in":"path","description":"The unique ID of the scan.","schema":{"type":"string"}},{"name":"unit-system","required":false,"in":"query","description":"The unit system in which values will be returned.","schema":{"enum":["metric","imperial"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json;v=1":{"schema":{"$ref":"#/components/schemas/BodyfatDto"}}}}},"summary":"Get body fat of a scan.","tags":["Scans - Reports"]}}}}
````
## Update body fat method of a scan.
> \
> 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.
````json
{"openapi":"3.0.3","info":{"title":"Prism Hosted API","version":"1"},"tags":[{"name":"Scans - Reports","description":"### Access body composition and health reports for user scans.\n\nUse these endpoints to fetch derived metrics such as body fat, lean mass, circumferences, metabolic outputs and consolidated health reports for each scan.\nTypical use cases include powering health dashboards, progress tracking, coaching experiences and downstream analytics.\n\nAll Scans - Reports endpoints require the following headers:\n```http\naccept: application/json;v=1\nauthorization: Bearer {{API_KEY}}\ncontent-type: application/json\n```\nReplace `{{API_KEY}}` with your Prism API key for the selected environment.","parent":"Scans"}],"servers":[{"url":"https://api.hosted.prismlabs.tech","description":"Production environment for Prism Hosted API"},{"url":"https://sandbox-api.hosted.prismlabs.tech","description":"Sandbox environment for Prism Hosted API"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","name":"Authorization","in":"header"}},"schemas":{"UpdateBodyfatDto":{"type":"object","properties":{"bodyfatMethod":{"type":"string","enum":["adam","army","army_athlete","coco","coco_bri","coco_legacy","coco2","coco2_oc","extended_navy_thinboost","tina_fit"],"description":"A new bodyfat method to to use for the scan"}},"required":["bodyfatMethod"]},"BodyfatDto":{"type":"object","properties":{"bodyfatMethod":{"type":"string","enum":["adam","army","army_athlete","coco","coco_bri","coco_legacy","coco2","coco2_oc","extended_navy_thinboost","tina_fit"],"description":"Bodyfat method for the scan"},"bodyfatPercentage":{"type":"number","nullable":true,"description":"Bodyfat percentage"},"leanMassPercentage":{"type":"number","nullable":true,"description":"Lean mass percentage"},"fatMass":{"type":"number","nullable":true,"description":"fat mass in kg"},"leanMass":{"type":"number","nullable":true,"description":"lean mass in kg"},"vatPercentage":{"type":"number","nullable":true,"description":"visceral adipose tissue (VAT) in %"},"vatMass":{"type":"number","nullable":true,"description":"visceral adipose tissue (VAT) in kg"},"appendicularLeanMassPercentage":{"type":"number","nullable":true,"description":"appendicular lean mass (ALM) in %"},"appendicularLeanMass":{"type":"number","nullable":true,"description":"appendicular lean mass (ALM) in kg"},"skeletalMuscleMassPercentage":{"type":"number","nullable":true,"description":"skeletal muscle mass (SMM) in %"},"skeletalMuscleMass":{"type":"number","nullable":true,"description":"skeletal muscle mass (SMM) in kg"}},"required":["bodyfatMethod","bodyfatPercentage","leanMassPercentage","fatMass","leanMass","vatPercentage","vatMass","appendicularLeanMassPercentage","appendicularLeanMass","skeletalMuscleMassPercentage","skeletalMuscleMass"]}}},"paths":{"/scans/{scanId}/bodyfat":{"patch":{"description":"\nThis operation updates the **body fat method** configuration of a specific **scan**.\n\nOptionally, you can use the `unit-system` query parameter to receive values in **metric** or **imperial** units.\n","operationId":"BodyfatController_update_1","parameters":[{"name":"scanId","required":true,"in":"path","description":"The unique ID of the scan.","schema":{"type":"string"}},{"name":"unit-system","required":false,"in":"query","description":"The unit system in which values will be returned.","schema":{"enum":["metric","imperial"],"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBodyfatDto"}}}},"responses":{"200":{"description":"","content":{"application/json;v=1":{"schema":{"$ref":"#/components/schemas/BodyfatDto"}}}}},"summary":"Update body fat method of a scan.","tags":["Scans - Reports"]}}}}
````
## Get the health report of a scan
> \
> 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.
````json
{"openapi":"3.0.3","info":{"title":"Prism Hosted API","version":"1"},"tags":[{"name":"Scans - Reports","description":"### Access body composition and health reports for user scans.\n\nUse these endpoints to fetch derived metrics such as body fat, lean mass, circumferences, metabolic outputs and consolidated health reports for each scan.\nTypical use cases include powering health dashboards, progress tracking, coaching experiences and downstream analytics.\n\nAll Scans - Reports endpoints require the following headers:\n```http\naccept: application/json;v=1\nauthorization: Bearer {{API_KEY}}\ncontent-type: application/json\n```\nReplace `{{API_KEY}}` with your Prism API key for the selected environment.","parent":"Scans"}],"servers":[{"url":"https://api.hosted.prismlabs.tech","description":"Production environment for Prism Hosted API"},{"url":"https://sandbox-api.hosted.prismlabs.tech","description":"Sandbox environment for Prism Hosted API"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","name":"Authorization","in":"header"}},"schemas":{"HealthReportDto":{"type":"object","properties":{"scan":{"type":"object"},"user":{"type":"object"},"bodyFatPercentageReport":{"type":"object"},"leanMassReport":{"type":"object"},"fatMassReport":{"type":"object"},"waistCircumferenceReport":{"type":"object"},"waistToHipRatioReport":{"type":"object"},"waistToHeightRatioReport":{"type":"object"},"metabolismReport":{"type":"object"},"metabolicAgeReport":{"type":"object"},"appendicularLeanMassReport":{"type":"object"},"skeletalMuscleMassReport":{"type":"object"}},"required":["scan","user","bodyFatPercentageReport","leanMassReport","fatMassReport","waistCircumferenceReport","waistToHipRatioReport","waistToHeightRatioReport","metabolismReport","metabolicAgeReport","appendicularLeanMassReport","skeletalMuscleMassReport"]}}},"paths":{"/scans/{scanId}/health-report":{"get":{"description":"\nThis operation provides a consolidated **health report** derived from a specific **scan**.\n\nThe health report includes metrics such as body composition indicators and other scan-based health insights \nthat you can use for downstream analysis or to power your product experience.\n\nPlease note that this endpoint returns the full set of health report data only when the user's sex is set to \n**Male** or **Female**. When the user's sex is set to **Neutral**, the endpoint still returns a response with \nthe same overall structure, but only a subset of sections is populated.\n\nFor the full list of Health Report data sources and how they are used, please contact your Prism representative.\n\n**Body fat percentage report**\n- bodyFatPercentage: The percentage of your body that is fat. One of the top predictors of long-term health, \nlifespan, metabolism and athletic performance. Improve your body fat percentage by losing fat, building \nmuscle or both.\n- healthLabel: A health standard label.\n- percentile: How your body fat percentage compares to a reference population (e.g. 50th percentile means you \nare right at average).\n\n**Lean mass report**\n- leanMass: The amount of fat-free tissue in your body (mostly muscle, plus organs, bones and water). Higher \nlean mass is associated with better strength, metabolism and long-term health.\n- healthLabel: A health standard label.\n- percentile: How your lean mass compares to a reference population.\n\n**Fat mass report**\n- fatMass: The total amount of fat in your body. Closely linked to body fat percentage and cardiometabolic risk.\n- healthLabel: A health standard label.\n- percentile: How your fat mass compares to a reference population.\n\n**Waist circumference report**\n- waistCircumference: The circumference around your waist. A key indicator of visceral fat and \ncardiometabolic risk, often more predictive than weight or BMI alone.\n- healthLabel: A health standard label.\n- percentile: How your waist circumference compares to a reference population.\n\n**Waist-to-hip ratio report**\n- waistToHipRatio: The ratio of your waist circumference to your hip circumference. Captures fat \ndistribution (apple vs pear shape) and is strongly associated with cardiovascular and metabolic risk.\n- healthLabel: A health standard label.\n- percentile: How your waist-to-hip ratio compares to a reference population.\n\n**Waist-to-height ratio report**\n- waistToHeightRatio: The ratio of your waist circumference to your height. A simple screening metric \nwhere higher values generally indicate higher health risk.\n- healthLabel: A health standard label.\n- percentile: How your waist-to-height ratio compares to a reference population.\n\n**Metabolism report**\n- basalMetabolicRate: The number of calories your body burns at rest in a typical day. Closely linked to \nlean mass and overall metabolic health.\n- energyExpenditures: Estimated daily calorie needs for different activity levels (e.g. sedentary), based \non your BMR and profile.\n- recommendations: Calorie targets and guidance for cutting (fat loss) or building (muscle gain) based on \nyour current body composition and goals.\n\n**Metabolic age report**\n- metabolicAgeYears: Your estimated metabolic age based on how many calories you burn and your body \ncomposition, compared to people of different ages.\n- chronologicalAgeYears: Your actual age in years.\n- ageDeltaYears: The difference between your metabolic age and chronological age (negative is \n“metabolically younger”, positive is “metabolically older”).\n- percentile: How your metabolic profile compares to a reference population for your age and sex.\n\n**Appendicular lean mass report**\n- appendicularLeanMass: The amount of lean mass in your arms and legs. Often used to assess muscle \nhealth, sarcopenia risk and functional strength.\n- appendicularLeanMassIndexKgPerM2: Appendicular lean mass adjusted for height, which helps compare \npeople of different sizes.\n- category: A categorical interpretation of your appendicular lean mass \n(for example “Low”, “Normal” or “High” muscle).\n- percentile: How your appendicular lean mass compares to a reference population.\n- references: Scientific references used to derive the cut-offs and norms for appendicular lean mass.\n- disclaimer: Important notes about clinical interpretation and limitations of this metric.\n\n**Skeletal muscle mass report**\n- skeletalMuscleMass: The amount of skeletal muscle in your body, which drives strength, mobility \nand energy expenditure.\n- skeletalMuscleMassIndexKgPerM2: Skeletal muscle mass adjusted for height, to allow comparison across \nbody sizes.\n- category: A categorical interpretation of your skeletal muscle mass \n(for example “Low”, “Normal” or “High” muscle).\n- percentile: How your skeletal muscle mass compares to a reference population.\n- references: Scientific references used to derive the cut-offs and norms for skeletal muscle mass.\n- disclaimer: Important notes about clinical interpretation and limitations of this metric.\n","operationId":"HealthReportController_findOne_1","parameters":[{"name":"scanId","required":true,"in":"path","description":"The unique ID of the scan.","schema":{"type":"string"}},{"name":"unit-system","required":false,"in":"query","description":"The unit system in which values will be returned.","schema":{"enum":["metric","imperial"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json;v=1":{"schema":{"$ref":"#/components/schemas/HealthReportDto"}}}}},"summary":"Get the health report of a scan","tags":["Scans - Reports"]}}}}
````