Banners

1 min

Banners

This API call uses a simple GET request with no payload, and since it is intended for use on the frontend there is no authentication required.

GET

https://js.klevu.com/klevu-js-v1/klevu-js-api/{{JS_API_KEY}}-banner.json

Body Parameters

JS_API_KEYstringrequired
Description
Your public Klevu JS API Key.

curl

curl --location --request GET 'https://js.klevu.com/klevu-js-v1/klevu-js-api/klevu-1234567890-banner.json'

200

{
    "klevu_banner": [
        {
            "showForTerms": null,
            "showOnLandingPage": true,
            "redirectUrl": "https://demo.ksearchmisc.com/klevusearch/home-decor.html",
            "showOnQuickSearch": true,
            "endDate": "2021/08/18",
            "bannerName": "disney plus",
            "position": "bottom",
            "bannerRef": 8840,
            "bannerImg": "https://www.denofgeek.com/wp-content/uploads/2019/11/disney-plus-free-trial-banner.jpg",
            "showOnCategoryPage": false,
            "startDate": "2021/8/17"
        }
    ]
}

Reporting Banner Click events

Utilize the following API endpoint to submit the click events for banners.

GET

https://stats.ksearchnet.com/analytics/dataTracking

Query Parameters

klevu_termstringrequired
Description
This field refers to the search term used when submitting banner click events. When submitting click events on Category pages, you can indicate that it is a banner click event by using an asterisk (*) in place of the actual search term. This helps differentiate it from regular search term submissions.
klevu_bannerIdNumberrequired
Description
This will be bannerRef value as shown in above API call response.
klevu_imagestringrequired
Description
This is the banner image URL.
klevu_targetstringrequired
Description
This is target URL.
klevu_requeststringrequired
Description
The value of this field will be “click“.
typestringrequired
Description
The value of this field will be “banner“.
klevu_apiKeystringrequired
Description
This is your Klevu JS API Key.
klevu_bannerNamestring
Description
This is banner name.

curl

curl --location --request GET 'https://stats.ksearchnet.com/analytics/dataTracking?klevu_term=tee&klevu_bannerId=12463&klevu_image=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_target=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_request=click&type=banner&klevu_apiKey=klevu-1234567890'

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://stats.ksearchnet.com/analytics/dataTracking?klevu_term=tee&klevu_bannerId=12463&klevu_image=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_target=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_request=click&type=banner&klevu_apiKey=klevu-1234567890',
  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 formdata = new FormData();

var requestOptions = {
  method: 'GET',
  body: formdata,
  redirect: 'follow'
};

fetch('https://stats.ksearchnet.com/analytics/dataTracking?klevu_term=tee&klevu_bannerId=12463&klevu_image=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_target=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_request=click&type=banner&klevu_apiKey=klevu-1234567890', requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

nodejs

const axios = require('axios');
const FormData = require('form-data');
let data = new FormData();

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://stats.ksearchnet.com/analytics/dataTracking?klevu_term=tee&klevu_bannerId=12463&klevu_image=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_target=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_request=click&type=banner&klevu_apiKey=klevu-1234567890',
  headers: { 
    ...data.getHeaders()
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
MediaType JSON = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(JSON, "{}");
Request request = new Request.Builder()
  .url("https://stats.ksearchnet.com/analytics/dataTracking?klevu_term=tee&klevu_bannerId=12463&klevu_image=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_target=http%3A%2F%2Fmagento243eep1new.com%2Fmedia%2Fcatalog%2Fproduct%2Fcache%2F860616d0cbe1eba675de08cae449bd25%2Fm%2Fj%2Fmj08-gray_main_1.jpg&klevu_request=click&type=banner&klevu_apiKey=klevu-1234567890")
  .method("GET", body)
  .build();
Response response = client.newCall(request).execute();

200

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