Connect to Live API Data in MicroStrategy through CData Connect AI

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with CData Connect AI, you gain database-like access to live API data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through connecting to your API in Connect AI and connecting to Connect AI in MicroStrategy to create a simple visualization of API data.

As a cloud-based integration platform, Connect AI is ideal for working with cloud-based BI and analytics tools. With no servers to configure or data proxies to set up, you can simply use the web-based UI to create a live connection to your API and connect from MicroStrategy to start performing analytics based on live API data.

Configure your API Connectivity for Microstrategy

Connectivity to your API from Microstrategy is made possible through CData Connect AI. To work with API data from Microstrategy, we start by creating and configuring a your API connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "API" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to your API.

   To connect to your API, configure the following properties on the Global Settings page:

   • In Authentication, select the Type and fill in the required properties
   • In Headers, add the required HTTP headers for your API
   • In Pagination, select the Type and fill in the required properties

   After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

   1. Click "+ Add"
   2. Set the Name for the table
   3. Set Request URL to the API endpoint you wish to work with 👁 Setting the Request URL (Harvest is shown)
      
   4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
   5. (Optional) In Headers, add the required HTTP headers for the API endpoint
   6. In Table Data click " Configure"
   7. Review the response from the API and click "Next" 👁 Reviewing the API response (Harvest is shown)
      
   8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next" 👁 Configuring the schema based on the API response(Harvest is shown)
      
   9. Preview the tabular model of the API response and click "Confirm" 👁 Previewing the tabular model of the API response (Harvest is shown)
      
4. Click Save & Test
5. Navigate to the Permissions tab in the Add your API Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to API data from MicroStrategy.

Connect to and Visualize API Data Using MicroStrategy

You can connect to your API in MicroStrategy by adding a data source based on the native SQL Server functionality. Once you have created a data source, you can build dynamic visualizations of API data in MicroStrategy.

1. Open MicroStrategy and select your account.
2. Click Add External Data, select Databases, and use Select Tables as the Import Option. 👁 Adding External Data
   
3. In the Import from Tables wizard, click to add a new Data Source.
4. Select "SQL Server" in the Database menu and select "SQL Server 2017" in the Version menu.
5. Sat the connection properties as follows:
   • Server Name: tds.cdata.com
   • Port Number: 14333
   • Database Name: the name of your your API connection (e.g. API1)
   • User: a Connect AI user
   • Password: the PAT for your Connect AI user
   • Data Source Name: a name for the new external data source, like "CData Cloud your API"
6. Expand the menu for the new data source and choose "Edit Catalog Options"👁 Edit the catalog options.
   
7. Edit the "SQL statement retrieve columns ..." query to include TABLE_SCHEMA = '#?Schema_Name?#' in the WHERE clause, and click Apply and then OK (the complete query is below).
   
   

   SELECT DISTINCT 
    TABLE_SCHEMA NAME_SPACE, 
    TABLE_NAME TAB_NAME, 
    COLUMN_NAME COL_NAME, 
    (CASE 
    WHEN 
    (DATA_TYPE LIKE '%char' AND (CHARACTER_SET_NAME='utf8' OR CHARACTER_SET_NAME='usc2')) 
    THEN 
    CONCAT('a',DATA_TYPE) 
    ELSE 
    DATA_TYPE 
    END) DATA_TYPE, 
    CHARACTER_MAXIMUM_LENGTH DATA_LEN, 
    NUMERIC_PRECISION DATA_PREC, 
    NUMERIC_SCALE DATA_SCALE 
   FROM 
    INFORMATION_SCHEMA.COLUMNS 
   WHERE 
    TABLE_NAME 
   IN 
    (#TABLE_LIST#) AND TABLE_SCHEMA='#?Schema_Name?#' 
   ORDER BY 
    1,2,3
   

8. Select the new data source and select the Namespace that corresponds to your virtual your API database (like API1).
9. Drag tables into the pane to insert then. 👁 Select tables to insert.
   Note: Since we create a live connection, we can insert whole tables and utilize the filtering and aggregation features native to the MicroStrategy products to customize our datasets.
10. Click Finish, choose the option to connect live, save the query, and choose the option to create a new dossier. Live connections are possible and effective, thanks to high-performance data processing native to CData Connect AI. 👁 Save the query and create a new dossier.
    
11. Choose a visualization, choose fields to display, and apply any filters to create a new visualization of API data. Data types are discovered automatically through dynamic metadata discovery. Where possible, the complex queries generated by the filters and aggregations will be pushed down to your API, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed by the CData SQL engine embedded in Connect AI. 👁 Visualize API data.
    
12. Once you have finished configuring the dossier, click File -> Save.

Using CData Connect AI with MicroStrategy, you can easily create robust visualizations and reports on API data. For more information on connecting to your API (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live API data in MicroStrategy.