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