Category Events

2 min

Reporting Category Page Views

Use this API endpoint to submit category page views activity: 1. When the category response is received 2. And also when a facet is clicked (triggering a follow up query)

GET

https://{{ Analytics_URL }}/analytics/categoryProductViewTracking

Query Parameters

klevu_apiKeystringrequired
Description
This is your Klevu JS API Key.
klevu_categoryNamestringrequired
Description
This is the name of the category being visited. For example, Stackable Rings. The name should not include parent categories.
klevu_categoryPathstringrequired
Description
This is the complete hierarchy of the category being visited. For example, Jewellery;Rings;Stackable Rings. Please note the use of a semicolon as the separator between a parent and a child category.
klevu_productIdsstringrequired
Description
Comma separated list of product IDs being shown on the current page of the category page. For example, P1,P2,P3,P4,P5… All the product IDs listed here are treated as impressions for these products.
klevu_pageStartsFromstring
Description
Offset of the first product being shown on this page. For example, if you are displaying 30 products per page and if a customer is on the 2nd page, the value here should be 30. If on the 3rd page, it will be 60.
klevu_shopperIPstringrequired
Description
IP address of the shopper who viewed the category page. *If calling from javascript, this is an optional parameter.
klevu_activeFiltersstring
Description
This refers to the filters that were applied during the category page view event. The format for the applied filters is "<filterKey1>:<filterValue1>;;<filterKey2>:<filterValue2>". Multiple filters are separated by ";;". For example, "style:Underseat Luggage;;color:blue".
klevu_abTestIdstring
Description
The unique identifier of the A/B Test.
klevu_abTestVariantIdstring
Description
The unique identifier of the A/B Test Variant.
klevu_shopperIP_v4string
Description
IPv4 address of the shopper who viewed a category page.
klevu_shopperIP_v6string
Description
IPv6 address of the shopper who viewed a category page.
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 category. 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 category.

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://stats.ksearchnet.com/analytics/categoryProductViewTracking?klevu_apiKey=klevu-1234567890&klevu_categoryName=tees&klevu_categoryPath=Mens%253BShoes%2520and%2520Trainers%253BSneakers&klevu_productIds=31366450446398,31366450380862,31366479020094,31366447038526,31366447923262,31366448382014&klevu_pageStartsFrom=0',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

javascript

// WARNING: For GET requests, body is set to null by browsers.

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

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

xhr.open("GET", "https://stats.ksearchnet.com/analytics/categoryProductViewTracking?klevu_apiKey=klevu-1234567890&klevu_categoryName=tees&klevu_categoryPath=Mens%253BShoes%2520and%2520Trainers%253BSneakers&klevu_productIds=31366450446398%2C31366450380862%2C31366479020094%2C31366447038526%2C31366447923262%2C31366448382014&klevu_pageStartsFrom=0");

xhr.send();

java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://stats.ksearchnet.com/analytics/categoryProductViewTracking?klevu_apiKey=klevu-1234567890&klevu_categoryName=tees&klevu_categoryPath=Mens%3BShoes%20and%20Trainers%3BSneakers&klevu_productIds=31366450446398,31366450380862,31366479020094,31366447038526,31366447923262,31366448382014&klevu_pageStartsFrom=0")
  .method("GET", null)
  .build();
Response response = client.newCall(request).execute();

