Versions Compared

Old Version 5

changes.mady.by.user Chitra Borker

Saved on

compared with

New Version Current

changes.mady.by.user Chitra Borker

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Domo is a cloud-based Business Intelligence and Data Visualisation platform that can be used to connect directly to Insights API data. This raw API data can then be transformed into focused reports and dashboards that provide real-time data on your Digital People and their critical metrics.

The API keys provide the credentials to connect the API with a Business Intelligence or Data Visualization tool such as Domo to allow the connection and integration of Digital Person data and insights.

Connecting Analytics API to Domo

The following video demonstrates how to integrate Soul Machines Insights API v 1.0 with Domo.

https://www.loom.com/share/109bd0dee5cc46f1b47848705b2271fa

following video demonstrates how to integrate Soul Machines Insights API v 1.0 with Domo.

Creating API Key for Use in Domo

To connect your Insights API data to Domo, you will need API Key credentials which can be generated from the Digital DNA Studio as shown below.

Info

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

domo-api-key.mp4

Adding API Key to Domo JSON Account

The API Key you created in DDNA Studio needs to be added to a Domo JSON connector account as shown below.

Create Domo Account with API Key Cropped.mp4

  1. From the Data tab in Domo, navigate to the Accounts page by selecting the key icon from the left menu.

  2. In the Get Connected pane, click +Add an Account.

  3. In the Connector field, start typing JSON and choose it from the dropdown list.

  4. Give your Account a meaningful name.

  5. Enter apikey in the Authentication Type field.

  6. Enter header in the API Key Type field.

  7. For the Parameter/Header Name field, enter x-sm-apikey.

  8. Copy and paste the secret API key you created in DDNA Studio into the API Key field.

Info

Note: This is the account you will use to connect to all Insights API endpoints.

Connecting to the Query Daily Events Endpoint

Using the JSON Account you created, you can access the Query Daily Events endpoint data. This is the primary endpoint that returns daily log sessions events data.

Domo - Query Daily Events Connection Cropped.mp4

  1. From the Data tab in Domo, navigate to the Data Warehouse page by selecting the box icon from the left menu.

  2. From the Connect Data menu, select Connectors.

  3. In the Search Connectors field, start typing JSON and select the JSON No Code Connector from the dropdown list.

  4. Select the JSON Account you made from the dropdown menu in the Credentials pane, click Next.

  5. Paste the following link into the URL to your JSON file field: https://analytics-service.soulmachines.cloud/api/v1/analytics/query-daily-events

Info

Note: We are using the GET method to retrieve information from the Insights API via a specified URL.

6. Expand the Advanced Settings field.

7. In the Query Parameters section, specify an optional projectId and/or session parameter Key and Value.

8. In the Date Query Parameters section, select Single Date from the date filter dropdown menu and confirm the Date Format matches yyyy-MM-dd.

9. Select Specific or Relative Date Type(s).

Info

Note: Relative dates are useful when setting up a connection to automatically refresh and append new data to an existing connection. For example, a connection can be scheduled to pull in yesterday’s data, every 24 hours. This is done in part by setting the Days Back field to -1.

10. Enter startdate as the Parameter Name field and specify the Date or Days Back,in the appropriate format (either yyyy-MM-dd or an integer value).

Info

Note: More detailed information on query parameter requirements, their descriptions and datatypes can be found at https://docs.soulmachines.com/analytics/api#tag/Query-Daily-Logs.

11. Click Next. Expand the Parsing menu to see a preview of your loaded data.

12. A range of data formatting options are available when a column in the Data Preview is selected.

13. Find and select the events column and select Expand Array As Rows to expand each event as its own row.

14. Click Next. The Scheduling pane can be used to schedule the interval for when and how your data connection is updated. Select options from the Update Interval and Update Method dropdown menus.

Info

Note: Selecting Replace as the Update Method will replace the existing dataset with new data, every time the connection is refreshed. Selecting Append as the Update Method will append new data to the existing dataset, every time the connection is refreshed.

15. Click Next. Give your dataset a meaningful Name and Description.

16. Click Save and Run to load your dataset and connection. Navigate to the Data tab to see the loaded columns and rows.

You are ready to explore, visualize and query your Daily Events Insights API data in Domo.

Connecting to the Events Summary Endpoint

Using the JSON Account you created, you can access the Events Summary endpoint data. This endpoint returns an organization-level events summary report between a specified start and end date.

Demo - Events Summary Connection Cropped.mp4

  1. From the Data tab in Domo, navigate to the Data Warehouse page by selecting the box icon from the left menu.

  2. From the Connect Data menu, select Connectors.

  3. In the Search Connectors field, start typing JSON and select the JSON No Code Connector from the dropdown list.

  4. Select the JSON Account you made from the dropdown menu in the Credentials pane, click Next.

  5. Paste the following link into the URL to your JSON file field: https://analytics-service.soulmachines.cloud/api/v1/analytics/events-summary

Info

Note: We are using the GET method to retrieve information from the Insights API via a specified URL.

6. Expand the Advanced Settings field.

7. In the Query Parameters section, specify an optional projectId parameter Key and Value.

