Query Aircall Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live Aircall data. This article shows how to establish a connection to Aircall data in DataGrip.

Create a New Driver Definition for Aircall

The steps below describe how to create a new Data Source in DataGrip for Aircall.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Aircall Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Aircall

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Aircall Driver" to create a new Aircall Data Source.
2. In the new window, configure the connection to Aircall with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Aircall 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.

   Start by setting the Profile connection property to the location of the Aircall Profile on disk (e.g. C:\profiles\Aircall.apip). Next, set the ProfileSettings connection property to the connection string for Aircall (see below).

   Aircall API Profile Settings

   In Aircall, go to your company settings and create a new API key to receive an API ID and API token. Combine them as

   APIId:APIToken

   for the APIKey property.
   
3. Set URL to the connection string, e.g.,

   jdbc:api:Profile=C:\profiles\Aircall.apip;ProfileSettings='APIKey=your_api_id:your_api_token';

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Aircall

To browse through the Aircall entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT Id, Direction FROM Calls WHERE Status = 'completed'

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Aircall data in DataGrip. Reach out to our Support Team if you have any questions.