New

The executive guide to generative AI

Read more

Analytics Plugin

edit

Analytics Plugin

edit

Use the Analytics Plugin to send analytics events to the Behavioral Analytics Product. Follow the instructions to set up the plugin.

Installation

edit
yarn add @elastic/search-ui-analytics-plugin
## OR
npm install @elastic/search-ui-analytics-plugin

Basic Usage

edit

Add the Analytics Plugin to your Search UI configuration like so:

import AnalyticsPlugin from "@elastic/search-ui-analytics-plugin";

// search ui configuration
const config = {
  apiConnector: connector,
  searchQuery: { ... },
  plugins: [ AnalyticsPlugin() ]
}

By default, the Analytics Plugin will use the Behavioral Analytics client provided when using script tag integration.

Passing in a custom analytics client

edit

If you integrated Behavioral Analytics using the @elastic/behavioral-analytics-javascript-tracker NPM package, you can pass in a custom analytics client to the Analytics Plugin.

import AnalyticsPlugin from "@elastic/search-ui-analytics-plugin";
import { createTracker, getTracker } from "@elastic/behavioral-analytics-javascript-tracker";

createTracker({
  // the DSN can be found in the Behavioral Analytics Collections view page
    dsn: "https://my-analytics-dsn.elastic.co"
})

// search ui configuration
const config = {
  apiConnector: connector,
  searchQuery: { ... },
  plugins: [
    AnalyticsPlugin({
      client: getTracker()
    })
  ]
}

Options

edit

The Analytics Plugin accepts the following parameters:

Option Type Description Default

client

AnalyticsTracker

The Behavioral Analytics client to use. Read more on Behavioral Analytics Tracker repo

window.elasticAnalytics

Was this helpful?
Feedback