Add your own analytics

​

Scenario

To understand how usage of the Inkeep search or chat affects your business, you may want to log events from the search and chat widgets to your own analytics tool. This could be Mixpanel, Posthog, Amplitude, Segment or other analytics or CDP tools.

We expose all the events that we log to our own analytics suite through a callback function called logEventCallback that can be configured in the baseSettings configuration.

Below is an example of how to use logEventCallback to log events related to the chat_message_bot_response_received event to your analytics tool. You can check out the full reference of events by inspecting the InkeepCallbackEvent type in the npm package.

We recommend you only log the events and properties on the events that you find relevant.

​

Example

// customAnalyticsCallback.ts
import { InkeepCallbackEvent } from '@inkeep/uikit';

const customAnalyticsCallback = (event: InkeepCallbackEvent): void => {
  // Check if the event type is 'chat_message_bot_response_received'
  if (event.eventName === 'chat_message_bot_response_received') {
    const { question, responseMessage } = event.properties;

    // Log to your own analytics tool or CDP.
    console.log('Question: ', question);
    console.log('Response: ', responseMessage.content);
  }
};

export customAnalyticsCallback;

​

Available events

Accessible via the eventName property on the InkeepCallbackEvent type.

​

Common properties

The below are shared by all events.

​

User props

If provided to the React component, the below user properties are available.

​

Chat properties

The below are shared by all chat events.