Retrieve click positions

Retrieves the positions in the search results and their associated number of clicks.

This lets you check how many clicks the first, second, or tenth search results receive.

An average of 0 when clickAnalytics is enabled means Algolia didn’t receive any click events for the queries.

Usage

Required ACL: analytics
1
2
3
4
5
6
7
8
9
10
11
12
import algoliasearch.api.AnalyticsClient
import algoliasearch.config.*

val client = AnalyticsClient(
  appId = "ALGOLIA_APPLICATION_ID",
  apiKey = "ALGOLIA_API_KEY",
  region = Option("ALGOLIA_APPLICATION_REGION")
)

val response = client.getClickPositions(
  index = "index"
)
Did you find this page helpful?