Recommendations Events

1min
﻿
The end-point is used for reporting banner product views.
POST
Request
Body Parameters
event
String
required
Please use view_recs_list
event_apikey	
String
required
Your Klevu JS Api Key, eg. klevu-12345.
event_list_id
String
required
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_name
String
required
The name of the banner, eg. New Arrivals. This is available in the banner configuration metadata as title
event_list_logic
String
required
The logic type of the banner, eg. NEWEST_ARRIVALS. This is available in the banner configuration metadata as logic.
event_tags
Array
optional
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_profile
Object
required
The json object that holds the user related information such as ip_address. 
items
Array
required
Iterate all of the products in the banner and populate the item data for each.
item_id
String
required
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_id
String
required
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_id
String
required
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_name
String
required
The name of the product.
price
Number
required
The final selling price of the product, for example 123.45
currency
String
optional
The currency of the above price, eg. USD.
item_brand
String
optional
The brand of the product, for example "Nike" or "Acme".
item_category
String
optional
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.
index
Integer
required
The order of the product in the listing, starting from 1
PHP
JS
Java
Node.js
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);
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);
Responses
200

﻿
﻿
The end-point is used for reporting banner product clicks.
POST
Request
Body Parameters
event
String
required
Please use select_recs_list
event_apikey	
String
required
Your Klevu JS Api Key, eg. klevu-12345.
event_list_id
String
required
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_name
String
required
The name of the banner, eg. New Arrivals. This is available in the banner configuration metadata as title
event_list_logic
String
required
The logic type of the banner, eg. NEWEST_ARRIVALS. This is available in the banner configuration metadata as logic.
event_tags
Array
optional
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_profile
Object
required
The json object that holds the user related information such as ip_address. 
items
Array
required
Provide specific information about the one product which was clicked within your banner.
item_id
String
required
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_id
String
required
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_id
String
required
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_name
String
required
The name of the product.
price
Number
required
The final selling price of the product, for example 123.45
currency
String
optional
The currency of the above price, eg. USD.
item_brand
String
optional
The brand of the product, for example "Nike" or "Acme".
item_category
String
optional
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.
index
Integer
required
The order of the product in the listing, starting from 1
PHP
JS
Java
Node.js
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();
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();
Responses
200

﻿
﻿
Updated 13 Aug 2024
Did this page help you?
Category Events
Purchase Data