Get Benchmark General Percentages

Retrieve the distribution percentages across benchmark categories.

---

Overview

This endpoint returns the percentage breakdown of users in different benchmark categories: vulnerable, coping, and healthy. These categories represent the financial health distribution across the US population and can be used to contextualize individual user scores against national averages.

Method: GET
Endpoint:
/api/v1/benchmarks/generalPercentages

This data represents the latest US benchmark figures and is typically updated annually around autumn.

---

Request

Headers

Accept: application/json

No parameters or request body required for this endpoint.

---

Response

{
  "vulnerable": 15,
  "coping": 55,
  "healthy": 31
}

Response Properties

Property	Type	Description
vulnerable	number	Percentage of population in the vulnerable financial health category
coping	number	Percentage of population in the coping financial health category
healthy	number	Percentage of population in the healthy financial health category

---

Usage Examples

Comparing User Scores to Benchmarks

This endpoint is commonly used to provide contextual information when displaying user financial health scores:

// Example implementation
function displayUserScoreContext(userCategory, benchmarkData) {
  if (userCategory === 'vulnerable') {
    return `You're not alone - ${benchmarkData.vulnerable}% of Americans have a similar financial health score.`;
  } else if (userCategory === 'coping') {
    return `${benchmarkData.coping}% of Americans have a similar financial health score to yours.`;
  } else {
    return `Congratulations! You're among the ${benchmarkData.healthy}% of Americans with a healthy financial score.`;
  }
}

Visualization Example

These percentages can be used to create comparative visualizations such as:

• Pie charts showing the national distribution
• Progress bars that position the user's score within the national context
• Comparative bar charts showing the user's category alongside the national averages

---

Notes

• Values represent percentages that sum to approximately 100%
• This endpoint is useful for visualizations and reporting
• Benchmark data is based on nationally representative surveys
• Consider caching these values client-side as they update infrequently