Loading...
Area: Episerver Product Recommendations
Applies to versions: 1.4 and higher (Server-to-Server API)
Other versions:

Click tracking

Recommendations [hide]

To generate useful recommendations, clicks on recommended content must be sent to Episerver servers. Supply this information in an info element.

Name Description Usage
info   An array of Episerver products.
Available values are: smartRecs and smartContent.
  smartRecs   An array of click information.
    click Click information for an Episerver product recommendation. [64-bit number]

Confirmation that the click
was successful and its
Episerver recommendation ID.

For example:

"click": 5637282

    clientRecRefcodes Product IDs for displayed non-Episerver product recommendations. [Optional]

For example:

"clientRecRefcodes": ["REF1","REF2","REF3"]

    clientRecClicks Product IDs for clicked non-Episerver product recommendations. [Optional]

For example:

"clientRecClicks": ["REF4","REF5","REF6"]

You should track the click as part of the next page tracking request to the API. For example, if a customer lands on a product page (RC456.html) by clicking on a Episerver recommendation with a recommendation ID of 5637282 from another product page (RC123.html), include the recommendation ID that was clicked from the previous product page as shown below.

{	
  "type"	: "product",
  "ip"		: "10.42.37.139",
  "session"	: "123456789012|a1b2c3d4e5A6B7C8D9E0f1g2h3i4j5F1G2H3I4J5k1l",
  "cuid"	: "09876543210|Z0Y9X8W7V6z5y4x3w2v1U0T9S8R7Q6u5t4s3r2q1P0O",
  "site"	: "retailer",
  "clientToken"	: "1234abcd5678",
  "channel"	: "web",
  "lang"	: "en-gb",
  "currentURI"	: "www.retailer.com/product/RC456.html",
  "previousURI"	: "www.retailer.com/product/RC123.html",
  "userAgent"	: "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
  "product"	: {
                    "refCode" : "RC456"
		  },
	            "info"    : {
       		                  "smartRecs" : {
         		                          "click": 5637282
      		                                }
	                        }
}

In this example, 5637282 is the ID of the clicked recommendation.

Do you find this information helpful? Please log in to provide feedback.

Last updated: Nov 06, 2017

Recommendations [hide]