Build Visualizations of Vercel Data in Birst

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData API Driver for JDBC, you can connect to live Vercel data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to Vercel using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC driver offers unmatched performance for live Vercel data operations in Birst. When you issue complex SQL queries from Birst to Vercel, the driver pushes supported SQL operations, like filters and aggregations, directly to Vercel and utilizes the embedded SQL Engine to process unsupported operations client-side (often SQL functions and JOIN operations). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze Vercel data using native Birst data types.

Configure a JDBC Connection to Vercel Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

1. Create a new project in Birst. 👁 Create a new Project in Birst
   
2. Name the connection (e.g. CDataAPI).
3. Choose Live Access.
4. Select an agent.
5. Set Database Type to Other.
👁 Configure the Connection (part 1)

6. Set SQL Type to MSSQL
7. Set the Connection string.

   Using API Key Authentication

   Vercel uses Bearer token authentication. You can use either a personal access token or an OAuth access token as the API key.

   To obtain a personal access token:

   1. Log into your Vercel account at https://vercel.com/
   2. Navigate to Account Settings > Tokens.
   3. Click Create Token, enter a name and expiration, and click Create.
   4. Copy the generated token (it will only be shown once).

   After obtaining your token, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Vercel personal access token or OAuth access token.

   Example Connection String

   Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
   

   Working with Teams

   Many Vercel resources are scoped to a team. To scope all requests to a specific team, set the TeamId connection property to your team's ID. You can find your team ID by querying the Teams table or from the Vercel dashboard. Alternatively, you can specify TeamId in your SQL queries using the WHERE clause where supported.

   Connecting to Vercel

   Once the authentication is configured, you can connect to Vercel and query data from any of the available tables such as Projects, Deployments, Teams, and Domains.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Vercel JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   Below is a typical JDBC connection string for Vercel:

   jdbc:api:Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
   
   

8. Set the Driver Name: cdata.jdbc.api.APIDriver and click Save.

NOTE: Since authentication to Vercel is managed from the connection string, you can leave Security Credentials blank.

Configure Vercel Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

1. Select the Schema (e.g. API).
2. Click on Tables and/or Views to connect to those entities and click Apply.
3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

1. Select the Visualizer tool from the menu.
👁 Select the Visualizer

2. Select Measures & Categories from your objects
3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData API Driver for JDBC with the Cloud Agent and Birst, you can easily create robust visualizations and reports on Vercel data. Download a free, 30-day trial and start building Birst visualizations today.