API clients / Ruby

Analytics API client

This client is new in v3 of the Ruby API clients.

The Analytics API client is part of the algolia gem. To install this gem, run:

Copy 
1

gem install algolia

To use the Analytics client, add this import to your files:

Copy 
1

require "algolia"

To create an instance of the client:

Copy 
1

client = Algolia::AnalyticsClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

List of methods

Each method makes one request to the Analytics API.

Searches

client.get_top_searches Retrieve top searches
client.get_searches_count Retrieve number of searches
client.get_searches_no_results Retrieve the most frequent searches without results
client.get_no_results_rate Retrieve no results rate
client.get_top_hits Retrieve top search results

Clicks

client.get_searches_no_clicks Retrieve top searches without clicks
client.get_no_click_rate Retrieve no click rate
client.get_average_click_position Retrieve average click position
client.get_click_positions Retrieve click positions
client.get_click_through_rate Retrieve click-through rate
client.get_conversion_rate Retrieve conversion rate
client.get_add_to_cart_rate Retrieve add-to-cart rate
client.get_purchase_rate Retrieve purchase rate

Users

client.get_users_count Retrieve number of users
client.get_top_countries Retrieve top countries

Filters

client.get_top_filter_attributes Retrieve top filters
client.get_top_filter_for_attribute Retrieve top filter values
client.get_top_filters_no_results Retrieve top filters for a search without results

Revenue

client.get_revenue Retrieve revenue data

Status

client.get_status Retrieve update status
Did you find this page helpful?