Recommendations Events

1 min

Reporting Recommendation Impressions

The end-point is used for reporting banner product views.

POST

https://{{ Analytics_URL }}/analytics/collect

Body Parameters

eventstringrequired
Description
Please use view_recs_list
event_apikey stringrequired
Description
Your Klevu JS Api Key, eg. klevu-12345.
event_list_idstringrequired
Description
The unique identifier for your KMC Recommendations Banner, eg. 12345-abcde. This is available in the banner configuration metadata as recsKey. If you are not using banners configured within the KMC, please specify a unique identifier for the banner which will be used to distinguish one banner from another.
event_list_namestringrequired
Description
The name of the banner, eg. New Arrivals. This is available in the banner configuration metadata as title
event_list_logicstringrequired
Description
The logic type of the banner, eg. NEWEST_ARRIVALS. This is available in the banner configuration metadata as logic.
event_tagsArray
Description
This can be used to specify additional information about the event, which will eventually be made available within the KMC. We recommend you specify the type of page, eg. HOME. This is available in the banner configuration metadata as pageType.
user_profileObjectrequired
Description
The json object that holds the user related information such as ip_address.
- ip_addressstringrequired
  Description
  IP address of the shopper who viewed the event *If calling from javascript, this is an optional parameter.
- ip_address_v4string
  Description
  IPv4 address of the shopper who viewed a product.
- ip_address_v6string
  Description
  IPv6 address of the shopper who viewed a product.
- data_protectionBoolean
  Description
  If set to false, Klevu's backend do not obtain the shoppers' IP address. The default value is true.
- klevu_uuidstring
  Description
  Universally unique identifier generated by Klevu, it can be also considered as session id. Please obtain UUID using end-point: https://docs.klevu.com/apis/uuid
- klevu_countrystring
  Description
  2-digit country code of the shopper who viewed a product. Valid codes can be found at https://developers.google.com/hotels/hotel-prices/dev-guide/country-codes
- klevu_citystring
  Description
  City name of the shopper who viewed a product.
itemsArrayrequired
Description
Iterate all of the products in the banner and populate the item data for each.
item_idstringrequired
Description
The full ID of the product. eg. 12345-54321. This will match the unique value used in your data sync process with Klevu. For compound products consisting of a child/variant and a parent, this is usually parentId-childId.
item_group_idstringrequired
Description
The Parent ID of the product. eg. 12345. For compound products consisting of a child/variant and a parent, please specify the ID of the parent. For simple products, please re-use the same value as item_id
item_variant_idstringrequired
Description
The Child ID of the product.eg. 54321. Please specify the ID of the child/variant product. For simple products, please re-use the same value as item_id.
item_namestringrequired
Description
The name of the product.
priceNumberrequired
Description
The final selling price of the product, for example 123.45
currencystring
Description
The currency of the above price, eg. USD.
item_brandstring
Description
The brand of the product, for example "Nike" or "Acme".
item_categorystring
Description
The category the item belongs to. For nested categories, use the ; character to separate the hierarchy, and for multiple categories use a double ;;. For example, for 'Mens > Shoes > Trainers' and 'Sale' you would specify: Mens;Shoes;Trainers;;Sale.
indexIntegerrequired
Description
The order of the product in the listing, starting from 1

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://stats.ksearchnet.com/analytics/collect',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'[
  {
    "event": "view_recs_list",
    "event_apikey": "klevu-12345",
    "event_list_id": "12345-abcde",
    "event_tags": [
      "recsPageType:category"
    ],
    "event_list_name": "New Arrivals",
    "event_list_logic": "NEWEST_ARRIVALS",
    "user_profile" : {
       "ip_address":"111.11.11.1"
    },
    "items": [
      {
        "item_id": "12345-54321",
        "item_group_id": "12345",
        "item_variant_id": "54321",
        "item_name": "Hoodie Sweatshirt",
        "price": "123.45",
        "currency": "GBP",
        "item_brand": "Acme",
        "item_category": "All;;Coats & Jackets;;Womens Coats",
        "index": 1
      }
    ]
  },
  {
    "event": "select_recs_list",
    "event_apikey": "klevu-12345",
    "event_list_id": "12345-abcde",
    "event_tags": [
      "recsPageType:category"
    ],
    "event_list_name": "New Arrivals",
    "event_list_logic": "NEWEST_ARRIVALS",
    "user_profile" : {
       "ip_address":"111.11.11.1"
    },
    "items": [
      {
        "item_id": "12345-54321",
        "item_group_id": "12345",
        "item_variant_id": "54321",
        "item_name": "Hoodie Sweatshirt",
        "price": "123.45",
        "currency": "GBP",
        "item_brand": "Acme",
        "item_category": "All;;Coats & Jackets;;Womens Coats",
        "index": 1
      }
    ]
  }
]',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

