GET /2/clicks/averageClickPosition

Retrieves the average click position of your search results, including a daily breakdown.

The average click position is the average of all clicked search result positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day.

An average of null when clickAnalytics is enabled means Algolia didn't receive any click events for the queries. The average is null until Algolia receives at least one click event.

Servers

Query parameters

Name Type Required Description
endDate String No

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

tags String No

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.

startDate String No

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

index String Yes

Index name.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.