Retrieve click-through rate

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

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.

Usage

1
2
3
4
5
6
7
use Algolia\AlgoliaSearch\Api\AnalyticsClient;

$client = AnalyticsClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');

$response = $client->getClickThroughRate(
    'index',
);