About Customer Insights Web Services
[This topic is pre-release documentation and is subject to change.]
When you will use these web services
The service offers RESTful APIs to configure and consume, model, and report on your business data and processes. You would commonly use these APIs to do the following:
- Automate the modeling, configuration of the system. Let’s say that you run a bank. For your business let’s say that you want to have deeper insights in about and across individual customers, bank branches, employees etc. You would create and model Profiles for those. Similarly, you would model the actions performed by these profiles as Customer Insights interactions. You would also define a few KPIs to be calculated on these. Now all of these you might want for a test system, production system, may be a different one for different region. APIs help you automate all of the modeling and configuration for Customer Insights
- Consume the data. Customer Insights stores and computes insights for your business. You might want to consume the data in one of your existing portals, tools etc. Customer Insights provides performant and powerful APIs to query and consume the data.
- Push new data. Let’s say for your bank customers leave feedback about their branch visit. You might want to send that data to Customer Insights in real time or submit files that are produced daily by your existing system. Customer Insights exposes fast, secure and reliable APIs for pushing data.
- Create custom solutions. ISVs can build and configure models for different domains with data connectors using Customer Insights API. That enables a customer to just run an ISV solution and have the whole model created and system configured automatically.
How you will use these web services
Customer Insights currently offers the following ways to use the web services:
- REST APIs—the Azure Resource Manager (ARM) API and the Hub API—described in this document. For more information, see API Requests and Responses.
- Azure PowerShell and ARM templates will be provided separately.
About the two REST APIs
Customer Insights APIs are divided in two sections: Azure Resource Manager (ARM) and Hub APIs.
Dynamics 365 for Customer Insights is registered with Azure Resource Manager as a standard resource provider named "Microsoft.CustomerInsights". This provider exposes its own API—the Customer Insights Azure Resource Manager (ARM) API. All of Customer Insights Azure portal, Azure PowerShell and Azure SDK functionality works on top of Customer Insights ARM APIs.
The Microsoft.CustomerInsights provider also declares primary resources named "Hub". A hub represents a complete set of billable functionality. Each hub also exposes its own API—the Customer Insights Hub API.
Much commonality exists between the functionality provided by these two APIs, as detailed in Customer Insights API Quick Reference.