clickAnalytics

scope search
type boolean
default true
description

Enables click tracking.

The effect of setting clickAnalytics to true is to add a Query ID to the search response. This Query ID can then be used later in click and conversion analytics.

This parameter does not, on its own, add any new analytics data; it only makes it possible to move to the next step, by sending back a queryID. With that queryID, it will be up to you then to choose the best events to send as clicks and conversions. See Analytics Implementation Overview.

Examples

index.search({
  query: 'query',
  clickAnalytics: false
}).then(res => {
  // console.log(res);
});
index.search({
  query: 'query',
  clickAnalytics: true
}).then(res => {
  // console.log(res);
});
Php small white
PHP
Ruby small white
Ruby
Javascript small white
JavaScript
Python small white
Python
Swift small white
iOS
Android small white
Android
Csharp small white
C#
Java small white
Java
Go small white
Go
Scala small white
Scala
Php small white
PHP
Ruby small white
Ruby
Javascript small white
JavaScript
Python small white
Python
Swift small white
iOS
Android small white
Android
Csharp small white
C#
Java small white
Java
Go small white
Go
Scala small white
Scala