Connect to Gong Data in Aqua Data Studio

The CData JDBC Driver for Gong integrates Gong data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Gong data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Gong data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Gong.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     To authenticate to Gong, you can use API Key authentication with your Gong API Key and API Secret.

     Authentication

     To authenticate to Gong, you must provide your Gong API Key and API Secret, along with your tenant Domain. These credentials are combined and Base64-encoded to form the Basic authentication header used for all API requests.

     Using API Key Authentication

     To authenticate using an API Key, you need to obtain your API Key and API Secret from your Gong account settings.

     You can then connect by setting the AuthScheme to APIKey and providing your credentials:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Gong API Key.
     • APISecret: Set this to your Gong API Secret.
     • Domain: Set this to your Gong tenant domain (e.g., us-36533.api.gong.io).

     Example connection string

     Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';
     

     Built-in Connection String Designer

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

     A typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';

   

Query Gong Data

You can now query the tables exposed.