Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v2.0.0
v2.0.0
  • The Whisk Platform
  • Whisk API Overview
    • Introduction
    • Integration
    • Authentication
      • Server Token
      • User Access Token
        • Auth Flow Example
      • Client Token
      • Anonymous Access from Client Apps
    • Whisk Sandbox
    • Getting Started
  • Whisk API Reference 2.0
    • Provisioning
      • Get provisioning
    • Autocomplete
    • Community
      • Get your Communities
      • Get Communities from a Topic
      • Discover Recommended Communities
      • Search Communities
      • Get a Community
      • Get Recipes from a Community
      • Add Recipes to a Community
      • Remove a Recipe from a Community
      • Join a Community
      • Leave a Community
    • Posts and Reviews
      • Get reviews for a recipe
      • Create or edit review
      • Create a Post
      • Get Post by id
      • Delete a Post
      • Edit a Post
      • Report a Post
      • Create a Post Reply
      • Get Post Replies
      • Delete a Post reply
      • Report a Post reply
      • Like a Post or Reply
      • Users who liked a Post or Reply
    • Public profiles
      • Hide recipe in Public profile
      • Get Recipes for Public Profile
      • Get User's public profile by user_id
      • Get User's public profile by username
    • Custom Label
    • Feed
      • Obtain a Recipe Feed
    • Food DB
      • Autocomplete
      • Search
      • Get Food
    • Food List
    • Food Log
    • Foodpairing
    • Healthy meal recommendations
      • Healthy recipe only recommendations for DA
      • Recipe recommendations for SH
      • Tailored Plan API request for Samsung TV
    • Meal Plan
      • Generate a Meal Plan
      • Meal Object
        • Get Meals
        • Delete Meal
        • Add a Meal
      • Meal Plan Settings Object
        • Get Meal Plan Settings
        • Update Meal Plan Settings
      • Meal Plan Batch
    • Recipe
      • Get a Recipe
      • Search a Recipe
      • User Recipes & Collections
        • Add User Recipe
        • Create A Recipe
        • Update External Recipe
        • Get All User Recipes
        • Update User Recipe
        • Remove Recipe from Favorites
        • Create Collection
        • Get All User Collections
        • Get Collection
        • Get Recipes from a Collection
        • Remove Collection
        • Get Smart Collection
        • Get Recipes from a Smart Collection
    • Shopping List
      • Get your Shopping Lists
      • Get a Shopping List
      • Create a Shopping List
      • Delete a Shopping List
      • Update basic details of a Shopping List
      • Move Items between Shopping Lists
      • Add Items to a Shopping List
      • Delete an Item from a Shopping List
      • Update an Item in a Shopping List
      • Clear Items from a Shopping List
    • Media
    • Store Item
    • Unit Conversion
    • Users
      • Get a User
      • Update User Settings using Patch
      • Update User Settings using Post
    • Try it out!
  • Shopping List SDK
    • Overview
    • Examples
      • Shoppable Recipes
      • Shoppable Products
      • Shoppable Media
    • Basic Setup
      • Basic Setup
      • Methods
      • Event Listeners
      • Widget
      • Subscriptions
      • Global Configuration
      • UTM Parameters
      • Using With SPA
  • Shopping List Mobile API
    • Overview
    • Examples
    • Reference
  • API Resources
    • Authentication Scopes
    • Errors and Troubleshooting
    • Cursor Pagination
    • Limits
    • Nutrients
    • Recipe Labels
    • Filtering Recipes using Custom Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Integrated Retailers
    • Optimizing Image Load
    • Meal Plan
Powered by GitBook
On this page
  • Recommend for chosen mealtime
  • Recommend for chosen local time
  • Recommend for the whole day

Was this helpful?

  1. Whisk API Reference 2.0
  2. Healthy meal recommendations

Healthy recipe only recommendations for DA

PreviousHealthy meal recommendationsNextRecipe recommendations for SH

