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

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 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 sending events.

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