Hide menu Last updated: Jan 10 2018
Area: Episerver Perform, Episerver Reach Applies to versions: v1.2 and higher

Migration notes (v1.2 to v1.3)

The following is a list of the changes between v1.2 and v1.3 of the Server-to-Server API.

Tracking Response

From v1.3, the API response will always contain the pageTrackingId parameter.

You can use this information when tracking on page dynamic searches or Personalized Find requests.

See the Personalized Find API document for how to track on page dynamic searches.

userAgent

From v1.3, userAgent becomes a mandatory parameter in the tracking request.

Variant Tracking

From v1.3, you can track product variants on the basket, order and checkout pages.

Search results tracking request

In v1.3, the request payload for search tracking, in particular the searchResults section, has changed to track more accurate information.

Payload for v1.2:

{ 
    "type"          : "searchresults",
    "ip"            : "10.42.37.139",
    "session"       : "155780550/hKugo5RQsqecUpmlWE6EpFWqmalVrJU",
    "cuid"          : "143159800/hKugo5RQsqecUpmlWE6Eo1OklrJYp5U",
    "site"          : "retailer",
    "clientToken"   : "1234abcd5678",
    "channel"       : "web",
    "lang"          : "en-gb",
    "currentURI"    : "www.retailer.com/search.html?term=bags",
    "previousURI"   : "www.retailer.com/home.html",
    "searchResults" : { 
        "term" : "bags", 
        "results" : [ 
            {"refCode" : "RC1"},
            { "refCode" : "RC2"} 
    ] 
    } 
}

Payload for v1.3:

{
    "type"        : "searchresults",
    "ip"          : "10.42.37.139",
    "session"     : "155780550/hKugo5RQsqecUpmlWE6EpFWqmalVrJU",
    "cuid"        : "143159800/hKugo5RQsqecUpmlWE6Eo1OklrJYp5U", 
    "site"        : "retailer", 
    "clientToken" : "1234abcd5678", 
    "channel"     : "web", 
    "lang"        : "en-gb", 
    "currentURI"  : "www.retailer.com/search.html?term=bags", 
    "previousURI" : "www.retailer.com/home. html", 
    "userAgent"   : "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36", 
    "searchResults" : { 
        "term"                        : "bags", 
        "personalisationAttributesId" : "abcd1234", 
        "totalNumberOfResults"        : 50, 
        "pageNumber"                  : 1, 
        "resultsOnPage"               : 18, 
        "filters" : [ { 
            "filter"   : "colour", 
            "operator" : "IN", 
            "values"   : ["red","orange","yellow"] 
            }, { 
            "filter"   : "price", 
            "operator" : "BW", 
            "values"   : ["0","50"] 
            }, { 
            "filter"   : "size", 
            "operator" : "IN", 
            "values"   : ["XS","S"] 
            }], 
        "topResults" : [ 
            {"refCode" : "RC1"}, 
            {"refCode" : "RC2"}, 
            {"refCode" : "RC3"} 
        ] 
    } 
}

Comments