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
import { algoliasearch } from 'algoliasearch';

// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initAnalytics({ region: 'us' });

const response = await client.getClickPositions({ index: 'index' });
Did you find this page helpful?