8. In the Date Query Parameters section, select Date Range from the date filter dropdown menu and confirm the Date Format matches yyyy-MM-dd.

9. Select Specific or Relative Date Type(s).

Info

Note: Relative dates are useful when setting up a connection to automatically refresh and append new data to an existing connection. For example, a connection can be scheduled to pull in yesterday’s data, every 24 hours. This is done in part by setting the Days Back field to -1.

10. Enter startdate as the first Parameter Name field and specify the Date or Days Back,in the appropriate format (either yyyy-MM-dd or an integer value).

11. Enter enddate as the second Parameter Name field and specify the Date or Days Back,in the appropriate format (either yyyy-MM-dd or an integer value).

Info

Note: enddate is an optional parameter. If Single Date is selected from the date filter dropdown menu, or if enddate is excluded, enddate will default to the present date.

More detailed information on query parameter requirements, their descriptions and datatypes can be found at https://docs.soulmachines.com/analytics/api#tag/Events-Summary.

12. Click Next. Expand the Parsing menu to see a preview of your loaded data.

13. A range of data formatting options are available when a column in the Data Preview is selected.

14. Find and select the projects column and select Expand Array As Rows to expand each project as its own row.

15. Click Next. The Scheduling pane can be used to schedule the interval for when and how your data connection is updated. Select options from the Update Interval and Update Method dropdown menus.

Info

Note: Selecting Replace as the Update Method will replace the existing dataset with new data, every time the connection is refreshed. Selecting Append as the Update Method will append new data to the existing dataset, every time the connection is refreshed.

16. Click Next. Give your dataset a meaningful Name and Description.

17. Click Save and Run to load your dataset and connection. Navigate to the Data tab to see the loaded columns and rows.

You are ready to explore, visualize and query your Events Summary Insights API data in Domo.

Connecting to the Conversation Nodes Summary Endpoint

Using the JSON Account you created, you can access the Conversation Nodes Summary endpoint data. This endpoint returns an organization-level conversation nodes summary report between a specified start and end date.

Demo - Conv Nodes Summary Connection Cropped.mp4

  1. From the Data tab in Domo, navigate to the Data Warehouse page by selecting the box icon from the left menu.

  2. From the Connect Data menu, select Connectors.

  3. In the Search Connectors field, start typing JSON and select the JSON No Code Connector from the dropdown list.

  4. Select the JSON Account you made from the dropdown menu in the Credentials pane, click Next.

  5. Paste the following link into the URL to your JSON file field: https://analytics-service.soulmachines.cloud/api/v1/analytics/conversation-nodes-summary

Info

Note: We are using the GET method to retrieve information from the Insights API via a specified URL.

6. Expand the Advanced Settings field.

7. In the Query Parameters section, specify a projectId parameter Key and Value. Enter optional session, format and focusedName parameter key value pairs here.

Info

Note: format and focusedName parameters are used to return the data in a graph-friendly format. More detailed information on query parameter requirements, their descriptions and datatypes can be found at https://docs.soulmachines.com/analytics/api#tag/Conversation-Nodes-Summary.

8. In the Date Query Parameters section, select Single Range from the date filter dropdown menu and confirm the Date Format matches yyyy-MM-dd. Select Date Range if you would like to specify both a start and end date.

9. Select Specific or Relative Date Type(s).

Info

Note: Relative dates are useful when setting up a connection to automatically refresh and append new data to an existing connection. For example, a connection can be scheduled to pull in yesterday’s data, every 24 hours. This is done in part by setting the Days Back field to -1.

10. Enter startdate as the first Parameter Name field and specify the Date or Days Back,in the appropriate format (either yyyy-MM-dd or an integer value).

11. If Date Range was selected, enter enddate as the second Parameter Name field and specify the Date or Days Back,in the appropriate format (either yyyy-MM-dd or an integer value).

Info

Note: enddate is an optional parameter. If Single Date is selected from the date filter dropdown menu, or if enddate is excluded, enddate will default to the present date.

More detailed information on query parameter requirements, their descriptions and datatypes can be found at https://docs.soulmachines.com/analytics/api#tag/Conversation-Nodes-Summary .

12. Click Next. Expand the Parsing menu to see a preview of your loaded data.

13. A range of data formatting options are available when a column in the Data Preview is selected.

14. Find and select the conversationNodes column and select Expand Array As Rows to expand each conversational node as its own row. Expand the previousNodes and nextNodes columns if necessary.

15. Click Next. The Scheduling pane can be used to schedule the interval for when and how your data connection is updated. Select options from the Update Interval and Update Method dropdown menus.

Info

Note: Selecting Replace as the Update Method will replace the existing dataset with new data, every time the connection is refreshed. Selecting Append as the Update Method will append new data to the existing dataset, every time the connection is refreshed.

16. Click Next. Give your dataset a meaningful Name and Description.

17. Click Save and Run to load your dataset and connection. Navigate to the Data tab to see the loaded columns and rows.

You are ready to explore, visualise and query your Conversation Nodes Summary Insights API data in Domo.

Contents

Table of Contents

Related Topics

Contents

toc