Last updated 1 year ago

Was this helpful?

Recommend for chosen mealtime

curl -X GET "https://api.whisk.com/health/recommendations/v2/recommend?meal_time=MEAL_TIME_BREAKFAST&health_profile.height=1.60&health_profile.weight=55&health_profile.activity.leisure=LEISURE_ACTIVITY_LIGHT&health_profile.activity.living=LIVING_ACTIVITY_MODERATE&health_profile.daily_kcal_goal=1700" -H "accept: application/json" -H "Authorization: Bearer %USER_TOKEN%"

Recommend for chosen local time

curl -X GET "https://api.whisk.com/health/recommendations/v2/recommend?local_time.minutes=25&local_time.hours=10&offset_timezone=-4&health_profile.height=1.60&health_profile.weight=55&health_profile.activity.leisure=LEISURE_ACTIVITY_LIGHT&health_profile.activity.living=LIVING_ACTIVITY_MODERATE&health_profile.daily_kcal_goal=1700" -H "accept: application/json" -H "Authorization: Bearer %USER_TOKEN%"

Recommend for the whole day

curl -X GET "https://api.whisk.com/health/recommendations/v2/recommend/daily?date.year=2022&date.month=11&date.day=16&offset_timezone=2&health_profile.height=1.60&health_profile.weight=55&health_profile.activity.leisure=LEISURE_ACTIVITY_ACTIVE&health_profile.activity.living=LIVING_ACTIVITY_HEAVY&health_profile.daily_kcal_goal=1700" -H "accept: application/json" -H "Authorization: Bearer %USER_TOKEN%"

Get recommended nutrition goals with levels

health_profile.daily_kcal_goal is optional. We recommend not to pass it to let Whisk recommendation algorithm calculate it based on other parameters.

curl -X GET "https://api.whisk.com/health/recommendations/v2/goal?date.year=2022&date.month=11&date.day=15&health_profile.height=1.60&health_profile.weight=55&health_profile.activity.leisure=LEISURE_ACTIVITY_MODERATE&health_profile.activity.living=LIVING_ACTIVITY_VERY_LIGHT" -H "accept: application/json" -H "Authorization: Bearer %USER_TOKEN%"

Example response

The fields below enable to render fine-tuned color-based indication for recommended nutrition values and how logged food data fits into the recommendations

nutrition_goal represents the complete daily goal for different nutrients

nutrition_goals_per_meal represents nutrition goal breakdown by mealtype. It sums up to nutrition_goal values.

levels_daily represents how different levels should be rendered within a certain goal

e.g. daily goal for FAT (from nutrition_goal field) is 72g and NUTRITION_LEVEL_NORMAL is between 0.8 and 1.2. It means logged nutrition values for FAT between 57.6g and 86.4g are considered normal and should be rendered in a green color (depending on the UI)

levels_per_meal represents recommended nutrition levels for each mealtype

e.g. recommended value for Carbohydrates (NUTRITION_CODE_CHOCDF from nutrition_goals_per_meal field) for Breakfast is 107g and NUTRITION_LEVEL_NORMAL is between 0.8 and 1. It means logged nutrition values for Carbohydrates between 85.6g and 107g are considered normal.

