clickAnalytics

Type: boolean
Engine default: false
Parameter syntax
This parameter is not available in backend API clients.

The Click Analytics feature can be used with any of our front-end API clients.
Parameter syntax
This parameter is not available in backend API clients.

The Click Analytics feature can be used with any of our front-end API clients.
Parameter syntax
clickAnalytics: true|false
Parameter syntax
This parameter is not available in backend API clients.

The Click Analytics feature can be used with any of our front-end API clients.
Parameter syntax
Not available yet.
Parameter syntax
Not available yet.
Parameter syntax
This parameter is not available in backend API clients.

The Click Analytics feature can be used with any of our front-end API clients.
Parameter syntax
This parameter is not available in backend API clients.

The Click Analytics feature can be used with any of our front-end API clients.
Parameter syntax
This parameter is not available in backend API clients.

The Click Analytics feature can be used with any of our front-end API clients.
Parameter syntax
This parameter is not available in backend API clients.

The Click Analytics feature can be used with any of our front-end API clients.

Can be used in these methods:
search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues searchAsync, browseAsync, searchForFacetValues Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

About this parameter

Enable the Click Analytics feature.

The effect of setting clickAnalytics to true is to add a queryID to the search response. As explained here, this queryID can subsequently be used in click and conversion analytics.


Usage notes:
  • This parameter does not, on its own, add any new analytics data; it only ensures that a queryID is returned. 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.

  • What you can do with Analytics depends on your plan.

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