RXrxfoodapp
reporting

Gets the PatientReportDataResponse used to show nutrition insights in the mobile app.

get/reporting/patients/{patient_id}/mobile_nutrition_insights

Request

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

Path parameters

patient_idinteger required

Query parameters

range_selector'auto' | 'latest_subscription' | 'newest_reportable_subscription'

Optional server-side date range selection. If set, date_since/date_until are ignored. auto=latest N meal-days (all history), latest_subscription=current subscription window, newest_reportable_subscription=newest reportable subscription window.

days_with_mealsinteger

Only used when range_selector=auto. Number of latest meal-days to include (capped at 30).

min_meals_per_dayinteger

Only used when range_selector=auto. Minimum number of reportable meals required for a date to count as a meal-day.

date_sincestring

calendar date in format YYYY-MM-DD

Example:2020-05-02
date_untilstring

calendar date in format YYYY-MM-DD

Example:2020-05-12

Response

successful operation

afternoon_calsstring

afternoon calories as percentage of all meals

afternoon_cals_sumstring

afternoon calories(kcal) sum

afternoon_carbsstring

morning carbohydrate(g) as percentage of all meals

afternoon_carbs_sumstring

morning carbohydrate(g) sum

average_breakfast_plate_imagestring nullable

average breakfast plate image image location_deprecated

average_breakfast_plate_serv_imagestring nullable

average breakfast plate image image location_deprecated

average_cups_beverages_per_daynumber nullable

avg number of cups of beverages per day during the period. Added 2022-08-30.

average_cups_water_per_daynumber

avg number of cups of water per day during the period

average_dashstring nullable

String of Diet DASH Score

average_dinner_plate_imagestring nullable

average dinner plate image image location_deprecated

average_dinner_plate_serv_imagestring nullable

average dinner plate image image location_deprecated

average_fats_frequency_commentsstring nullable

image comments

average_grains_frequency_commentsstring nullable

image comments

average_lunch_plate_imagestring nullable

average lunch plate image image location_deprecated

average_lunch_plate_serv_imagestring nullable

average lunch plate image image location_deprecated

average_overall_plate_imagestring nullable

average dinner plate image image location_deprecated

average_plant_protein_frequency_commentsstring nullable

image comments

average_plate_commentsstring nullable

image comments

average_plate_imagestring nullable

average plate image location_deprecated

average_proteins_frequency_commentsstring nullable

image comments

average_water_frequency_commentsstring nullable

image comments

avg_fasting_windowstring

string of average fasting window

beverage_frequency_imagestring nullable

beverage frequency image location_deprecated

calcium_dash_imagestring nullable

calcium dash image location_deprecated

calcium_dash_statementsstring nullable

calcium statements_deprecated

calories_by_period_commentsstring nullable
calories_by_period_statementsstring nullable

recommended statement

calories_dirstring

calories template images location

carb_daily_intake_commentsstring nullable

image comments

carb_daily_intake_imagestring nullable

carb daily intake image image location_deprecated

carbs_by_period_commentsstring nullable
carbs_by_period_statementsstring nullable

recommended statement

cholesterol_dash_imagestring nullable

cholesterol dash image location_deprecated

cholesterol_dash_statementsstring nullable

cholesterol statements_deprecated

clinic_idinteger

clinic id

comparison_report_idinteger nullable

id of report being compared

date_sincestring required

calendar date in format %B %d, %Y

date_untilstring required

calendar date in format %B %d, %Y

dates1string nullable

emotion record date in format YYYY-MM-DD

dates2string nullable

emotion record date in format YYYY-MM-DD

dates3string nullable

emotion record date in format YYYY-MM-DD

dates4string nullable

emotion record date in format YYYY-MM-DD

dates5string nullable

emotion record date in format YYYY-MM-DD

dates_excludestring[] nullable

array of calendar dates in format %B %d, %Y

decrease_dash_nutrientsstring nullable

