patient_report

Get the patient's summary metrics as a star plot graph

get/patients/{patient_id}/patient_star_plot_summary/graph

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/patients/{patient_id}/patient_star_plot_summary/graph
  • Auth
    HTTP bearer

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

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

Changes

No recorded changes to this operation across all 19 revisions of this API.