Canvas - calendar.get_month

Description

Displays the monthly summary of food and exercise information for a given month and allows quick access to the Food Diary and Exercise Diary for any given day of the month.

Example

Figure 1: the calendar.get_month canvas

Default Navigation Section

Diet Calendar

Requires Authentication

Yes

Sections

Name Description
calendar
Displays a calendar for the currently currently selected month. Each day in the month has:
  • A link to the Food Diary with the text as the number of calories consumed for that day (shows "food" if not authenticated or if there is no entries for the day)
  • A link to the Exercise Diary with the text as the number of calories burned for that day (shows "exercise" if not authenticated or if there is no entries for the day)
  • The net gain or loss for the day (only if there is an entry for both food and exercise for that day)
dailycarbsaverage The daily average of carbohydrates consumed for the currently selected month in the format xxx g. E.G.: 309.60 g
dailyexerciseaverage The daily average of calories burned for the currently selected month in the format xxx kcal. E.G.: 2973 kcal
dailyfataverage The daily average of fat consumed for the currently selected month in the format xxx g. E.G.: 104.80 g
dailyfoodaverage The daily average of calories consumed for the currently selected month in the format xxx kcal. E.G.: 2665 kcal
dailyproteinaverage The daily average of protein consumed for the currently selected month in the format xxx g. E.G.: 110.36 g
date The currently selected month in the format MMMM YYYY. E.G.: May 2009
monthlycarbstotal The monthly total of carbohydrates consumed for the currently selected month in the format xxx g. E.G.: 1238.39 g
monthlyexercisetotal The monthly total of calories burned for the currently selected month in the format xxx kcal. E.G.: 11843 kcal
monthlyfattotal The monthly total of fat consumed for the currently selected month in the format xxx g. E.G.: 419.16 g
monthlyfoodtotal The monthly total of calories consumed for the currently selected month in the format xxx kcal. E.G.: 10660 kcal
monthlyproteintotal The monthly total of protein consumed for the currently selected month in the format xxx g. E.G.: 441.43 g
nextmonth A link to the next month of the currently selected month in the format MMMM YY. E.G.: June 09
previousmonth A link to the previous month of the currently selected month in the format MMMM YY. E.G.: April 09

Optional setCanvas Parameters

Name Type Description
calendar_date Int The number of days since January 1, 1970 (default value is the current day).

Related REST API Calls

Related Canvases

Diagram

Figure 2: the calendar.get_month canvas dissected
FatSecret Sites
For Developers

For Professionals

For Everyone

FatSecret Platform API

Support
API

About FatSecret

© 2021 FatSecret. All rights reserved.