There are only 3 required fields when passing data into Dimension, but being aware of all the possible fields and how to format them are equally important when it comes to configuring your unstructured data to be passed into Dimension.

The main requirements are User ID, Message, and a timestamp. However, there are several pieces of Metadata that you are already collecting that may be useful for analyzing and enriching your unstructured data. Metadata such as Intents and Events are not required, but when passed through to Dimension, these data elements can be leveraged to produce higher fidelity enrichments, insights and visualizations.

Below are some fields or parameters you can send to Dimension along with the format needed.

Message Format

You can send the following fields:

Parameter	Description	Type
text	Required Text of the message	String
userId	Required This should be the same userId for both incoming and outgoing messages. This is not the bot’s user ID	String
intent	(Optional) An object containing intent metadata	Object
images	(Optional) Urls to any images	Array<Object>
buttons	(Optional) Button options in the message	Array<Object>
postback	(Optional) Record of any button clicks	Object
platformJson	(Optional) Send your platform-specific message JSON here. It will be available for viewing in your transcripts. Reporting on this data is available with our enterprise plan.	Object
platformUserJson	(Optional) send any user-specific information (ie. zipcode, A/B test group, etc). Reporting on this data is available from audience builder, with our enterprise plan. If you use these exact field names, they will be used in the expected places on reports: firstName lastName locale timezone gender	Object
sessionId	Required The ID for a conversation or full interaction. This is required to "stitch" conversations together. If your data source is not conversational, you may omit	String
dimensionlabs_timestamp	Required UNIX timestamp (in milliseconds) of the message. If you want to use your server timestamp you can send a unix-timestamp value see Advanced Usage for more information	Number

Additional Metadata Format

If you're sending metadata fields, the following formats are needed:

The intent object includes:

Parameter	Description	Type
name	name of intent	String
inputs	intent inputs	Array<Object>

The intent input object has fields:

Parameter	Description	Type
name	input name	String
value	input value	String

The images field contains image objects that have the fields:

Parameter	Description	Type
url	url of the image	String

The buttons field contains button objects that have the fields:

Parameter	Description	Type
id	id of the button	String
label	label for the button	String
value	value of the button	String

The postback includes the fields:

Parameter	Description	Type
buttonClick	Button click object	Object

The button click object includes:

Parameter	Description	Type
buttonId	id of the clicked button	String

Example Conversation Payload

{
  "text":"hey",
  "userId":"7675836189527716",
  "incoming":true,
  "dimension_timestamp":1703240310000,
  "intent": {
    "name":"HELLO",
    "confidence":0.9634560130000001
  },
  "rawEventLogTypeId":1,
  "type":null,
  "extraInfo": {
    "eventName":null
  },
  "platformJson": {
    "firstMessage":true,
    "incoming":true,
    "gender":"female",
    "customerTier":"silver",
    "customerStatus":"new",
    "locale":"en-CA"
  },
  "sessionId":"1434868331"
}
{
    "text":"Hi! How can I help you?",
    "userId":"7675836189527716",
    "incoming":false,
    "dimension_timestamp":1703240315000,
    "intent":   {
        "name":"HELLO_RESPONSE"
    },
    "rawEventLogTypeId":1,
    "type":null,
    "extraInfo":    {
        "eventName":null
    },
    "platformJson": {
        "firstMessage":false,
        "incoming":false,
        "gender":"female",
        "customerTier":"silver",
        "customerStatus":"new",
        "locale":"en-CA"
    },
    "sessionId":"1434868331"
}
{
    "text":"I want to know where to track my deliveries",
    "userId":"7675836189527716",
    "incoming":true,
    "dimension_timestamp":1703240320000,
    "intent":   {
        "name":"TRACK_ORDER",
        "confidence":0.948014021
    },
    "rawEventLogTypeId":1,
    "type":null,
    "extraInfo":    {
        "eventName":null
    },
    "platformJson": {
        "firstMessage":false,
        "incoming":true,
        "gender":"female",
        "customerTier":"silver",
        "customerStatus":"new",
        "locale":"en-CA"
    },
    "sessionId":"1434868331"
}
{
    "text":"DM34137KMX",
    "userId":"1165873486259425",
    "incoming":true,
    "dimension_timestamp":1703278090000,
    "intent":   {
        "name":"ORDER_NUMBER",
        "confidence":0.999861845
    },
    "rawEventLogTypeId":1,
    "type":null,
    "extraInfo":    {
        "eventName":null
    },
    "platformJson": {
        "firstMessage":false,
        "incoming":true,
        "gender":"female",
        "customerTier":"bronze",
        "customerStatus":"new",
        "locale":"en-CA"
    },
    "sessionId":"9950934871"
}
{
    "text":"Sorry, I can't find any existing order matching that number.",
    "userId":"1165873486259425",
    "incoming":false,
    "dashbot_timestamp":1703278095000,
    "intent":   {
        "name":"ORDER_NOT_FOUND"
    },
    "rawEventLogTypeId":1,
    "type":null,
    "extraInfo":    {
        "eventName":null
    },
    "platformJson": {
        "firstMessage":false,
        "incoming":false,
        "gender":"female",
        "customerTier":"bronze",
        "customerStatus":"new",
        "locale":"en-CA"
    },
    "sessionId":"9950934871"
}
{
    "text":"Operator",
    "userId":"1165873486259425",
    "incoming":true,
    "dashbot_timestamp":1703278100000,
    "intent":   {
        "name":"REQUEST_HUMAN",
        "confidence":0.922092107
    },
    "rawEventLogTypeId":1,
    "type":null,
    "extraInfo":    {
        "eventName":null
    },
    "platformJson": {
        "firstMessage":false,
        "incoming":true,
        "gender":"female",
        "customerTier":"bronze",
        "customerStatus":"new",
        "locale":"en-CA"
    },
    "sessionId":"9950934871"
}
{
    "text":"Okay, I'm getting someone from my team to help you.",
    "userId":"1165873486259425",
    "incoming":false,
    "dashbot_timestamp":1703278105000,
    "intent":   {
        "name":"REQUEST_HUMAN_RESPONSE"
    },
    "rawEventLogTypeId":1,
    "type":null,
    "extraInfo":    {
        "eventName":null
    },
    "platformJson": {
        "firstMessage":false,
        "incoming":false,
        "gender":"female",
        "customerTier":"bronze",
        "customerStatus":"new",
        "locale":"en-CA"
    },
    "sessionId":"9950934871"
}