Analytics Plugin
editAnalytics Plugin
editUse the Analytics Plugin to send analytics events to the Behavioral Analytics Product. Follow the instructions to set up the plugin.
Installation
edityarn add @elastic/search-ui-analytics-plugin ## OR npm install @elastic/search-ui-analytics-plugin
Basic Usage
editAdd 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
editIf 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
editThe Analytics Plugin accepts the following parameters:
Option | Type | Description | Default |
---|---|---|---|
|
|
The Behavioral Analytics client to use. Read more on Behavioral Analytics Tracker repo |
|
Was this helpful?
Thank you for your feedback.