---
title: "Query the patient's HEI over a time period"
method: GET
path: "/metrics/patients/{patient_id}/HEI"
tags: ["metrics"]
---

# Query the patient's HEI over a time period

`GET /metrics/patients/{patient_id}/HEI`

## Path parameters

- `patient_id` integer, required

## Query parameters

- `date_since` string, required — calendar date in format YYYY-MM-DD
- `date_until` string, required — calendar date in format YYYY-MM-DD

## Response `200`

successful operation

- HeiResponse
  - `daily_hei_scores` HeiDayRowResponse[], required
    - `added_sugars_score` number, nullable, required
    - `dairy_score` number, nullable, required
    - `energy_kcal` number, nullable, required
    - `fatty_acids_score` number, nullable, required
    - `greens_beans_score` number, nullable, required
    - `hei_score` number, required
    - `log_date` string, required — calendar date in format YYYY-MM-DD
    - `refined_grains_score` number, nullable, required
    - `saturated_fats_score` number, nullable, required
    - `seafood_plant_proteins_score` number, nullable, required
    - `sodium_score` number, nullable, required
    - `total_fruits_score` number, nullable, required
    - `total_protein_foods_score` number, nullable, required
    - `total_vegetables_score` number, nullable, required
    - `whole_fruits_score` number, nullable, required
    - `whole_grains_score` number, nullable, required
  - `date_since` string, required — calendar date in format YYYY-MM-DD
  - `date_until` string, required — calendar date in format YYYY-MM-DD
  - `patient_id` integer, required
  - `summary_hei_score` HeiDateRangeResponse[], required
    - `added_sugars_score` number, nullable, required
    - `dairy_score` number, nullable, required
    - `energy_kcal` number, nullable, required
    - `fatty_acids_score` number, nullable, required
    - `greens_beans_score` number, nullable, required
    - `hei_score` number, required
    - `refined_grains_score` number, nullable, required
    - `saturated_fats_score` number, nullable, required
    - `seafood_plant_proteins_score` number, nullable, required
    - `sodium_score` number, nullable, required
    - `total_fruits_score` number, nullable, required
    - `total_protein_foods_score` number, nullable, required
    - `total_vegetables_score` number, nullable, required
    - `whole_fruits_score` number, nullable, required
    - `whole_grains_score` number, nullable, required

---

[API](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server.md) · [All operations](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/llms.txt) · [OpenAPI document](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/revisions/5a99db4cbce3?raw)