Sign in
metrics

Query the patient's HEI components over a time period

get/metrics/patients/{patient_id}/HEI/components

Path parameters

patient_idinteger required

Query parameters

date_sincestring required

calendar date in format YYYY-MM-DD

Example:2019-01-02
date_untilstring required

calendar date in format YYYY-MM-DD

Example:2019-01-02

Response

successful operation

added_sugars_tspnumber nullable required
dairy_cupsnumber nullable required
date_sincestring required

calendar date in format YYYY-MM-DD

date_untilstring required

calendar date in format YYYY-MM-DD

energy_kcalnumber nullable required
fatty_acids_gnumber nullable required
greens_beans_cupsnumber nullable required
hei_scorenumber
patient_idinteger required
refined_grains_oznumber nullable required
saturated_fats_gnumber nullable required
seafood_plant_proteins_oznumber nullable required
sodium_mgnumber nullable required
total_fruits_cupsnumber nullable required
total_protein_foods_oznumber nullable required
total_vegetables_cupsnumber nullable required
whole_fruits_cupsnumber nullable required
whole_grains_oznumber nullable required

Example response

{
  "date_since": "2019-01-02",
  "date_until": "2019-01-02"
}

Changes