Skip to main content
GET
/
2
/
clicks
/
clickThroughRate
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'
{
  "rate": 0.49,
  "clickCount": 162,
  "trackedSearchCount": 2,
  "dates": [
    {
      "rate": 0.49,
      "clickCount": 162,
      "trackedSearchCount": 2,
      "date": "2023-06-14"
    }
  ]
}
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

OK

​
rate
number | 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

​
clickCount
integer
default:0
required

Number of clicks associated with this search.

Required range: x >= 0
Example:

162

​
trackedSearchCount
integer
default:0
required

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

Example:

2

​
dates
dailyClickThroughRates · object[]
required

Daily click-through rates.

⌘I