nodejs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://stats.ksearchnet.com/analytics/categoryProductViewTracking?klevu_apiKey=klevu-1234567890&klevu_categoryName=tees&klevu_categoryPath=Mens%3BShoes%20and%20Trainers%3BSneakers&klevu_productIds=31366450446398,31366450380862,31366479020094,31366447038526,31366447923262,31366448382014&klevu_pageStartsFrom=0',
  'headers': {
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

200

<data>
    <response>SUCCESS</response>
</data>

klevu_apiKey

Reporting Category Product Clicks

Use this API endpoint to submit the product clicks from category page results.

GET

https://{{ Analytics_URL }}/analytics/categoryProductClickTracking

Query Parameters

klevu_apiKeystringrequired
Description
This is your Klevu JS API Key.
klevu_categoryNamestringrequired
Description
This is the name of the category being visited. For example, Stackable Rings. The name should not include parent categories.
klevu_categoryPathstringrequired
Description
This is the complete hierarchy of the category being visited. For example, Jewellery;Rings;Stackable Rings. Please note the use of a semicolon as the separator between a parent and a child category.
klevu_productIdstringrequired
Description
This is the Klevu ID of the clicked product. eg. 54321-12345.
klevu_productGroupIdstringrequired
Description
This is the parent ID of the clicked product. eg. 54321. For compound products with a parent and multiple child/variant products, this is the common ID which ties the products together. For simple products, please specify the same as klevu_productId.
klevu_productVariantIdstringrequired
Description
This is the child/variant ID of the clicked product. eg. 12345. For compound products with a parent and multiple child/variant products, this is the ID of the specific variant. For simple products, please specify the same as klevu_productId.
klevu_productNamestring
Description
Name of the product that was clicked.
klevu_productUrlstring
Description
URL of the product that was clicked.
klevu_productSkustring
Description
SKU code of the product that was clicked.
klevu_salePricestring
Description
Decimal sale price of the product that was clicked.
klevu_productRatingsNumber
Description
A decimal rating value between 0 and 5 of the product that was clicked.
klevu_productPositionInteger
Description
Position of the product on the category page when it was clicked. For example, the value would be 0 if it is the first product on the first page. The value will be 30, if it is the first product on the 2nd page with 30 products being displayed per page.
klevu_shopperIPstringrequired
Description
IP address of the shopper who clicked the product(s). *If calling from javascript, this is an optional parameter.
klevu_activeFiltersstring
Description
This refers to the filters that were applied during the product clicked event. The format for the applied filters is "<filterKey1>:<filterValue1>;;<filterKey2>:<filterValue2>". Multiple filters are separated by ";;". For example, "style:Underseat Luggage;;color:blue".
klevu_abTestIdstring
Description
The unique identifier of the A/B Test.
klevu_abTestVariantIdstring
Description
The unique identifier of the A/B Test Variant.
klevu_shopperIP_v4string
Description
IPv4 address of the shopper who clicked a product.
klevu_shopperIP_v6string
Description
IPv6 address of the shopper who clicked 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 searched a term. 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 clicked a product.

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://stats.ksearchnet.com/analytics/categoryProductClickTracking?klevu_apiKey=klevu-1234567890&klevu_categoryName=Sneakers&klevu_categoryPath=Mens%253BShoes%2520and%2520Trainers%253BSneakers&klevu_productId=54321-12345&klevu_productGroupId=54321&klevu_productVariantId=12345&klevu_productName=Smart%2520Trainers&klevu_productUrl=https%253A%252F%252Fyour.website.com%252Fproduct-url&klevu_productSku=ABC-123&klevu_salePrice=123.45&klevu_productRatings=3&klevu_productPosition=7&klevu_abTestId=9c8bm3o1-osjgoqn9-9mbjudid&klevu_abTestVariantId=if92kdmc-98ckcj89-98cjcd9d',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

javascript


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

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

xhr.open("GET", 'https://stats.ksearchnet.com/analytics/categoryProductViewTracking?klevu_apiKey=klevu-1234567890&klevu_categoryName=tees&klevu_categoryPath=Mens%253BShoes%2520and%2520Trainers%253BSneakers&klevu_productIds=31366450446398,31366450380862,31366479020094,31366447038526,31366447923262,31366448382014&klevu_pageStartsFrom=0');

xhr.send();

java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://stats.ksearchnet.com/analytics/categoryProductClickTracking?klevu_apiKey=klevu-1234567890&klevu_categoryName=Sneakers&klevu_categoryPath=Mens%3BShoes%20and%20Trainers%3BSneakers&klevu_productId=54321-12345&klevu_productGroupId=54321&klevu_productVariantId=12345&klevu_productName=Smart%20Trainers&klevu_productUrl=https%3A%2F%2Fyour.website.com%2Fproduct-url&klevu_productSku=ABC-123&klevu_salePrice=123.45&klevu_productRatings=3&klevu_productPosition=7&klevu_abTestId=9c8bm3o1-osjgoqn9-9mbjudid&klevu_abTestVariantId=if92kdmc-98ckcj89-98cjcd9d")
  .method("GET", null)
  .build();
Response response = client.newCall(request).execute();

nodejs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://stats.ksearchnet.com/analytics/categoryProductClickTracking?klevu_apiKey=klevu-1234567890&klevu_categoryName=Sneakers&klevu_categoryPath=Mens%3BShoes%20and%20Trainers%3BSneakers&klevu_productId=54321-12345&klevu_productGroupId=54321&klevu_productVariantId=12345&klevu_productName=Smart%20Trainers&klevu_productUrl=https%3A%2F%2Fyour.website.com%2Fproduct-url&klevu_productSku=ABC-123&klevu_salePrice=123.45&klevu_productRatings=3&klevu_productPosition=7&klevu_abTestId=9c8bm3o1-osjgoqn9-9mbjudid&klevu_abTestVariantId=if92kdmc-98ckcj89-98cjcd9d',
  'headers': {
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

200

<data>
    <response>SUCCESS</response>
</data>

klevu_apiKey

Reporting A/B Test Variant View

Use this API endpoint to report which A/B test variant is viewed.

POST

https://config-cdn.ksearchnet.com/abtest/public/usage/{{ Your Klevu apiKey }}/

Query Parameters

sourceIdstringrequired
Description
The unique identifier of the element to which the A/B Test ID and Variant are assigned to. In this case, it will be a Category name.
abTestIdstringrequired
Description
The unique identifier of the A/B Test.
abTestVariantIdstringrequired
Description
The unique identifier of the A/B Test Variant.
typestringrequired
Description
The type of element to which an A/B Test will be assigned. For now, will be “CAT_NAV”.

json

{
    "sourceId": "womens;jeans",
    "abTestId": "9c8bm3o1-osjgoqn9-9mbjudid",
    "abTestVariantId": "if92kdmc-98ckcj89-98cjcd9d", 
    "type": "CAT_NAV"
}

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://config-cdn.ksearchnet.com/abtest/public/usage/klevu-158755634955912036/',
  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 =>'{
    "sourceId": "womens;jeans",
    "abTestId": "9c8bm3o1-osjgoqn9-9mbjudid",
    "abTestVariantId": "if92kdmc-98ckcj89-98cjcd9d", 
    "type": "CAT_NAV"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

javascript

var data = JSON.stringify({"sourceId":"womens;jeans","abTestId":"9c8bm3o1-osjgoqn9-9mbjudid","abTestVariantId":"if92kdmc-98ckcj89-98cjcd9d","type":"CAT_NAV"});

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

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

xhr.open("POST", "https://config-cdn.ksearchnet.com/abtest/public/usage/klevu-158755634955912036/");
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    \"sourceId\": \"womens;jeans\",\n    \"abTestId\": \"9c8bm3o1-osjgoqn9-9mbjudid\",\n    \"abTestVariantId\": \"if92kdmc-98ckcj89-98cjcd9d\", \n    \"type\": \"CAT_NAV\"\n}");
Request request = new Request.Builder()
  .url("https://config-cdn.ksearchnet.com/abtest/public/usage/klevu-158755634955912036/")
  .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://config-cdn.ksearchnet.com/abtest/public/usage/klevu-158755634955912036/',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"sourceId":"womens;jeans","abTestId":"9c8bm3o1-osjgoqn9-9mbjudid","abTestVariantId":"if92kdmc-98ckcj89-98cjcd9d","type":"CAT_NAV"})

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

200

klevu_apiKey