comma separated list of dash nutrients to decrease_deprecated

decrease_dash_statementsstring nullable

dash recommendations_deprecated

diet_restrictions_statementstring nullable

summary of diet restrictions

diet_score_commentsstring nullable

image comments

diet_score_imagestring nullable

diet score image location_deprecated

dinnertime_calsstring

dinner calories as percentage of all meals

dinnertime_cals_sumstring

dinner calories(kcal) sum

dinnertime_carbsstring

morning carbohydrate(g) as percentage of all meals

dinnertime_carbs_sumstring

morning carbohydrate(g) sum

evening_calsstring

evening calories as percentage of all meals

evening_cals_sumstring

evening calories(kcal) sum

evening_carbsstring

morning carbohydrate(g) as percentage of all meals

evening_carbs_sumstring

morning carbohydrate(g) sum

fat_frequency_imagestring nullable

fat frequency image location_deprecated

fat_frequency_statementsstring nullable

recommended statement

fat_frequency_valueobject nullable

dictionary of values for fat frequency

feelingsStatementstring

patient emotion feelings statement

fiber_dash_imagestring nullable

fiber dash image location_deprecated

fiber_dash_statementsstring nullable

fiber statements_deprecated

fibre_statementsstring nullable

recommended statement

fibre_valuestring

average grams of fibre per day

file_locationstring required

file location in s3

first_namestring

first name

fruit_frequency_statementsstring nullable

recommended statement

fruit_servings_per_daystring nullable

servings of fruit per day

fruit_vegetable_serv_statementsstring nullable

recommended statement

fruit_vegetable_statementsstring nullable

recommended statement

fruit_vegetable_valuestring nullable

the percentage of fruit and vegetables on their plate

ghg_equivalent_kg_imagestring nullable

ghg equivalent image location_deprecated

ghg_equivalent_kg_statementsstring nullable

image comments

ghg_equivalent_kg_valuenumber nullable

ghg_equivalent_value

gi_frequency_statementsstring nullable

recommended statement

gi_number_validstring nullable

number of meal items with valid GI index

glycemic_index_food_commentsstring nullable
glycemic_index_frequency_commentsstring nullable

image comments

glycemic_index_frequency_imagestring nullable

glycemic index frequency image image location_deprecated

glycemic_index_valueobject nullable

dictionary of values for glycemic index data

goal_statementstring

summary of goal progress during the report period

good_dash_nutrientsstring nullable

comma separated list of good dash scores_deprecated

good_dash_statementsstring nullable

dash recommendations_deprecated

grain_frequency_imagestring nullable

grain frequency image location_deprecated

grain_frequency_statement_liststring[] nullable

list of grain statements

grain_frequency_statementsstring nullable

recommended statement

grain_frequency_valueobject nullable

dictionary of values for grain frequency

high_gi1string nullable

meal item name with high GI index

high_gi2string nullable

meal item name with high GI index

high_gi3string nullable

meal item name with high GI index

high_gi4string nullable

meal item name with high GI index

high_gi5string nullable

meal item name with high GI index

increase_dash_nutrientsstring nullable

comma separated list of dash nutrients to increase_deprecated

increase_dash_statementsstring nullable

dash recommendations_deprecated

langstring

language

last_namestring

last name

local_dirstring

local images location

logo1string

logo location url

logo2string

logo location url

logo3string

logo location url

logos_dirstring

logos template images location

longest_fasting_windowstring

string of longest fasting window

low_gi1string nullable

meal item name with low GI index

low_gi2string nullable

meal item name with low GI index

low_gi3string nullable

meal item name with low GI index

low_gi4string nullable

meal item name with low GI index

low_gi5string nullable

meal item name with low GI index

lunchtime_calsstring

lunchtime calories as percentage of all meals

lunchtime_cals_sumstring

lunchtime calories(kcal) sum

lunchtime_carbsstring

morning carbohydrate(g) as percentage of all meals

