Connect to Live API Data in MicroStrategy through CData Connect Cloud

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with CData Connect Cloud, 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 Cloud and connecting to Connect Cloud in MicroStrategy to create a simple visualization of API data.

As a cloud-based integration platform, Connect Cloud 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 Cloud. To work with API data from Microstrategy, we start by creating and configuring a your API connection.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "API" from the Add Connection panel
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
   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"
   8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next"
   9. Preview the tabular model of the API response and click "Confirm"
4. Click Create & Test
5. Navigate to the Permissions tab in the Add your API Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. Oa the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
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, 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.
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 Cloud user
   • Password: the PAT for your Connect Cloud 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"
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. 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 Cloud.
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 Cloud.
12. Once you have finished configuring the dossier, click File -> Save.

Using CData Connect Cloud 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 Cloud page. Sign up for a free trial and start working with live API data in MicroStrategy.