This article describes the structure common to all pages. Next, additional elements needed for each page type are added for illustration.
- Elements are mandatory unless the [Optional] tag is present.
- All values are assumed to be JSON strings, except where the [Number] tag is used (all numbers are 64-bit integers, such as a Java Long data type).
- The [String] tag explicitly identifies the JSON data type.
- Indentation and extra whitespaces in JSON response examples are added for readability of JSON data in this document; spaces are not required in the actual JSON responses.
Elements common to all request types.
|type||Type of page||The type of the page determines the message format. Valid page types are the following:|
|lang||Language code||See Language codes.|
|user||Pseudonymised ID of the user||[Optional] This identifies the user in the Personalization system. Use the user ID to improve tracking and recommendations; you can use it also in other Episerver products, such as Mail and Triggers.|
|channel||Access channel||[Optional] Available values are:
Note: If omitted, web is assumed.
|abTestContent||Controls how much A/B test information to return in the info callback.||[Optional] Available values are:
Note: If this attribute is omitted, no A/B Testing information is returned.
|recContent||Recommendation content configuration||[Optional] Available values are:
Note: If omitted full is assumed.
|customAttributes||Allows real-time filtering of recommendations based on the specified custom attributes||
A comma-separated list of attribute names and values. Attribute names must contain no spaces.
Custom attributes are only used in real-time; they are not stored in the system.
Last updated: Nov 06, 2017