Build Visualizations of Notion 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 Notion 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 Notion using the Cloud Agent and create dynamic reports in Birst.
With powerful data processing capabilities, the CData JDBC driver offers unmatched performance for live Notion data operations in Birst. When you issue complex SQL queries from Birst to Notion, the driver pushes supported SQL operations, like filters and aggregations, directly to Notion 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 Notion data using native Birst data types.
Configure a JDBC Connection to Notion 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.
- Create a new project in Birst.
- Name the connection (e.g. CDataAPI).
- Choose Live Access.
- Select an agent.
- Set Database Type to Other.
- Set SQL Type to MSSQL
- Set the Connection string.
Start by setting the Profile connection property to the location of the Notion Profile on disk (e.g. C:\profiles\Notion.apip). Next, set the ProfileSettings connection property to the connection string for Notion (see below).
Notion API Profile Settings
Go to https://www.notion.so/my-integrations, create an internal integration, configure the name and workspace, then copy the Internal Integration Token from the Secrets section.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Notion 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.
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 Notion:
jdbc:api:Profile=C:\profiles\Notion.apip;ProfileSettings='APIKey=your_integration_token';
- Set the Driver Name: cdata.jdbc.api.APIDriver and click Save.
NOTE: Since authentication to Notion is managed from the connection string, you can leave Security Credentials blank.
Configure Notion 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.
- Select the Schema (e.g. API).
- Click on Tables and/or Views to connect to those entities and click Apply.
- 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.
- Select the Visualizer tool from the menu.
- Select Measures & Categories from your objects
- 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 Notion data. Download a free, 30-day trial and start building Birst visualizations today.