API Reference / API Parameters / clickAnalytics

Jan. 14, 2021

clickAnalytics

Type: boolean

Engine default: false

Parameter syntax

'clickAnalytics' => true|false

clickAnalytics: true|false

clickAnalytics: true|false

'clickAnalytics': True|False

clickAnalytics = true|false

clickAnalytics: Boolean = true|false

.setClickAnalytics(true|false)

ClickAnalytics = true|false

.setClickAnalytics(true|false)

opt.ClickAnalytics(true|false)

This parameter is not available in the Scala client.

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

See code examples

About this parameter

Enable the Click Analytics feature.

The effect of setting clickAnalytics to true is to add a queryID to the search response. This queryID can 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. Learn more in the guide on implementing analytics.

Examples

Disable click analytics for the current search

Copy

1
2
3
$res = $index->search('query', [
  'clickAnalytics' => false
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.clickAnalytics, to: false)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Enable click analytics for the current search

Copy

1
2
3
$res = $index->search('query', [
  'clickAnalytics' => true
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.clickAnalytics, to: true)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

clickAnalytics

About this parameter

Usage notes:

Examples

Disable click analytics for the current search

Enable click analytics for the current search

Did you find this page helpful?

On this page