algoliasearch-scala/algoliasearch/algoliasearch.analytics/TopSearchWithAnalytics

TopSearchWithAnalytics

algoliasearch.analytics.TopSearchWithAnalytics

case class TopSearchWithAnalytics(search: String, count: Int, clickThroughRate: Option[Double], averageClickPosition: Option[Double], clickPositions: Seq[ClickPositionsInner], conversionRate: Option[Double], trackedSearchCount: Int, clickCount: Int, conversionCount: Int, nbHits: Int)

Value parameters

averageClickPosition: Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with clickAnalytics set to true.
clickCount: Number of clicks associated with this search.
clickPositions: List of positions in the search results and clicks associated with this search.
clickThroughRate: Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with clickAnalytics set to true.
conversionCount: Number of conversions from this search.
conversionRate: Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with clickAnalytics set to true.
count: Number of searches.
nbHits: Number of results (hits).
search: Search query.
trackedSearchCount: Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Attributes

Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Members list

Value members

Inherited methods

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

In this article

Generated with