API Reference
For Prism internal use only [Prism staging]
For Prism internal use only [Prism staging]
  • API Reference
  • Specifications
  • HOSTED API
    • API reference
      • Users
        • Terms
      • Scans
        • Measurements
        • Upload url
        • Scan assets
        • Asset urls
        • Bodyfat
        • Health report
      • Body shape prediction
        • Asset urls
    • Specification
  • PRISM API
    • About
    • API reference
      • Scans
        • Body
          • Download url
        • Fitted body
        • Measurements
          • Download url
        • Upload url
      • Users
      • Body shape prediction
        • Download url
    • Specification
Powered by GitBook
On this page
  1. HOSTED API
  2. API reference
  3. Scans

Health report

PreviousBodyfatNextBody shape prediction

get the health report of a scan

get

This operation provides the health report of a specific scan.

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
GET /scans/{scanId}/health-report HTTP/1.1
Host: api.hosted.prismlabs.tech
Accept: */*
200Success
{
  "scan": {},
  "user": {},
  "bodyFatPercentageReport": {},
  "leanMassReport": {},
  "fatMassReport": {},
  "waistCircumferenceReport": {},
  "waistToHipRatioReport": {},
  "waistToHeightRatioReport": {},
  "metabolismReport": {}
}