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.|
[Optional] For example:
Note: When you provide user, also supply id; email is deprecated.
[Deprecated] [Optional] The email address of the customer. For example:
Note: Use id instead because name and email are deprecated and kept for backward compatibility.
[Optional] Pseudonymised ID of the user. For example:
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.
Note: For Product Recommendations, to prevent user behavior from being lost, you need to send us an up-to-date mapping between email addresses and pseudonymized user IDs. This only needs to be provided once so that Episerver Personalization can replace existing customer email addresses with their corresponding pseudonymized user ID.
|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.
|customer||Used for B2B customers, customer is an all-encompassing object in the tracking model which contains information based on a client's customer.
As of version 1.4, a new field in the tracking request allows for the handling of your customers in the tracking request, as shown in the following code.
Last updated: Nov 06, 2017