Build API Visualizations in Tableau Cloud

Tableau Cloud is an analytics platform fully hosted in the cloud. When paired with CData Connect AI, you get instant, cloud-to-cloud access to API data for visualizations, dashboards, and more. This article shows how to connect to your API and build visualizations from API data in Tableau Cloud.

CData Connect AI provides a pure cloud-to-cloud interface for your API, allowing you to easily build visualizations from live API data in Tableau Cloud without installing connectors or publishing worksheets and data sources from Tableau Desktop. As you build visualizations, Tableau Cloud generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc) directly to your API, leveraging server-side processing to quickly return API data.

Configure your API Connectivity for Tableau Cloud

To work with API data from Tableau Cloud, we need to connect to your API from Connect AI, provide user access to the connection, and create a Workspace for the API data.

Connect to your API from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

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.

Configure your API Endpoints for Tableau Cloud

After connecting to your API, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace). 👁 The Workspaces page.
   👁 Adding a new Workspace.
   
2. Click Add to add new assets to the Workspace.
3. Select the your API connection (e.g. API1) and click Next. 👁 Selecting an Asset (Salesforce is shown).
   
4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
   
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to API data from Tableau Cloud.

Visualize Live API Data in Tableau Cloud

The steps below outline creating a new data source in Tableau Cloud based on the virtual your API database in Connect AI and building a simple visualization from the data.

1. Log into Tableau Cloud, select a account, and create a new workbook.
2. In the new workbook, choose the OData Connector from the data wizard and fill in the values for your Connect AI instance. 👁 Selecting OData connector in Tableau Cloud
   
   • Set Server to the OData URL for your Workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}
   • Set Authentication to Username and Password
   • Set Username to your Connect AI username (e.g. [email protected])
   • Set Password to a PAT for the above user
   👁 Connect to Connect AI from Tableau Cloud
   
3. Select your newly created database and the table(s) you wish to visualize (defining relationships for JOINad tables as needed).
👁 Choosing a Database and Tables

4. Select Dimensions and Measures and configure your visualization.
👁 Visualizing API data in Tableau Cloud

Real-Time Access to API Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to live API data from your Tableau Cloud workbook. You can create new visualizations, build dashboards, and more, with no need to publish data sources and workbooks from Tableau Desktop. For more information on gaining live access to data from more than 100 SaaS, Big Data, and NoSQL sources from cloud applications like Tableau Cloud, refer to our Connect AI page.