@algolia/client-insights

What is @algolia/client-insights?

@algolia/client-insights is an npm package that allows developers to send events to Algolia's Insights API. This is useful for tracking user interactions with search results, which can then be used to improve search relevance and user experience.

What are @algolia/client-insights's main functionalities?

Initialize the Insights Client

This feature allows you to initialize the Insights client with your Algolia application ID and API key. This is the first step in using the client to send events.

const { createInsightsClient } = require('@algolia/client-insights');
const insightsClient = createInsightsClient({
  appId: 'YourApplicationID',
  apiKey: 'YourSearchOnlyAPIKey'
});

Send Click Event

This feature allows you to send a click event to the Algolia Insights API. You specify the event type, name, index, user token, and object IDs that were clicked.

insightsClient.sendEvent({
  eventType: 'click',
  eventName: 'Product Clicked',
  index: 'your_index_name',
  userToken: 'user-123',
  objectIDs: ['objectID1']
});

Send Conversion Event

This feature allows you to send a conversion event, such as a purchase, to the Algolia Insights API. Similar to click events, you specify the event type, name, index, user token, and object IDs involved in the conversion.

insightsClient.sendEvent({
  eventType: 'conversion',
  eventName: 'Product Purchased',
  index: 'your_index_name',
  userToken: 'user-123',
  objectIDs: ['objectID1']
});

Send View Event

This feature allows you to send a view event to the Algolia Insights API. This is useful for tracking when a user views a product or item in your application.

insightsClient.sendEvent({
  eventType: 'view',
  eventName: 'Product Viewed',
  index: 'your_index_name',
  userToken: 'user-123',
  objectIDs: ['objectID1']
});

Other packages similar to @algolia/client-insights

segment

Segment is a customer data platform that collects, cleans, and controls customer data. It offers similar functionality to @algolia/client-insights in terms of tracking user interactions and sending events, but it is more comprehensive, supporting a wide range of integrations and data sources.

mixpanel

Mixpanel is an analytics platform that helps businesses understand how users interact with their products. Like @algolia/client-insights, it allows for event tracking, but it also provides advanced analytics and reporting features.

README

The README file is missing

Changelog

5.0.0-alpha.8

• 4c1596df fix(clients): list available regions when region is missing (#916) by @shortcuts
• be45fc4e fix(specs): make batch body parameters required (#917) by @shortcuts
• 27b78d93 fix(javascript): build (#867) by @shortcuts