{
  "nutrition_goal": [
    {
      "goal": 2600,
      "code": "NUTRITION_CODE_ENERC_KCAL",
      "unit_name": "NUTRITION_UNIT_KCAL"
    },
    {
      "goal": 130,
      "code": "NUTRITION_CODE_PROCNT",
      "unit_name": "NUTRITION_UNIT_G"
    },
    {
      "goal": 72.22222222222223,
      "code": "NUTRITION_CODE_FAT",
      "unit_name": "NUTRITION_UNIT_G"
    },
    {
      "goal": 357.50000000000006,
      "code": "NUTRITION_CODE_CHOCDF",
      "unit_name": "NUTRITION_UNIT_G"
    }
  ],
  "levels_daily": {
    "levels": [
      {
        "level": "NUTRITION_LEVEL_LOW",
        "range": {
          "less_then": {
            "value": 0.8
          }
        }
      },
      {
        "level": "NUTRITION_LEVEL_NORMAL",
        "range": {
          "between": {
            "left": 0.8,
            "is_left_closed": true,
            "right": 1.2,
            "is_right_closed": true
          }
        }
      },
      {
        "level": "NUTRITION_LEVEL_HIGH",
        "range": {
          "greater_then": {
            "value": 1.2
          }
        }
      }
    ]
  },
  "nutrition_goals_per_meal": [
    {
      "meal_time": "MEAL_TIME_BREAKFAST",
      "goal": [
        {
          "goal": 107.25000000000001,
          "code": "NUTRITION_CODE_CHOCDF",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 21.666666666666664,
          "code": "NUTRITION_CODE_FAT",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 39,
          "code": "NUTRITION_CODE_PROCNT",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 780,
          "code": "NUTRITION_CODE_ENERC_KCAL",
          "unit_name": "NUTRITION_UNIT_KCAL"
        }
      ]
    },
    {
      "meal_time": "MEAL_TIME_DINNER",
      "goal": [
        {
          "goal": 107.25000000000001,
          "code": "NUTRITION_CODE_CHOCDF",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 21.666666666666664,
          "code": "NUTRITION_CODE_FAT",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 39,
          "code": "NUTRITION_CODE_PROCNT",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 780,
          "code": "NUTRITION_CODE_ENERC_KCAL",
          "unit_name": "NUTRITION_UNIT_KCAL"
        }
      ]
    },
    {
      "meal_time": "MEAL_TIME_LUNCH",
      "goal": [
        {
          "goal": 107.25000000000001,
          "code": "NUTRITION_CODE_CHOCDF",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 21.666666666666664,
          "code": "NUTRITION_CODE_FAT",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 39,
          "code": "NUTRITION_CODE_PROCNT",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 780,
          "code": "NUTRITION_CODE_ENERC_KCAL",
          "unit_name": "NUTRITION_UNIT_KCAL"
        }
      ]
    },
    {
      "meal_time": "MEAL_TIME_SNACK",
      "goal": [
        {
          "goal": 35.75000000000001,
          "code": "NUTRITION_CODE_CHOCDF",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 7.222222222222223,
          "code": "NUTRITION_CODE_FAT",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 13,
          "code": "NUTRITION_CODE_PROCNT",
          "unit_name": "NUTRITION_UNIT_G"
        },
        {
          "goal": 260,
          "code": "NUTRITION_CODE_ENERC_KCAL",
          "unit_name": "NUTRITION_UNIT_KCAL"
        }
      ]
    }
  ],
  "levels_per_meal": {
    "levels": [
      {
        "level": "NUTRITION_LEVEL_VERY_LOW",
        "range": {
          "less_then": {
            "value": 0.5
          }
        }
      },
      {
        "level": "NUTRITION_LEVEL_LOW",
        "range": {
          "between": {
            "left": 0.5,
            "is_left_closed": true,
            "right": 0.8
          }
        }
      },
      {
        "level": "NUTRITION_LEVEL_NORMAL",
        "range": {
          "between": {
            "left": 0.8,
            "is_left_closed": true,
            "right": 1,
            "is_right_closed": true
          }
        }
      },
      {
        "level": "NUTRITION_LEVEL_ABOVE_NORMAL_ACCEPTABLE",
        "range": {
          "between": {
            "left": 1,
            "right": 1.2,
            "is_right_closed": true
          }
        }
      },
      {
        "level": "NUTRITION_LEVEL_HIGH",
        "range": {
          "greater_then": {
            "value": 1.2
          }
        }
      }
    ]
  }
}
Full API reference
Full API reference
Full API reference
Full API reference