User Model

When using Whisk Recommendation and Personalisation APIs client app needs to maintain User Identity in the platform

The id of a User is then being submitted when accessing/feed or /search endpoints.

Whisk considers User Preferences such as diets or avoidances and user impressions such as Like or View events to personalise the output

Model

ATTRIBUTETYPEDESCRIPTION
id*string

The id of the User on Whisk Graph

externalUserIdstring

The user id you have defined for the user. (Max limit of 255 UTF-8 characters, and should not have trailing or leading spaces)

emailstring

The email you have defined for the user. (Max limit of 255 UTF-8 characters, and should not have trailing or leading spaces)

firstNamestring

The first name of the user

lastNamestring

The last name of the user

displayNamestring

The display name of the user

createdAttimestamp

The time the user was added to Whisk

updatedAttimestamp

The last time the user was updated

pictureUrlstring

The profile picture url of a user

preferencesUserPreferences

Preferences

ATTRIBUTETYPEDESCRIPTION
countrystring

Country iso code. Examples: gb, kr, us...

zipCodestring

Postal code. Examples: 10001, 80333...

languagestring

Language iso code. Examples: en, ko, fr...

cookingSkillenum

Measure of a person’s competence in preparing and cooking foods

Possible values: amateur, intermediate, advanced.
genderenum
Possible values: female, male.
householdSizeChildreninteger

Number of children

householdSizeAdultsinteger

Number of adults

Default value: 1
dislikedIngredientsarray [string]

Products and ingridients which will be excluded in searcd and feed APIs.

dietsarray [string]
avoidancesarray [string]