Add your own analytics
Use our callback function to log events from the search and chat widgets to your own analytics tool.
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.event_name === 'chat_message_bot_response_received') {
const { question, response_message } = event.common_properties;
// Log to your own analytics tool or CDP.
console.log('Question: ', question);
console.log('Response: ', response_message.content);
}
};
export customAnalyticsCallback;
Available events
Accessible via the event_name property on the InkeepCallbackEvent type.
| Event name | Description |
|---|---|
| chat_message_submitted | User submits a chat message |
| chat_message_bot_response_received | Bot response to user message is received |
| search_query_submitted | search query is submitted |
| search_query_response_received | Response to search query is received |
| chat_thumbs_up_feedback_submitted | User submits thumbs up feedback |
| chat_thumbs_down_feedback_submitted | User submits thumbs down feedback |
| chat_history_cleared | Chat history is cleared |
| chat_share_button_clicked | Share button is clicked |
| chat_message_copied | Chat message is copied |
| chat_code_block_copied | code block in chat is copied |
Common properties
The below are shared by all events.
| Property name | Description |
|---|---|
| organization_id | Organization ID |
| integration_id | Integration ID |
| widget_library_version | Widget library version |
| interaction_type | Type of interaction. Value can be one of 'EMBEDDED_CHAT' | 'CHAT_BUTTON' | 'CUSTOM_TRIGGER' | 'SEARCH_BAR'. |
| product | Product associated with interaction, if provided to the React component. |
User props
If provided to the React component, the below user properties are available.
| Property name | Description |
|---|---|
| user_identification_type | How user is identified. Can be of values 'ANONYMOUS' | 'COOKIED' | 'ID_PROVIDED' depending on analytics configuration. |
| user_cohorts | User cohorts |
| user_email | User email |
Chat properties
The below are shared by all chat events.
| Property name | Description |
|---|---|
| chat_mode_currently_selected | Currently selected chat mode |
| chat_session_id | ID of shared chat session |