chatbase.md

Chatbase

Learn how to use Chatbase Analytics for your Alexa Skills and Google Actions built with Jovo.

• About Chatbase
• Installation
  • Create a Chatbase Account
  • Enable Chatbase Analytics in Jovo
  • Test Chatbase

About Chatbase

Chatbase is an analytics offering for conversational products that is built by Area 120, an incubator by Google.

With Chatbase Analytics, you can measure bot metrics, analyze user behavior, and optimize the experience with transcripts and suggested intents.

Installation

To use Chatbase Analytics for your voice app, you need to complete the following steps:

1. Create a Chatbase Bot
2. Enable Chatbase Anaytics in your voice app
3. Test your app

Create a Chatbase Account

1. Create a Chatbase account or log in at https://chatbase.com/

2. Create a new bot by clicking the "add your bot" button

3. Fill in information like your bot's name, industry, and region

4. Copy API Key

Enable Chatbase Analytics in Jovo

To add Chatbase Analytics to your voice app, do the following:

• Download the npm package
• Enable the plugin in app.js
• Add configurations in config.js

First, download the npm package:

$ npm install --save jovo-analytics-chatbase

Enable the plugin like this:

// @language=javascript

// src/app.js

const { ChatbaseAlexa, ChatbaseGoogleAssistant } = require('jovo-analytics-chatbase');

app.use(
    new ChatbaseAlexa(),
    new ChatbaseGoogleAssistant()
);

// @language=typescript

// src/app.ts

import { ChatbaseAlexa, ChatbaseGoogleAssistant } from 'jovo-analytics-chatbase';

app.use(
    new ChatbaseAlexa(),
    new ChatbaseGoogleAssistant()
);

Add configurations like this:

// @language=javascript

// src/config.js

module.exports = {
    
    analytics: {
        ChatbaseAlexa: {
            key: '<key>',
            version: '<version>', // Optional
        },
        ChatbaseGoogleAssistant: {
            key: '<key>',
            version: '<version>', // Optional
        },
    },

    // ...

};

// @language=typescript

// src/config.ts

const config = {
    
    analytics: {
        ChatbaseAlexa: {
            key: '<key>',
            version: '<version>', // Optional
        },
        ChatbaseGoogleAssistant: {
            key: '<key>',
            version: '<version>', // Optional
        },
    },

    // ...

};

Test Chatbase

Test you voice app. It can take up to 6 hours until all the data can be seen in the Chatbase dashboard: