A quick start guide to get you up and embedding nebuly’s platform main pages directly into your platform.

Step 1: Get a Nebuly API Key

To authenticate on the nebuly platform thorough the exposed API you will need an API key.

Api keys are uniquely mapped to projects. If you are considering to show different data to each of your users (or user groups), we suggest to create a project per user (or user group) and assign a different API key to each of them.

You can create an API key directly from the nebuly platform:

  • Head to ⚙️ settings and navigate to “project settings”;
  • Create a new project (if you don’t have one already) and give it a name (e.g. Internal chatbot);
  • Copy the nebuly default_key that has been assigned to the project.

Now you can start using the exposed API and embed the main analytics information.

Step 2: Embed the pages you are interested in

Overview

You simply need to call the /overview endpoint

User Intelligence

To embed the user intelligence page you’ll need to connect to the following endpoints:

  • Get intent Topics: you will get the list of topics in which the intents have been clustered. You may use a topic to filter the data of the following endpoint.
  • Get intents Overview: you will get the list of the detailed intents relative to your project, optionally filtered by topic.
  • Get intent details: this endpoint provides detailed analytics related to a specified intent.
  • Get intent user queries: this endpoint provides the list of user queries related to a specified intent.
  • Get intent users: this endpoint provides the list of users related to a specified intent.

User Warnings

Warnings pages contain two main sections: one for the overview of the warnings and one for the details of the single warning category.

In order to retrieve the aggregate data about a warning category, see here. Categories are clustered in the following have, each one with its own data:

  • Rage signals Shows the list of intents that are related to rage signals. Each intent contains the list of signals(warnings) that have been detected. To retrieve the list of intents see here. To retrieve the list of the warnings related to an intent see here.
  • Lack or personalization Shows a list of subcategories related to this category and the list of warnings related by subcategory. To retrieve the list of the the subcategories see here. To retrieve the list of the warnings related to a subcategory see here.
  • Wrong information Shows a list of subcategories, a list of subjects related to each subcategory and the list of warnings related by subject. To retrieve the list of the the subcategories see here. To retrieve the list of the subjects related to a subcategory see here. To retrieve the list of the warnings related to a subject see here.
  • Limited capabilities Shows a list of subcategories related to this category and the list of warnings related by subcategory. To retrieve the list of the the subcategories see here. To retrieve the list of the warnings related to a subcategory see here.

Engagement

To get the information about the user engagement you can use the /engagement endpoint