How to integrate Metabase with JSON Services

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to live JSON services and create an interactive dashboard in Metabase from JSON services.

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live JSON services. This article describes how to connect to JSON and build a simple visualization using JSON services.

CData Connect provides a pure cloud-to-cloud interface for JSON, allowing you to easily integrate with live JSON services in Metabase — without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to JSON, leveraging server-side processing to quickly return JSON services.

Configure JSON Connectivity for Metabase

Connectivity to JSON from Metabase is made possible through CData Connect AI. To work with JSON services from Metabase, we start by creating and configuring a JSON connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. Select "JSON" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to JSON.

    See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

    After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

    The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

    • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
    • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
    • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

    See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

  4. Click Save & Test
  5. Navigate to the Permissions tab in the Add JSON Connection page and update the User-based 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.
  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 JSON services from Metabase.

Connect to CData Connect AI from Metabase

After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.

  1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab
  2. Configure the connection to Connect AI and click "Save"
    • Database type: Select "SQL Server"
    • Name: Name the connection (e.g. "JSON (Connect AI)")
    • Host: tds.cdata.com
    • Port: 14333
    • Database name: The name of the connection you just created (e.g. JSON1)
    • Username: A Connect AI username (e.g. [email protected])
    • Password: The PAT previously created
    • Click to Use a secure connection (SSL)

Execute JSON Services with Metabase

Once you configure the connection to Connect AI, you can query JSON and build visualizations.

  1. Use the "Write SQL" tool to retrieve the JSON services
  2. Write a SQL query based on the JSON connection in CData Connect AI, e.g.

    SELECT [people].[personal.age] AS age, [people].[personal.gender] AS gender, [people].[personal.name.first] AS first_name, [people].[personal.name.last] AS last_name, [vehicles].[model], FROM [people] JOIN [vehicles] ON [people].[_id] = [vehicles].[people_id]
  3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization

More Information & Free Trial

At this point, you have built a simple visualization from JSON services in Metabase. You can continue to work with live JSON services in Metabase just like you would any SQL Server database. For more information on creating a live connection to JSON (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live JSON services in Metabase today.

Ready to get started?

Learn more about CData Connect AI or sign up for free trial access:

Free Trial