Skip to content

docs(specs): describe the analytics no click rate per query - #7225

Merged
Fluf22 merged 1 commit into
mainfrom
docs/analytics-no-click-rate-per-query
Nov 6, 2026
Merged

Fluf22 merged 1 commit into
mainfrom
docs/analytics-no-click-rate-per-query

Conversation

@leonardogavaudan

Copy link
Copy Markdown
Contributor

🧭 What and Why

🎟 JIRA Ticket: none

  • The API reference describes /2/searches/noClickRate as "the fraction of searches that didn't lead to any click", with the rate calculated as "tracked searches without clicks divided by the number of tracked searches".
  • The endpoint has always counted per query: a search counts as a search without clicks only when no search for the same query got a click in the time range, over tracked searches with results. The metrics guide and the support articles (1, 2, 3) describe it that way.
  • Example: "lego" has 100 tracked searches with results and one of them got a click; "lgeo" has 5 with no click. The endpoint returns 5 of 105 (5%), while the current description suggests 104 of 105 (99%).

Changes included:

  • getNoClickRate description: counts per query, only tracked searches with results, and why the rate for a whole range is usually lower than the daily rates.
  • noClickRate and noClickCount descriptions: the same definition. Both are only used by this endpoint.
  • No schema change.

πŸ§ͺ Test

  • yarn eslint specs/analytics/common/parameters.yml specs/analytics/paths/search/getNoClickRate.yml: no errors.
  • The wording matches the endpoint's code (handler_no_click_rate.go in algolia/go) and a real response: WALL-E's products, 2026/10/04 to 11/03, rate 0.0840 = noClickCount 3,954 / count 47,045.

@algolia-api-clients-automation-bot

algolia-api-clients-automation-bot Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

βœ”οΈ Code generated!

Name Link
πŸͺ“ Triggered by fb9e749df7954af20355b8b3e38bc2373380ce52
πŸƒ Generated commit 661929eac95c0365355115f912511cda3e887786
🌲 Generated branch generated/docs/analytics-no-click-rate-per-query
πŸ“Š Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
go 3205
csharp 2610
javascript 2361
php 1610
ruby 1517
python 1282
java 1079
scala 805
swift 374

/2/searches/noClickRate counts a search as a search without clicks only when no search for its query got a click in the time range, over tracked searches with results. The descriptions said it counts each search, which doesn't match the endpoint, the metrics guide or the support articles.
@leonardogavaudan
leonardogavaudan force-pushed the docs/analytics-no-click-rate-per-query branch from 9942773 to 5013d46 Compare November 6, 2026 12:56
@leonardogavaudan
leonardogavaudan marked this pull request as ready for review November 6, 2026 13:17
@leonardogavaudan
leonardogavaudan requested a review from a team as a code owner November 6, 2026 13:17
@Fluf22
Fluf22 merged commit 3e85edd into main Nov 6, 2026
@Fluf22
Fluf22 deleted the docs/analytics-no-click-rate-per-query branch November 6, 2026 13:19
algolia-api-clients-automation-bot Bot added a commit that referenced this pull request Nov 6, 2026
…generated) [skip ci]

Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Nov 6, 2026
algolia/api-clients-automation#7225

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants