ThoughtSpot is a cloud-based analytics platform that uses artificial intelligence (AI) and natural language processing (NLP) to help users analyze data and make decisions. 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 ThoughtSpot.
CData Connect AI provides a pure SQL Server, cloud-to-cloud interface for your API, allowing you to easily build models and visualizations from live API data in ThoughtSpot. As you build visualizations, ThoughtSpot 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 ThoughtSpot
Connectivity to your API from ThoughtSpot is made possible through CData Connect AI. To work with API data from ThoughtSpot, we start by creating and configuring a your API connection.
-
Log into Connect AI, click Sources, and then click Add Connection
π Adding a Connection
- Select "API" from the Add Connection panel
π Selecting a data source
-
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:
- Click "+ Add"
- Set the Name for the table
- Set Request URL to the API endpoint you wish to work with
π Setting the Request URL (Harvest is shown)
- (Optional) In Parameters, add the required URL Parameters for your API endpoint
- (Optional) In Headers, add the required HTTP headers for the API endpoint
- In Table Data click " Configure"
- Review the response from the API and click "Next"
π Reviewing the API response (Harvest is shown)
- 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)
- Preview the tabular model of the API response and click "Confirm"
π Previewing the tabular model of the API response (Harvest is shown)
-
Click Save & Test
-
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.
-
Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
-
On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
π Creating a new PAT
-
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 ThoughtSpot.
Model, Search, and Visualize Live API Data in ThoughtSpot
To establish a connection from ThoughtSpot to the CData Connect AI Virtual SQL Server API, follow these steps.
-
Log into ThoughtSpot
-
On the top navigation bar, click Data.
-
Click Create new > Connection.
π Creating a new connection.
-
Name the connection and click "SQL Server" as the data warehouse. π Selecting SQL Server as the connection type.
-
Click Continue on the top right.
- Enter the connection settings:
- Host: enter the Virtual SQL Server endpoint: tds.cdata.com
- Port: : enter 14333
- Username: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
- Password: enter the PAT you generated on the Settings page.
- Database: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, API1).
π Configuring the connection to the Virtual SQL Server API
- Click Continue.
- After connecting successfully, you will be able to choose which tables to include.
π Selecting tables (Salesforce is shown).
- Click Create Connection.
After you successfully configure your connection, you can build models, search, and visualize your API data.
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 ThoughtSpot. You can model, search, and visualize your data from ThoughtSpot . For more information on gaining live access to data from more than 100 SaaS, Big Data, and NoSQL sources from cloud applications like ThoughtSpot, refer to our Connect AI page.