API Reference

Generate Condensed Health Score Report

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

Generates a Condensed health score report based on the provided health score request data. This endpoint can be used to create concise reports for users that focus on key health score metrics and insights.

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

The request object for generating a condensed health score report.

report_metadata
object
required

Metadata for the scoring event

string
required

External user identifier

health_event
object
required

A health event to be included in the report

Responses

400

Bad Request - Invalid input data

401

Unauthorized - Invalid or missing API key

422

Unprocessable Entity - Validation error in the request

429

Too Many Requests - Rate limit exceeded

500

Internal Server Error

Updated 12 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago