Connecting to Insights API

Owned by Chitra Borker (Deactivated)
Last updated: Apr 18, 2022
2 min read

The Insights API allows you to gain access to data on how your Digital People’s conversations are performing. The visual data represented on the Insights Dashboard is available to you in raw format for all the projects in the organization or the chosen project. The raw data helps you analyze how users interact with the Digital Person and the emotional data at a granular level enabling you to optimize and improve the Digital Person experience.

Creating API Key for Insights API

To access the Insights API you will need an API Key which can be generated from the Digital DNA Studio as shown below.

Note: The key itself will only be accessible once, on creation. So ensure that it is saved in a secure location.

Video-Create Insights API Key

 

  1. From the settings cog icon on the top right corner of the screen, select API Keys and click Create API Key.

  2. On the new API Key window, enter a Name for the new API key.

  3. Select the scope as Analytics.

  4. In the Assign Project field start typing the name of the project you wish to generate the API key for and choose the project from the dropdown list.

Note: If you are granted the Owner, Support, or Analytics role, you can apply the Analytics API key to all the current and future projects in the organization by choosing the All organization projects option.

5. Set the expiration date. Options available are 30, 60, and 90 days.

6. On successful creation, the API key is displayed for you to save or copy.

Note: The secret key is only displayed once during creation. If you lose the API key, you need to generate a new one.

You should revoke the key if it becomes inactive, lost, or compromised. For details see Revoke API Key.