Wellness Output

Example request

1GET /api/v1/{tenantId}/reports/{traversalId}/wellness
2  ?conclusions=3495&conclusions=3501

Parameters

Parameter | Description -|- tenantId | The tenant ID, usually the same as the client_id used for authentication traversalId | ID of a completed HRA traversal conclusions | IDs of conclusions selected from the checkableConclusions array (see below). If present, the API will calculate the scores as if the user had implemented the specified recommendations.

Example response

1{
2    "scores": [
3        {
4            "name": "Diet",
5            "score": 25.0
6        },
7        {
8            "name": "Stress",
9            "score": 90.0
10        },
11        {
12            "name": "Habits",
13            "score": 75.0
14        },
15        {
16            "name": "Fitness",
17            "score": 52.5
18        },
19        {
20            "name": "Prevention",
21            "score": 95.0
22        },
23        {
24            "name": "Screening",
25            "score": 90.0
26        },
27        {
28            "name": "Overall Wellbeing",
29            "score": 12.0
30        }
31    ],
32    "checkableConclusions": [
33        3566,
34        3579,
35        3589,
36        ...
37    ]
38}

Definitions

WellnessOutput

Property | Description -|- scores | Array of Score objects checkableConclusions | Array of assetIds of conclusions (recommendations) that may affect the calculations if implemented. A list of the conclusions attached to the traversal should be requested from the conclusions endpoint of the Traversal API. See the conclusions documentation for more details.

Score

Property | Description -|- name | Name of the wellness category score | A score out of 100, where 100 represents a perfect outcome if all recommendations are implemented