Using Orbita Insights, you can monitor and visualize not only the pre-built data but also the custom properties that you created in the Experience Designer.

This document briefs you on how to create walks you through creating custom properties and use using them to visualize in Insights.

Data Collection

As a Voice Experience Developer you can extend the scheme fields under the an admin user, you can define your own property to capture customized data. You can have your own unique names for the property names msg.analytics.attributes.{uniqueKeyNames}.

While creating the properties, it is recommended to have structured data with 3 top-level property key names.

...

In the below example, we have passed a string, integer, boolean, object data_types within the msg.analytics.attributes property.

Place this code in the function node in Experience Designer.

var _ = global.get('lodash');
var  tv_series=  ['Bones', 'Psych', 'Big Bang Theory', 'Mad Men', 'Breaking Bad', 'Modern Family', 'Game of Thrones', 'Dexter'];

rndnum = Math.floor(Math.random() * 8);

node.warn(tv_series)
node.warn(rndnum)

msg.analytics.attributes = {
    'str': `this is a string`, 
    'const': 2,
    'bool': true,
    'mycontextData': {
        // 'name': `name_${_.sample(tv_series)}`,
        'series_name': tv_series[rndnum],
        'value': `value__${_.sample(tv_series)}`
    },
};
return msg;

for For every agent type(flow, answer), there will be a separate schema. for every agent type(flow, answer), 3 properties are available. The properties id, name, contextData .Context data will have more are available for each agent type by default. The contextData object contains other properties such as state, faq, and so on.

To address the backward compatibility, some of the data is duplicated.

These new fields are not visible in the visualization.

To get the new fields, you have to click on the Refresh button.

When a new field is added, the insights author should refresh the shcema.

Under context data, the fields are not supposed to change. If they want to change anything here, send a mail to support@orbita.ai

Attributes

Name space key is introduced so that the admin user can have their own data.

You can have your own unique names for the property names. msg.analytics.attributes.{uniqueKeyNames}

Admin should make sure that there are no conflicts with the names in the other projects.

We recommend 3 top level keys l be well structured data

going forward, we will reserve the top level name space keys for easier access.

It is recommended to have 5 branches at the maximum.

Indexed data will be kept only for 3 months. rest will be archived.

The data type values should not be different. When the same field name is used, it will work as if it has the same data type.

Data types

String (recommended), integer, boolean.

Donot use arrays

Engage Dashboard enable by default.

In insights, voiceagent.response.platformAgent.<agent_type>.contextData.<custom_field>

...

It is recommended not to change the data type of the property if the same property has to be used. When using the same property name it will take the same data type assigned earlier. For example, in the above sample code if you want to assign an integer data type to the msg.analytics.attributes.str property.

Data types you can use are String (recommended), integer, boolean, and objects.

Data Visualization

For insights to capture the new properties,

1. Go to Management

2. Index Pattern

3. Search for and select Voice-agent-<domain>-backend.

4. Click on the Refresh Icon.

...

The Indexed data will be available only for 3 months, if not in use, and will be archived after 3 months.

The data from the above example code will be available at express.voiceAnalytics.voiceAgent.attributes.<custom_key>

Using these fields, you can create your visualization.

For example, to create a new visualization for the above sample code,

1. Go to Visualization

2. Click on Create new Visualization

3. Add a bucket and select the X-axis.

   Image Added

4. Select the following
   Aggregation - Terms
   field - express.voiceAnalytics.voiceAgent.attributes.mycontextData.series_name
   Click on the play button.

   Image Added

5. You will find the visualization of data on the right.

   Image Added

Save the visualization if you like it or fiddle with the many options here to get the required visualization.

Related articles