lunchtime_carbs_sumstring

morning carbohydrate(g) sum

macro_statementsstring nullable

recommended statement

macro_valueobject nullable

dictionary of values for each macro

macronutrient_distribution_commentsstring nullable

image comments

macronutrient_distribution_imagestring nullable

macronutrient distribution image image location, deprecated

magnesium_dash_imagestring nullable

magnesium dash image location_deprecated

magnesium_dash_statementsstring nullable

magnesium statements_deprecated

meal_dates_includedstring[] nullable
median_fasting_windowstring

string of median fasting window

micronutrient_bubble_summary_statementstring nullable

summary statement for the section

micronutrient_trends_commentsstring nullable

image comments

micronutrient_trends_imagestring nullable

micronutrient trends image image location_deprecated

morning_calsstring

morning calories as percentage of all meals

morning_cals_sumstring

morning calories(kcal) sum

morning_carbsstring

morning carbohydrate(g) as percentage of all meals

morning_carbs_sumstring

morning carbohydrate(g) sum

motivations_statementstring nullable

summary of motivations

n_days_with_datastring

number of days with at least one meal logged

n_days_with_valid_datastring

number of days with at least one meal logged

n_meal_itemsinteger nullable

number of meal items included in the report

n_mealsinteger nullable

number of meals included in the report

name1string

logo name

name2string

logo name

name3string

logo name

notes1string nullable

emotion notes

notes2string nullable

emotion notes

notes3string nullable

emotion notes

notes4string nullable

emotion notes

notes5string nullable

emotion notes

notesStatementstring

patient emotion notes

nutrient_multipliersobject nullable

applied nutrient multipliers. Added 2022-10-27

nutrients_summary_commentsstring nullable
omega_3_statementstring nullable

list of omega-3 containing foods

patient_report_idinteger nullable

report id

plant_based_frequency_imagestring nullable

plant-based frequency image location_deprecated

plant_based_frequency_statementsstring nullable

recommended statement

plant_based_frequency_valueobject nullable

dictionary of values for plant-based frequency

potassium_dash_imagestring nullable

potassium dash image location_deprecated

potassium_dash_statementsstring nullable

potassium statements_deprecated

potassium_heatmap_imagestring nullable

filename of the potassium image

potassium_heatmap_statementstring nullable

support statement to the heatmap

protein_dash_imagestring nullable

protein dash image location_deprecated

protein_dash_statementsstring nullable

protein statements_deprecated

protein_frequency_imagestring nullable

protein frequency image location_deprecated

protein_frequency_statementsstring nullable

recommended statement

protein_frequency_valueobject nullable

dictionary of values for protein frequency

saturated_fat_dash_imagestring nullable

saturated fat dash image location_deprecated

saturated_fat_dash_statementsstring nullable

saturated fat statements_deprecated

shortest_fasting_windowstring

string of shortest fasting window

sodium_dash_imagestring nullable

sodium dash image location_deprecated

sodium_dash_statementsstring nullable

sodium statements_deprecated

star_plot_imagestring nullable

star plot image location_deprecated

supplementsstring

all supplements as a string with commas separating each property and semi-colons separating each supplement. Properties: name, unit amount, unit label, frequency, notes

total_fat_dash_imagestring nullable

total fat dash image location_deprecated

total_fat_dash_statementsstring nullable

total fat statements_deprecated

total_fats_valuestring nullable

macronutrients total fat value

ultra_processed_frequency_imagestring nullable

ultra-processed frequency image location_deprecated

ultra_processed_frequency_statementsstring nullable

recommended statement

ultra_processed_frequency_valueobject nullable

dictionary of values for ultra_processed frequency

user_created_timestring date-time

created time on user table

vegetable_frequency_statementsstring nullable

recommended statement

vegetable_servings_per_daystring nullable

servings of vegetables per day

water_frequency_imagestring nullable

water frequency image location_deprecated

Changes

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