Retrieve click positions

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

GET /2/clicks/positions

curl

cURL

curl --request GET \
  --url 'https://analytics.us.algolia.com/2/clicks/positions?index=ALGOLIA_INDEX_NAME&startDate=2022-09-19&endDate=2023-01-21&tags=device%3Amobile%2520phone' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "positions": [
    {
      "position": [
        21,
        -1
      ],
      "clickCount": 24
    }
  ]
}

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.

Required ACL: analytics

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

index · string · required

Index name.

Example:

"ALGOLIA_INDEX_NAME"

startDate · string

Start date of the period to analyze, in YYYY-MM-DD format.

Example:

"2022-09-19"

endDate · string

End date of the period to analyze, in YYYY-MM-DD format.

Example:

"2023-01-21"

tags · string

Tags by which to segment the analytics.

You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.

Response

200

application/json

OK

positions · clickPosition · object[] · required

List of positions in the search results and clicks associated with this search.

Required array length: 12 elements

Show child attributes