Sign in
patient_report

Get the goal report of the patient for this week and last week.

get/patients/{patient_id}/goals/weekly_report

Path parameters

patient_idinteger required

Query parameters

datestring required

reference date (today's date) in format YYYY-MM-DD

Example:2019-01-02

Response

successful operation

changestring required
goal_idinteger required
goal_image_urlstring
goal_typestring required
last_week_success_countinteger required
last_week_total_countinteger required
patient_idinteger required
period'day' | 'week' | 'breakfast' | 'lunch' | 'dinner' | 'snack' | 'meal' required
target_display_namestring required
target_namestring required
target_unitstring nullable
target_valuenumber required
this_week_success_countinteger required
this_week_total_countinteger required

Example response

[
  {
    "change": "increase, decrease",
    "goal_type": "frequency, nutrient",
    "target_display_name": "vitamin c",
    "target_name": "vitamin_c_mg",
    "target_unit": "mg"
  }
]

Changes