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

Add a query ID parameter to the response for tracking click and conversion events.

If true, the search response contains a queryID parameter, which uniquely identifies a search query. This queryID is required for all events related to a search.

Usage notes

Setting clickAnalytics to true doesn’t add any new analytics data. It only ensures that the queryID is generated and added to the search response. You have to pass this queryID when sending search-related events to the Insights API with the clickedObjectIdsAfterSearch or convertedObjectIdsAfterSearch methods. Calculating metrics, such as Click Rate and Conversion Rate, for Analytics and A/B Testing requires this setting.

For more information about sending events, see Getting Started with events.

Examples

Turn off 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)")
  }
}

Turn on click analytics for the current search