Dynamics 365 Customer Insights (Preview)
The Dynamics 365 Customer Insights connector provides a set of APIs to interact with Dynamics 365 Customer Insights instances.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
To sign up for Dynamics 365 Customer Insights click here.
To use this connector in Power Apps, learn more here.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create item (Preview) |
This operation creates an item on an entity |
| Get entities |
This operation gets entities from an instance |
| Get item |
This operation gets an item from an entity |
| Get items from an entity |
This operation gets items from an entity. Depending on the entity, fields can be defined as filters:
|
| Retrieve data from a partition (Preview) |
Retrieve data from a partition. |
| Retrieve partitions for an entity (Preview) |
Retrieve partitions for an entity. |
| Retrieve partitions for an entity V2 (Preview) |
Retrieve partitions for an entity V2. |
| Sends the status report |
Sends the status report. |
| Sends the status report V2 |
Sends the status report V2. |
| Update item (Preview) |
This operation updates an item on an entity |
Create item (Preview)
This operation creates an item on an entity
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identifier of an instance |
|
entityName
|
table | True | string |
Name of an entity |
|
recordItem
|
item | True | dynamic |
Record to create |
Get entities
This operation gets entities from an instance
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identifier of an instance |
Returns
Represents a list of tables.
- Body
- TablesList
Get item
This operation gets an item from an entity
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identifier of an instance |
|
entityName
|
table | True | string |
Name of an entity |
|
itemIdentifier
|
id | True | string |
Identifier for the item |
Returns
Get items from an entity
This operation gets items from an entity. Depending on the entity, fields can be defined as filters:
- UnifiedActivity entity: ActivityId and CustomerId fields
- Customer entity: CustomerId field and any other fields indexed in the Customer Insights instance
- Any other entities: CustomerId field.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identifier of an instance |
|
entityName
|
table | True | string |
Name of an entity |
|
Filter Query
|
$filter | string |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Top Count
|
$top | integer |
Total number of entries to retrieve (default = all). |
|
|
Select Query
|
$select | string |
Specific fields to retrieve from entries (default = all). |
Returns
Retrieve data from a partition (Preview)
Retrieve data from a partition.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The Customer Insights dataset
|
dataset | True | string |
The Customer Insights dataset. |
|
The entity
|
table | True | string |
The entity. |
|
The reference (URI or Name) of the partition
|
partitionUri | True | string |
The reference (URI or Name) of the partition. |
|
A comma separated line of columns
|
select | string |
A comma separated line of columns. |
|
|
Position from where to start reading, in bytes
|
offsetStart | integer |
Position from where to start reading, in bytes. |
|
|
Maximum bytes to read
|
maxSize | integer |
Maximum bytes to read. |
|
|
Maximum number of records to return
|
maxResults | integer |
Maximum number of records to return. |
Returns
The data from a partition.
Retrieve partitions for an entity (Preview)
Retrieve partitions for an entity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The Customer Insights dataset
|
dataset | True | string |
The Customer Insights dataset. |
|
The entity
|
table | True | string |
The entity. |
Returns
- response
- array of Table
Retrieve partitions for an entity V2 (Preview)
Retrieve partitions for an entity V2.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The Customer Insights dataset
|
dataset | True | string |
The Customer Insights dataset. |
|
The entity
|
table | True | string |
The entity. |
|
The partitionDisplayName value to filter for
|
partitionDisplayName | string |
The partitionDisplayName value to filter for. |
Returns
The list of partitions
Sends the status report
Sends the status report.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Instance id
|
dataset | True | string |
Select an instance. |
|
Report type
|
reportType | True | string |
Select a report type. |
Sends the status report V2
Sends the status report V2.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Instance id
|
dataset | True | string |
Select an instance. |
|
Report type
|
reportType | True | string |
Select a report type. |
Update item (Preview)
This operation updates an item on an entity
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identifier of an instance |
|
entityName
|
table | True | string |
Name of an entity |
|
itemIdentifier
|
id | True | string |
Identifier for the item |
|
recordItem
|
item | True | dynamic |
Record to update |
Returns
Triggers
| Triggers a flow from the data source when refresh is completed |
This operation triggers a flow from the data source when refresh is completed in Dynamics 365 Customer Insights. |
| Triggers a flow from the data source when refresh is failed |
This operation triggers a flow from the data source when refresh is failed in Dynamics 365 Customer Insights. |
| Triggers a flow when a business measure threshold is crossed |
This operation triggers a flow when a business measure threshold is crossed in Dynamics 365 Customer Insights. |
| Triggers a flow when a full refresh of Customer Insights is completed |
This operation triggers a flow when a full refresh of Customer Insights (data sources, segments, measures,...) is completed. |
| Triggers a flow when a process in Customer Insights is completed |
A flow is triggered for scheduled refreshes of selected process. Additionally, you can choose to trigger a flow for manual refreshes. |
| Triggers a flow when a segment threshold is crossed |
This operation triggers a flow when a segment threshold is crossed in Dynamics 365 Customer Insights. |
Triggers a flow from the data source when refresh is completed
This operation triggers a flow from the data source when refresh is completed in Dynamics 365 Customer Insights.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Environment
|
dataset | True | string |
dataset name. |
Returns
DataSourcesList
- Body
- DataSourcesList
Triggers a flow from the data source when refresh is failed
This operation triggers a flow from the data source when refresh is failed in Dynamics 365 Customer Insights.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Environment
|
dataset | True | string |
dataset name. |
Returns
DataSourcesList
- Body
- DataSourcesList
Triggers a flow when a business measure threshold is crossed
This operation triggers a flow when a business measure threshold is crossed in Dynamics 365 Customer Insights.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Instance name
|
dataset | True | string |
Select an instance. |
|
Business Measure name
|
measure | True | string |
Select a measure. |
|
Threshold
|
threshold | True | double |
Set any number as threshold. |
Returns
Business Measure data
- Body
- MeasureData
Triggers a flow when a full refresh of Customer Insights is completed
This operation triggers a flow when a full refresh of Customer Insights (data sources, segments, measures,...) is completed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Instance name
|
dataset | True | string |
Select an instance. |
Returns
The information about executed full refresh
Triggers a flow when a process in Customer Insights is completed
A flow is triggered for scheduled refreshes of selected process. Additionally, you can choose to trigger a flow for manual refreshes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Instance name
|
dataset | True | string |
Select an instance. |
|
Process
|
process | string |
Select a process. |
|
|
Include manually triggered process
|
includingManualRefreshes | boolean |
Select yes if manually triggered process should be included. |
Returns
The information about executed process
- Body
- ProcessData
Triggers a flow when a segment threshold is crossed
This operation triggers a flow when a segment threshold is crossed in Dynamics 365 Customer Insights.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Instance name
|
dataset | True | string |
Select an instance. |
|
Segment name
|
segment | True | string |
Select a segment. |
|
Threshold
|
threshold | True | integer |
Set any number as threshold. |
Returns
Segment data
- Body
- SegmentData
Definitions
DataSourcesList
DataSourcesList
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of DataSource |
List of data sources |
DataSource
DataSource Class
| Name | Path | Type | Description |
|---|---|---|---|
|
RefreshType
|
RefreshType | string |
The type for data refresh |
|
RefreshObjectId
|
RefreshObjectId | string |
The refresh object id |
|
RefreshObjectVersion
|
RefreshObjectVersion | integer |
The refresh object version |
|
Operation
|
Operation | string |
The operation name |
|
JobType
|
JobType | string |
The job type |
|
ErrorCode
|
ErrorCode | string |
The error code during data refresh. |
|
ErrorMessage
|
ErrorMessage | string |
The error message during refresh |
|
ErrorSeverity
|
ErrorSeverity | string |
The error serverity during refresh |
|
StartTimeUtc
|
StartTimeUtc | string |
The start time for data refresh |
|
EndTimeUtc
|
EndTimeUtc | string |
The end time for data refresh |
SegmentData
Segment data
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
Name | string |
The segment name |
|
DisplayName
|
DisplayName | string |
The segment display name |
|
EvaluationDate
|
EvaluationDate | date-time |
The segment evaluation date |
|
EntityCount
|
EntityCount | integer |
The actual count of segment members |
|
Threshold
|
Threshold | integer |
The segment threshold |
MeasureData
Business Measure data
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
Name | string |
The measure name |
|
DisplayName
|
DisplayName | string |
The measure display name |
|
EvaluationDate
|
EvaluationDate | date-time |
The measure evaluation date |
|
Value
|
Value | double |
The value of the measure |
|
ValueDisplayName
|
ValueDisplayName | string |
The display name of the value |
|
Threshold
|
Threshold | double |
The measure threshold |
FullRefreshProcessData
The information about executed full refresh
| Name | Path | Type | Description |
|---|---|---|---|
|
NumberOfFailedTasks
|
NumberOfFailedTasks | integer |
The number of failed tasks |
|
StartTime
|
StartTime | date-time |
The start time of the workflow step |
|
EndTime
|
EndTime | date-time |
The end time of the workflow step |
|
Duration
|
Duration | integer |
The duration of the process in minutes |
|
Status
|
Status | string |
The status of the workflow step |
|
StatusPage
|
StatusPage | string |
The link to the status page |
ProcessData
The information about executed process
| Name | Path | Type | Description |
|---|---|---|---|
|
StartTime
|
StartTime | date-time |
The start time of the workflow step |
|
EndTime
|
EndTime | date-time |
The end time of the workflow step |
|
Duration
|
Duration | integer |
The duration of the process in minutes |
|
Status
|
Status | string |
The status of the workflow step |
|
StatusPage
|
StatusPage | string |
The link to the status page |
Table
Represents a table.
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
Name | string |
The name of the table. The name is used at runtime. |
|
DisplayName
|
DisplayName | string |
The display name of the table. |
|
DynamicProperties
|
DynamicProperties | object |
Additional table properties provided by the connector to the clients. |
PartitionListResponse
The list of partitions
| Name | Path | Type | Description |
|---|---|---|---|
|
Header
|
Header | string |
Header containing the attributes of the entity |
|
Partitions
|
Partitions | array of Table |
List of partitions |
PartitionDataResponse
The data from a partition.
| Name | Path | Type | Description |
|---|---|---|---|
|
OffsetStart
|
OffsetStart | integer |
The starting offset. |
|
OffsetEnd
|
OffsetEnd | integer |
The end offset. |
|
Size
|
Size | integer |
The number of returned data. |
|
Items
|
Items | array of object |
The dictionary containing data of maximum 'Size' items from a partition, from offset 'OffsetStart' to 'OffsetEnd'. |
|
items
|
Items | object |
TablesList
Represents a list of tables.
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of Table |
List of Tables |