Retrieve conversion rate

Retrieves the conversion rate (CR) for all your searches with at least one conversion 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 CR when clickAnalytics is enabled:

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

Usage

1
2
3
4
5
6
import { algoliasearch } from 'algoliasearch';

// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initAnalytics({ region: 'us' });

const response = await client.getConversionRate({ index: 'index' });