Retrieve click-through rate

Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown.

GET /2/clicks/clickThroughRate

curl

cURL

curl --request GET \
  --url 'https://analytics.us.algolia.com/2/clicks/clickThroughRate?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

{
  "clickCount": 162,
  "dates": [
    {
      "clickCount": 162,
      "date": "2023-06-14",
      "rate": 0.49,
      "trackedSearchCount": 2
    }
  ],
  "rate": 0.49,
  "trackedSearchCount": 2
}

By default, the analyzed period includes the last eight days including the current day.

There’s a difference between a 0 and null CTR when clickAnalytics is enabled:

• Null means there were no queries: since Algolia didn’t receive any events, CTR is null.
• 0 mean there were queries but no click events were received.

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"

endDate · string

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

Example:

"2023-01-21"

startDate · string

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

Example:

"2022-09-19"

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

clickCount · integer · default: 0 · required

Number of clicks associated with this search.

Required range: x >= 0

Example:

162

dates · dailyClickThroughRates · object[] · required

Daily click-through rates.

Show child attributes

rate · number<double> | null · required

Click-through rate: calculated as the 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.

Required range: 0 <= x <= 1

Example:

0.49

trackedSearchCount · integer · default: 0 · required

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Example:

2