--- title: Banners slug: apis/banners docTags: createdAt: 2022-05-13T13:08:57.000Z --- :::ApiMethodV2 ```json { "tab": "examples", "url": "https://js.klevu.com/klevu-js-v1/klevu-js-api/{{JS_API_KEY}}-banner.json", "name": "Banners", "method": "GET", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "JS_API_KEY", "type": "string", "description": "Your public Klevu JS API Key.\n" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "Y1Vx38kZQPtiLmsufAFM_", "code": "{\n \"klevu_banner\": [\n {\n \"showForTerms\": null,\n \"showOnLandingPage\": true,\n \"redirectUrl\": \"https://demo.ksearchmisc.com/klevusearch/home-decor.html\",\n \"showOnQuickSearch\": true,\n \"endDate\": \"2021/08/18\",\n \"bannerName\": \"disney plus\",\n \"position\": \"bottom\",\n \"bannerRef\": 8840,\n \"bannerImg\": \"https://www.denofgeek.com/wp-content/uploads/2019/11/disney-plus-free-trial-banner.jpg\",\n \"showOnCategoryPage\": false,\n \"startDate\": \"2021/8/17\"\n }\n ]\n}", "language": "200", "customLabel": "" } ], "selectedLanguageId": "Y1Vx38kZQPtiLmsufAFM_" }, "examples": { "languages": [ { "id": "3AdeysJML2Tq9WYHSdiJU", "code": "curl --location --request GET 'https://js.klevu.com/klevu-js-v1/klevu-js-api/klevu-1234567890-banner.json'", "language": "curl", "customLabel": "" } ], "selectedLanguageId": "3AdeysJML2Tq9WYHSdiJU" }, "description": "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.", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "banners", "legacyHash": "uFN0pI-f3BZCXFZPdr81Q" } ``` ::: :::ApiMethodV2 ```json { "name": "Reporting Banner Click events", "method": "GET", "url": "https://stats.ksearchnet.com/analytics/dataTracking", "description": "Utilize the following API endpoint to submit the click events for banners.", "tab": "examples", "examples": { "languages": [ { "id": "bpv9nSMp-jaFwIOZwzLSf", "language": "curl", "code": "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'", "customLabel": "" }, { "id": "THP_oY0XLPmn0q_UnK_Wn", "language": "php", "code": " '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',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n", "customLabel": "" }, { "id": "NbLdpQh5907ClqMs5B6Mz", "language": "javascript", "code": "var formdata = new FormData();\n\nvar requestOptions = {\n method: 'GET',\n body: formdata,\n redirect: 'follow'\n};\n\nfetch('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)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));", "customLabel": "" }, { "id": "Ss-golxxsBnFs9s0W39ss", "language": "nodejs", "code": "const axios = require('axios');\nconst FormData = require('form-data');\nlet data = new FormData();\n\nlet config = {\n method: 'get',\n maxBodyLength: Infinity,\n 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',\n headers: { \n ...data.getHeaders()\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n", "customLabel": "" }, { "id": "On1k3eW-fooveKEyUj9zw", "language": "java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nMediaType JSON = MediaType.parse(\"application/json; charset=utf-8\");\nRequestBody body = RequestBody.create(JSON, \"{}\");\nRequest request = new Request.Builder()\n .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\")\n .method(\"GET\", body)\n .build();\nResponse response = client.newCall(request).execute();", "customLabel": "" } ], "selectedLanguageId": "On1k3eW-fooveKEyUj9zw" }, "results": { "languages": [ { "id": "EBSiH3ekWmQpZne3ITOcF", "language": "200", "customLabel": "", "code": "\n SUCCESS\n" } ], "selectedLanguageId": "EBSiH3ekWmQpZne3ITOcF" }, "request": { "pathParameters": [], "queryParameters": [ { "name": "klevu_term", "kind": "required", "type": "string", "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.", "children": [] }, { "name": "klevu_bannerId", "kind": "required", "type": "Number", "description": "This will be bannerRef value as shown in above API call response.", "children": [] }, { "name": "klevu_image", "kind": "required", "type": "string", "description": "This is the banner image URL.", "children": [] }, { "name": "klevu_target", "kind": "required", "type": "string", "description": "This is target URL.", "children": [] }, { "name": "klevu_request", "kind": "required", "type": "string", "description": "The value of this field will be “click“.", "children": [] }, { "name": "type", "kind": "required", "type": "string", "description": "The value of this field will be “banner“.", "children": [] }, { "name": "klevu_apiKey", "kind": "required", "type": "string", "description": "This is your Klevu JS API Key.", "children": [] }, { "name": "klevu_bannerName", "kind": "optional", "type": "string", "description": "This is banner name.", "children": [] } ], "headerParameters": [], "bodyDataParameters": [], "formDataParameters": [] }, "currentNewParameter": { "label": "Query Parameter", "value": "queryParameters" }, "autoGeneratedAnchorSlug": "reporting-banner-click-events", "legacyHash": "qiLJAfwsq2_FXEZssIYIW" } ``` :::