Sign in
patient_report

Get the patient's summary metrics for the star plot graph

get/patients/{patient_id}/patient_star_plot_summary

Path parameters

patient_idinteger required

Query parameters

date_sincestring required

starting date in format YYYY-MM-DD

Example:2019-01-02
date_untilstring required

ending date in format YYYY-MM-DD

Example:2019-01-02
disaggregatedboolean required

indicate whether to use aggregated or disaggregated meal items.

daily_avg_methodboolean required

indicate whether to avg by day, or carry out calcs across set of meals. Default is False.

include_statementsboolean

indicate whether statements should be included in the response. Default is false.

n_frequency_itemsinteger

maximum number of frequency items to include per category. Default is 3.

include_non_ranked_itemsboolean

indicate whether frequency items should include non-ranked. Default is true.

include_custom_itemsboolean

indicate whether to include custom items in the calculation

enforce_unique_base_foodboolean

indicate whether enforce only one food item for each unique base food

Response

successful operation

calorie_rationumber required
doing_right_statementstring[] nullable
fat_ratio_pct_of_targetnumber required
fiber_pct_of_targetnumber required
fruit_pct_of_targetnumber required
header_statementstring nullable
healthy_bev_pct_of_totalnumber required
healthy_fat_kcal_pct_of_totalnumber

added 2022-08-31

non_red_meat_pct_of_proteinnumber required
patient_idinteger required
plant_based_pctnumber required
poultry_frequency_weeklynumber required
redmeat_frequency_weeklynumber required
ultra_processed_pct_of_totalnumber
ultraprocessed_pct_of_totalnumber required
unhealthy_fat_kcal_pct_of_totalnumber required
vegetable_pct_of_targetnumber required
whole_foods_and_low_processed_foodsnumber required
whole_grain_pctnumber required

Changes

No recorded changes to this endpoint across all 15 revisions of this API.