Recommendations API schemas

information_field
optional

The Froomle API can be configured to return additional information fields (if present in the item information). Please contact the Froomle support team to set this up.

string

item_id
required

The identifier of the recommended item

string

rank
required

The rank at which the item should be recommended. Starts counting at 1. If not specified, Froomle will decide the rank.

integer

channel
required

The channel used to request the recommendations. Accepted channels are: www, www-desktop, www-mobile, app, app-ios, app-android, app-audio, app-audio-ios and app-audio-android. If none of these fit your use case, please get in touch with your account manager.

string

context_item
optional

Unique identifier for the currently displayed item. Required only on article pages.

string

context_item_type
optional

Type of the currently displayed item, if applicable.

string

device_id
required

Unique identifier for a unregistered user (e.g. cookie). Use the value "no-consent" for users that wish to remain anonymous.

string

histories
optional

Histories

lists
required

One or more lists of recommendations to receive. When showing multiple recommendation blocks (e.g. “recommended for you”, “continue reading”, “recent items”) on the same page, include all of them in a single lists array. This ensures that recommendations are generated together, enabling the engine to avoid duplicate items across blocks.

< RequestList > array

page_type
required

The page type to request recommendations for. Standard page_types are: home, category, article_detail, product_detail, video_detail, and checkout. If none of these fit your use case, please get in touch with your account manager.

string

user_id
optional

Unique identifier for a logged-in user

string

device_id
optional

Unique identifier for an unregistered user (e.g. cookie). Use the value "no-consent" for users that wish to remain anonymous.

string

lists
optional

List of lists of items

< ResponseList > array

request_id
optional

The request identifier as supplied by Froomle. This request_id needs to be supplied with each logged event.

string

user_group
optional

The group the user is assigned to. If users get the Froomle experience, this will always be "froomle".

string

user_id
optional

the user id of the logged-in user

string