āš«šŸ”“šŸ”µ Obtain a weekly intake summary. ā±

(S) Limited amount of calls per second.

Ā 

This endpoint provides a weekly summary of a user given a date. Any date can be passed. The information returned will be of the week that day belongs to. It also returns a dictionary named 'translations' which includes the translations into the user-preferred language for all food groups and subgroups included in the summary. For every week it informs of: Ā 

  • Day by day summary: Summary of a specific day (very similar to the response of /v2/history/getDailySummary). Ā 
  • Week: Returns the monday and sunday date of the week the passed date belongs to. Ā 
  • Week averages: For every macronutrient and the energy (carbs, fat, protein and calories) the daily average reported along with the recommended value and the achieved percentage. Ā 
  • Weekly occasion distribution: For every reported occasion it returns the total calories reported along with the percentage they represent of the total week calories. Ā 
  • Weekly portions: Recommended weekly portions for legumes, fish, eggs, nuts, meat and red meat. For each one it returns a variable with a color whether the goal was achieved, the number of eaten portions, quantity and the recommended portion range. Transparent color means there is a minium defined but it has not been achieved. Green means the eaten portions matches the recommendation. Red the rest of cases. It also returns a field called contribution_by_category, where we can see how the total eaten portions and quantity of the food group divide in each category belonging to the food group. The total eaten portions are calculated by adding all the eaten portions of the different categories and then rounding up if >= 0.85 (more than 85% of a portion is considered as one) and down if < 0.85. The image ID's that contain the food group in their prediction are included in the field image_ids. Ā 
  • Portion information: Gives extra information about the quantities used to calculate the portions

Ā  Ā 

NOTE: if the user does not consume a minimum amount of calories per day, the intakes information for that date will not be included in the weekly averages computation. The minimum calories value depends on the 'sex' of the user: female = 1000kcal, male = 1200kcal, N/A = 1100kcal.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Following the format "%Y/%m/%d".

integer

Optional parameter. Required for APIUserManagers/APICompanies. ID of the user to retrieve the information from.

string
enum

Desired language for the response. It must be a three-letter ISO 639-2/T code. Defaults to the APIUser's assigned language or english.

Responses

400

Bad request

401

Unauthorized, invalid token.

403

Forbidden

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json