API Reference

Generate Health Score Report

post
https://api.voloridgehealth.com/health-score/report

Generates a comprehensive health score report based on the provided health score request data. This endpoint can be used to create detailed reports for users based on their health scores, disease risk, disease age, and predictor attributions. Events together must include sex (46098-0), height (8302-2), and weight (29463-7).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request object for generating a health score report

report_metadata
object
required

Metadata for a full or condensed report request

requested_outputs
object

Overrides the output tables and diseases configured for the organization.

string
required
length ≥ 1

External user identifier

health_events
array of objects
required
length ≥ 1

Array of health events to be included in the report

health_events*
Responses

400

Bad Request - Invalid input data

401

Unauthorized - Invalid or missing API key

429

Too Many Requests - Rate limit exceeded

500

Internal Server Error

Updated 5 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?