Analytics Logs

Top Clicked or Viewed data is stored in Elasticsearch under the index name idx9998. This index will appear in the list shown at:https://localhost:9200/_cat/indices.

Starting from version 9.2, there is an additional index called click, which stores individual URLs and their corresponding click counts.

• The data in the index can be accessed here:
  https://localhost:9200/idx9998/_search?pretty=true
  https://localhost:9200/click/_search?pretty=true

❗️

Important Note:

• Only documents or URLs clicked from Faceted Search are stored in the Top Clicked index.
• This does not apply to clicks from regular search results.

Viewing Top Viewed/Clicked Results in Kibana

• The Top Clicked Results are saved in a separate Elasticsearch index called idx9998 in SearchBlox.
• You can use Kibana to view the Top Clicked Results, search through them, and create reports based on this data.
• In Kibana, you must add the index name idx9998 to access the Top Clicked Results.
• If you also want to add the click index, you can include that index name by following the same steps.

• Top Clicked results can be viewed and searched after adding index idx9998 in Kibana.

📘

To get to know more about Kibana in SearchBlox please check the following link:
Kibana Visualizations and Explore

Top Clicked Data Analysis

API to Increment Click Count from Search

• SearchBlox uses the following API URL with ReportServlet to increase the click count.
• When a click happens, the click count is updated in the indexed document, and also in the click log index named idx9998.
• From version 9.2 and above, SearchBlox also updates the click information in another index called click.

https://localhost:8443/searchblox/servlet/ReportServlet?addclick=yes&col=10&query=test&title=title&uid=11b77586c75556e161a6a71a451d6744&url=https://www.searchblox.com

Integration of the Search Click Count API in Faceted Search

We use Axios to call these APIs insideplugin\src\sb\Common\SbCore.js
We are sharing the sample code so you can use a similar approach for your own custom search implementation.

export const getDocumentClickCount = (parameters) => {
  let urlParameters = Object.assign({}, qs.parse(window.location.search));
  if(Object.keys(parameters).length !== 0){
    parameters.query = urlParameters.query;
    // console.log(parameters,"params")
    return axios.get(defaults.pluginDomain + "/searchblox/servlet/ReportServlet?addclick=yes&col="+parameters.col+"&query="+parameters.query+"&title="+parameters.title+"&uid="+parameters.uid+"&url="+parameters.url)
    .then((response)=>{
      return response;
    })
    .catch((error)=>{
      return error;
    });
  }
};

API for Capturing AutoSuggest Click Count

• SearchBlox uses the following API URL in the ReportServlet to update the autosuggest click count:
  https://localhost:8443/searchblox/servlet/ReportServlet?addsuggest=yes&query=test&suggestion=test
• If you need to include the collection number, you can add it using the col parameter, like this: https://localhost:8443/searchblox/servlet/ReportServlet?addsuggest=yes&query=test&suggestion=test&col=1

Integration of the Autosuggest click API in Faceted Search

We use Axios to call these APIs inside the fileplugin\src\sb\Common\SbCore.js
We are sharing the sample code so you can use a similar method for your own custom search setup.

export const getSuggestClickCount = (parameters) => {
  let urlParameters = Object.assign({}, qs.parse(window.location.search));
  if(Object.keys(parameters).length !== 0){
    if(urlParameters.query === undefined) {
      parameters.query = parameters.suggest;
    }
    else {
      parameters.query = urlParameters.query;
    }
    if(parameters.query.indexOf('"') >= 0) {
      parameters.query = parameters.query.replace(/['"]+/g, '');
    }
    let colArray = [];
    let colString = "";
    if(defaults.defaultCollections.length > 0){
      colArray = defaults.defaultCollections.slice();
    }
    else if(urlParameters.col && urlParameters.col.constructor === Array) {
      colArray = urlParameters.col.slice();
    }
    else if(urlParameters.col && urlParameters.col.constructor === String) {
      colArray.push(urlParameters.col);
    }
    if(colArray !== null && colArray !== undefined && colArray !== "" && colArray.length > 0) {
      colArray.map((value,key) => {
        colString = colString + "&col=" + value;
      });
    }
    return axios.get(defaults.pluginDomain + "/searchblox/servlet/ReportServlet?addsuggest=yes&query="+parameters.query+"&suggestion="+parameters.suggest+colString)
    .then((response)=>{
      return response;
    })
    .catch((error)=>{
      return error;
    });
  }
};

Deleting or Clearing Data for Top Clicked Documents

Data in the Top Clicked index, which is idx9998, is stored in the Elasticsearch index. You can delete this data from Kibana by using Dev Tools and sending a delete request to Elasticsearch.

• Go to Kibana and access Dev Tools

• Give the following POST request to clear all the data from topclicked index idx9998

POST idx9998/_delete_by_query
{
  "query": {
    "match_all": {}
  }
}

• If you want to remove entries from the click index instead, replace idx9998 with click:

POST click/_delete_by_query
{
  "query": {
    "match_all": {}
  }
}

• If you want to delete data based on a date range, you can send a POST request that includes the date range filter.

POST idx9998/_delete_by_query
{
 "query": {
 "range" : {
 "created" : {
 "gte" : "2020-01-01T00:00:00",
 "lt" : "2020-06-12T00:00:00"
 }
 }
 }
}

The response would be: