Banners

1min
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
Request
Body Parameters
JS_API_KEY
required
String
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'
curl --location --request GET 'https://js.klevu.com/klevu-js-v1/klevu-js-api/klevu-1234567890-banner.json'
Responses
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"
        }
    ]
}
{
    "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"
        }
    ]
}
﻿
Utilize the following API endpoint to submit the click events for banners.
GET
Request
Query Parameters
klevu_term
required
String
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_bannerId
required
Number
This will be bannerRef value as shown in above API call response.
klevu_image
required
String
This is the banner image URL.
klevu_target
required
String
This is target URL.
klevu_request
required
String
The value of this field will be “click“.
type
required
String
The value of this field will be “banner“.
klevu_apiKey
required
String
This is your Klevu JS API Key.
klevu_bannerName
optional
String
This is banner name.
Curl
PHP
JS
Node.js
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();
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();
Responses
200
<data>
    <response>SUCCESS</response>
</data>
<data>
    <response>SUCCESS</response>
</data>
﻿
﻿
Updated 30 Oct 2023
Did this page help you?
URL Redirects
No Results Customisations