Retrieve top searches

Returns the most popular searches. For each search, it also includes the average number of hits.

Required ACL: analytics

If you set the clickAnalytics query parameter to true, the response also includes:

• Tracked searches count Tracked searches are Search API requests with clickAnalytics set to true. This differs from the response’s count, which includes searches where clickAnalytics is false.
• Click count
• Click-through rate (CTR)
• Conversion count
• Conversion rate (CR)
• Average click position

If you set the revenueAnalytics query parameter to true, the response also includes:

• Add-to-cart count
• Add-to-cart rate (ATCR)
• Purchase count
• Purchase rate
• Revenue details for each currency

There’s a difference between 0% rates and null rates:

• Null means there were no queries. Algolia didn’t receive any events, so rates are null.
• 0% rates mean there were queries but no click or conversion events were received.

Usage

C#

// Initialize the client
var client = new AnalyticsClient(
  new AnalyticsConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);

// Call the API
var response = await client.GetTopSearchesAsync("index");

// print the response
Console.WriteLine(response);

See the full API reference

For more details about input parameters and response fields.