Viewing interactions’ mapped data source data

In the Data Source Mappings area of the Vonage Contact Center Admin Portal, you can map one or more data sources to a single name. This mapping consolidates data in the data sources where the data sources may represent the same or related data.

For more information about Data Source Mappings, see Data Source Mappings.

When you have created one or more data source mappings, data in the mapped data source is returned in responses to requests to interactions endpoints:

  • Get interactions (GET /interactions)
  • Get a single interaction (GET /interactions/ongoing/{guid})
  • Get ongoing interactions (GET /interactions/ongoing)

The data appears as a property of a DataSourceValueAcquired event with an offset. The offset is the time at which the data source value was acquired, represented by the length of time after the start of the interaction that the channel started:

"events": [
	{
		"type": "DataSourceValueAcquired",
		"offset": 100,
		"name":"Company Name",
		"properties":
		{
			"value": "CompanyName UK"
		}
	},
	{
		"type": "DataSourceValueAcquired",
		"offset": 600,
		"name":"Company Name",
		"properties":
		{
			"value": "CompanyName England"
		}
	},
	{
		"type": "DataSourceValueAcquired",
		"offset": 36000,
		"name":"Company Name",
		"properties":
		{
			"value": "CompanyName London"
		}
	}
]

Examples

One data source is mapped to “Company Name”

In this example, the data source mapped to “Company Name” is set once.

"events": [
	{
		"type": "DataSourceValueAcquired",
		"offset": 10,
		"name":"Company Name",
		"properties":
		{
			"value": "CompanyName UK"
		}
	}
]

One data source is mapped to “Company Name” but the value of that data source is set twice for the interaction (two DataSourceValueAcquired events)

In this example, both values are recorded.

The last value set is given priority where relevant.

"events": [
	{
		"type": "DataSourceValueAcquired",
		"offset": 600,
		"name":"Company Name",
		"properties":
		{
			"value": "CompanyName UK"
		}
	},
	{
		"type": "DataSourceValueAcquired",
		"offset": 36000,
		"name":"Company Name",
		"properties":
		{
			"value": "CompanyName England"
		}
	}
]

Two data sources are mapped to “Customer Name”; both data sources have values set with the same offset

If two or more data source values are acquired with the same offset, the mapped value contains both values. The values are comma-separated.

Neither value has priority

"events": [
	{
		"type": "DataSourceValueAcquired",
		"offset": 10,
		"name": "Company Name",
		"properties":
		{
			"value": "CompanyName UK, CompanyName England"
		}
	}
]

Two data sources are mapped to “Customer Name”; both data sources have values set with different offsets

The last value set is given priority where relevant.

"events": [
	{
		"type": "DataSourceValueAcquired",
		"name": "Company Name",
		"offset": 10,
		"properties":
		{
			"value": "CompanyName UK"
		}
	},
	{
		"type": "DataSourceValueAcquired",
		"name": "Company Name",
		"offset": 30,
		"properties":
		{
			"value": "CompanyName England"
		}
	}
]