Merge pull request #25 from AddSearch/parameter-for-hierarchical-facets

add parameter for hierarchical facets + README.md for analytics tagging

Author: haoAddsearch

README.md

@@ -298,6 +298,16 @@ as every keystroke would fire a statistics event
 client.setCollectAnalytics(false);
 ```
 
+#### Set a tag for analytics events
+Defines a tag associated with all analytics events reported by the client. 
+These tags will be available as filters in the AddSearch Analytics Dashboard. 
+You can use tags, for instance, in A/B testing to compare which search UIs are most effective. 
+Splitting the analytics with tags may also provide insights to the behaviour of audiences on different websites.
+```js
+// Specify a tag for analytics events (the maximum length is 50 characters)
+client.setAnalyticsTag('Navigation search');
+```
+
 ### Personalization
 
 #### Set user token (for personalized search results)

src/apifetch.js

@@ -83,7 +83,8 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
         settingToQueryParam(settings.numFacets, 'numFacets') +
         settingToQueryParam(settings.cacheResponseTime, 'cacheResponseWithTtlSeconds') +
         settingToQueryParam(settings.searchOperator, 'defaultOperator') +
-        settingToQueryParam(settings.analyticsTag, 'analyticsTag');
+        settingToQueryParam(settings.analyticsTag, 'analyticsTag') +
+        settingToQueryParam(settings.hierarchicalFacetSetting, 'hierarchicalFacets');
 
       // Add custom field filters
       if (settings.customFieldFilters) {

src/index.js

@@ -154,6 +154,7 @@ var client = function(sitekey, privatekey) {
   this.setSuggestionsSize = function(size) { this.settings.setSuggestionsSize(size); }
   this.setAutocompleteSize = function(size) { this.settings.setAutocompleteSize(size); }
   this.addFacetField = function(fieldName) { this.settings.addFacetField(fieldName); }
+  this.addHierarchicalFacetSetting = function(setting) { this.settings.addHierarchicalFacetSetting(setting); }
   this.addRangeFacet = function(field, ranges) { this.settings.addRangeFacet(field, ranges); }
   this.addStatsField = function(field) { this.settings.addStatsField(field); }
   this.setNumberOfFacets = function(numFacets) { this.settings.setNumberOfFacets(numFacets); }

src/settings.js

@@ -164,6 +164,10 @@ var settings = function() {
     }
   }
 
+  this.addHierarchicalFacetSetting = function(setting) {
+    this.settings.hierarchicalFacetSetting = JSON.stringify(setting);
+  }
+
   this.addRangeFacet = function(field, ranges) {
     if (!this.settings.rangeFacets) {
       this.settings.rangeFacets = [];