Use Customer Insights APIs

Completed

Customer Insights - Data provides many out-of-the-box tools that help you connect to and use its data with many popular applications and services. However, scenarios might occur when you want to build your own applications based on the data in Customer Insights.

Developers can use the available application programming interface (API) in Customer Insights - Data to build custom solutions. For example, you might want to use a measure in Customer Insights - Data to drive data operations in a supporting application. When a customer's average lifetime spent value falls below a specific amount, you might want to send the customer some information. By using Customer Insights - Data APIs, you would be able to identify the different measures that are available and refresh them as needed to ensure that everything is up to date. When you have that data, you could perform operations in the supporting application.

With Customer Insights - Data APIs, you can complete specific tasks in your solutions:

  • Data profiling - Pull attribute and entity profile information so that you can use it in other areas.

  • Work with data sources - Perform management tasks that are related to your data sources, such as deleting a data source, getting a list of all data sources, or pulling in details of a specific data source.

  • Work with entity data - Get, create, and update entity details.

  • Manage instances - Create, delete, and reset your Customer Insights - Data instances.

  • Manage measures - Create, delete, and update measures in the application.

  • Manage user permissions - Manage the roles and permissions that users have in the application.

  • Relationship management - Manage the relationships between different entities in the application.

  • Segments management - Create, delete, and reset the segments in your Customer Insights - Data instance.

Explore the Customer Insights - Data APIs

Before you can begin using the Customer Insights - Data APIs, you first need to enable them. To complete that task, go to Admin > Permissions, select the APIs tab, and then select the Enable Button.

Screenshot of the Permissions option selected in the navigation pane.

Enabling the APIs creates a primary and secondary subscription key for your instance to use in the API requests. You can regenerate the keys by selecting the Regenerate primary or Regenerate secondary options on Admin > Permissions > APIs.

Building solutions by using Customer Insights - Data APIs is out of the scope of this module. For more information, go to the following links: