Retrieve no click rate

Retrieves the fraction of searches that didn’t lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks.

GET /2/searches/noClickRate

curl

cURL

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

{
  "count": 2,
  "dates": [
    {
      "count": 2,
      "date": "2023-06-14",
      "noClickCount": 15,
      "rate": 0.15
    }
  ],
  "noClickCount": 15,
  "rate": 0.15
}

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

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

count · integer · default: 0 · required

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

Example:

2

dates · dailyNoClickRates · object[] · required

Daily no click rates.

Show child attributes

noClickCount · integer · required

Number of times this search was returned as a result without any click.

Required range: x >= 1

Example:

15

rate · number<double> · required

No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.

Required range: 0 <= x <= 1

Example:

0.15