Skip to main content
  • Type: boolean
  • Default: false
  • Scope: search
The clickAnalytics parameter determines, if the response includes a queryID parameter for linking click and conversion events to searches. This query ID is required for all events related to a search. For more information about sending events, see Get started with events.

​
Usage

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.

​
Example

Current API clients

var response = await client.SearchSingleIndexAsync<Hit>(
  "ALGOLIA_INDEX_NAME",
  new SearchParams(new SearchParamsObject { ClickAnalytics = true })
);

index.Search(
  new Query("query") {
    ClickAnalytics = true
  }
);