metrics

Query the patient's MIND score over a time period

get/metrics/patients/{patient_id}/mind

Request

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

Path parameters

patient_idinteger required

Query parameters

date_sincestring required

calendar date in format YYYY-MM-DD

Example:2020-05-02
date_untilstring required

calendar date in format YYYY-MM-DD

Example:2020-05-10
disaggregatedboolean required

use disaggregated or not

use_ranking_filterboolean

whether rankings should be considered in the calculation. Eg. a non-ranked vegetable would not count towards the vegetable score. Added 2024-01-18

use_insufficient_meal_filterboolean

whether days with insufficient number of meals should be excluded from the meals. Added 2024-04-01

Response

successful operation

cheese_scorenumber required
desserts_scorenumber required
fish_scorenumber required
fried_food_scorenumber required
fruit_scorenumber required
legume_scorenumber required
nuts_seeds_scorenumber required
poultry_scorenumber required
red_meat_scorenumber required
total_scorenumber required
vegetable_scorenumber required
whole_grains_scorenumber required

Changes

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