Analytics data¶
Description¶
Within a Code Node you can modify certain parts of the analytics data to get more control of what exactly is written to analytics.
You can access the analytics data in a code node by using the key analyticsdata. For example:
analyticsdata.intent = "test";
Analytics fields¶
The following fields can be overwritten in a Code Node:
| Field | Description | Type |
|---|---|---|
| intent | The intent that will be written to analytics. You can for instance modify this field to store the intent that was found in an executed Flow in analytics | String |
| intentFlow | The ID of the Flow where the intent was found (main flow or attached flow) | String |
| intentScore | The score of the intent that was found | Number |
| inputText | The input text. | String |
| inputData | The input data object. | {"key":"value"} |
| state | The State the Flow is currently in | String |
| slots | The slots that were found in the user's input | Object |
| completedGoals | A list of goals the user has completed | List of Strings |
| understood | Whether the input was understood. An input is counted as understood if an Intent or a Slot is found, the input is marked as understood via the Code Node or Overwrite Analytics Node, or the type of sentence is pAnswer, nAnswer, or Greeting (if Confirmation Word logic is activated). In all other cases, it is marked as not understood, except if there is an active handover (without activation of an agent Assist Flow) or a message has been marked as Don't count or Null. |
Boolean |
| custom1 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom2 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom3 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom4 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom5 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom6 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom7 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom8 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom9 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
| custom10 | A custom field that can be set to any string value during Flow execution. Defaults to null | String |
Working with the custom fields¶
The custom fields are used to store any custom data into analytics. This can be any string value that has a maximum length of 512 characters. If you want to store more complex data, you can store a string field object as the value:
const customData = {
key: "value"
};
analyticsdata.custom1 = "userFocusGroup: focusGroup1";
analyticsdata.custom2 = JSON.stringify(customData);
Max length of custom fields
You can store a maximum of 512 characters as the value for each custom field.
Analytics data life span¶
The analyticsdata object is generated for each Flow Execution. This means that any data you store in the analyticsdata object (for example, a custom field) will only be stored in analytics for this Flow Execution. On the next Flow Execution, there will be a new analyticsdata object with a new intent etc.