Query, Visualize, and Share live API Data in Redash

Redash is a collaboration tool that lets you query, visualize, and share your data. When paired with CData Connect AI, Redash gets access to live API data. This article demonstrates how to connect to your API using Connect AI and work with live API data in Redash.

CData Connect AI provides a pure SQL Server interface for your API, allowing you to query data from your API without replicating the data to a natively supported database. 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 return the requested API data quickly.

Configure your API Connectivity for Redash

Connectivity to your API from Redash is made possible through CData Connect AI. To work with API data in Redash, 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 Redash.

Connect to your API from Redash using Connect AI

To establish a connection from Redash to CData Connect AI using the Virtual SQL Server, follow these steps:

1. Log into Redash.
2. Click the settings widget on the top right.
3. Click New Data Source.
4. Select Microsoft SQL Server as the Data Source Type.
5. On the configuration tab, set the following properties:
   • Database Name: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Salesforce1).
   • Server: enter the virtual SQL Server host name (tds.cdata.com)
   • User: 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.
   • Port: enter 14333
   👁 Configuring the connection to Connect AI from Redash.
   
6. Click Create.
7. Click Test Connection to ensure that the connection is configured properly.

You can now work with live API data in Redash.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from Redash, try CData Connect AI today!