javascript

var data = JSON.stringify([{"event":"view_recs_list","event_apikey":"klevu-12345","event_list_id":"12345-abcde","event_tags":["recsPageType:category"],"event_list_name":"New Arrivals","event_list_logic":"NEWEST_ARRIVALS","user_profile" : {"ip_address":"111.11.11.1"},"items":[{"item_id":"12345-54321","item_group_id":"12345","item_variant_id":"54321","item_name":"Hoodie Sweatshirt","price":"123.45","currency":"GBP","item_brand":"Acme","item_category":"All;;Coats & Jackets;;Womens Coats","index":1}]},{"event":"select_recs_list","event_apikey":"klevu-12345","event_list_id":"12345-abcde","event_tags":["recsPageType:category"],"event_list_name":"New Arrivals","event_list_logic":"NEWEST_ARRIVALS","items":[{"item_id":"12345-54321","item_group_id":"12345","item_variant_id":"54321","item_name":"Hoodie Sweatshirt","price":"123.45","currency":"GBP","item_brand":"Acme","item_category":"All;;Coats & Jackets;;Womens Coats","index":1}]}]);

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://stats.ksearchnet.com/analytics/collect");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n  {\n    \"event\": \"view_recs_list\",\n    \"event_apikey\": \"klevu-12345\",\n    \"event_list_id\": \"12345-abcde\",\n    \"event_tags\": [\n      \"recsPageType:category\"\n    ],\n    \"event_list_name\": \"New Arrivals\",\n    \"event_list_logic\": \"NEWEST_ARRIVALS\",\n \"user_profile\" : {\"ip_address\":\"111.11.11.1\"},\n   \"items\": [\n      {\n        \"item_id\": \"12345-54321\",\n        \"item_group_id\": \"12345\",\n        \"item_variant_id\": \"54321\",\n        \"item_name\": \"Hoodie Sweatshirt\",\n        \"price\": \"123.45\",\n        \"currency\": \"GBP\",\n        \"item_brand\": \"Acme\",\n        \"item_category\": \"All;;Coats & Jackets;;Womens Coats\",\n        \"index\": 1\n      }\n    ]\n  },\n  {\n    \"event\": \"select_recs_list\",\n    \"event_apikey\": \"klevu-12345\",\n    \"event_list_id\": \"12345-abcde\",\n    \"event_tags\": [\n      \"recsPageType:category\"\n    ],\n    \"event_list_name\": \"New Arrivals\",\n    \"event_list_logic\": \"NEWEST_ARRIVALS\",\n    \"items\": [\n      {\n        \"item_id\": \"12345-54321\",\n        \"item_group_id\": \"12345\",\n        \"item_variant_id\": \"54321\",\n        \"item_name\": \"Hoodie Sweatshirt\",\n        \"price\": \"123.45\",\n        \"currency\": \"GBP\",\n        \"item_brand\": \"Acme\",\n        \"item_category\": \"All;;Coats & Jackets;;Womens Coats\",\n        \"index\": 1\n      }\n    ]\n  }\n]");
Request request = new Request.Builder()
  .url("https://stats.ksearchnet.com/analytics/collect")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

nodejs

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://stats.ksearchnet.com/analytics/collect',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([{"event":"view_recs_list","event_apikey":"klevu-12345","event_list_id":"12345-abcde","event_tags":["recsPageType:category"],"event_list_name":"New Arrivals","event_list_logic":"NEWEST_ARRIVALS","user_profile" : {"ip_address":"111.11.11.1"},"items":[{"item_id":"12345-54321","item_group_id":"12345","item_variant_id":"54321","item_name":"Hoodie Sweatshirt","price":"123.45","currency":"GBP","item_brand":"Acme","item_category":"All;;Coats & Jackets;;Womens Coats","index":1}]},{"event":"select_recs_list","event_apikey":"klevu-12345","event_list_id":"12345-abcde","event_tags":["recsPageType:category"],"event_list_name":"New Arrivals","event_list_logic":"NEWEST_ARRIVALS","items":[{"item_id":"12345-54321","item_group_id":"12345","item_variant_id":"54321","item_name":"Hoodie Sweatshirt","price":"123.45","currency":"GBP","item_brand":"Acme","item_category":"All;;Coats & Jackets;;Womens Coats","index":1}]}])

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

200

Reporting Banner Product Clicks

The end-point is used for reporting banner product clicks.