Insights API client

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

1
gem install algolia

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

1
require "algolia"

To create an instance of the client:

1
client = Algolia::InsightsClient.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 Insights API.

Events

User tokens