How to connect Amazon QuickSight to API Data

Amazon QuickSight allows users to build interactive dashboards in the cloud. When paired with CData Connect Cloud, you get cloud-to-cloud access to API data for visualizations, dashboards, and more. This article shows how to connect to your API in Connect Cloud and build dashboards in Amazon QuickSight with access to API data.

CData Connect Cloud provides a pure cloud-to-cloud interface for your API, allowing you to allowing build visualizations from API data in Amazon QuickSight. By importing your API data into the Amazon QuickSight "Super-fast, Parallel, In-memory Calculation Engine" (SPICE), you can leverage the powerful data processing features of the Amazon ecosystem to build responsive dashboards. And with the ability to schedule refreshes of the data stored in SPICE, you control how up-to-date your dashboards are.

Configure your API Connectivity for Amazon QuickSight

Connectivity to your API from Amazon QuickSight is made possible through CData Connect Cloud. To work with API data from Amazon QuickSight, 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. On 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 Amazon QuickSight.

Import API Data into SPICE and Create Interactive Dashboards

The steps below outline creating a new data set based on the connection to your API in Connect Cloud, importing the dataset into SPICE, and building a simple visualization from the data.

1. Log into Amazon QuickSight and click "Manage data."
2. Click "Now data set," select SQL Server as the data source, configure the connection to your Connect Cloud instance, and click "Create data source."
3. Select a table to visualize (or subait a custom SQL query for your data).
4. Click "Edit/Preview data" to customize the data set.
5. Select "Import to SPICE for quicker analytics" and click "Visualize."
6. Select fields to visualize and a visual type.

Schedule Refreshes for SPICE Data Sets

QuickSight users can schedule refreshes for data sets that are imported into SPICE, ensuring that data being analyzed is only as old as the most recent refresh.

1. Navigate to the QuickSight home page.
2. Click "Manage data."
3. Select the data set you wish to refresh.
4. Click "Schedule refresh."
5. Click Create, configure the refresh settings (time zone, repeat frequency, and starting datetime), and click Create.

Live Access to API Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to API data from your Amazon QuickSight dashboard. You can create new visualizations, build interactive dashboards, and more. For more information on gaining live access to data from more than 100 SaaS, Big Data, and NoSQL sources from cloud applications like Amazon QuickSight, refer to our Connect Cloud page.