VOOZH about

URL: https://www.cdata.com/kb/tech/activecampaign-jdbc-datagrip.rst

⇱ Query ActiveCampaign Data in DataGrip


Query ActiveCampaign Data in DataGrip

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a Data Source for ActiveCampaign in DataGrip and use SQL to query live ActiveCampaign data.

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

Create a New Driver Definition for ActiveCampaign

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

  1. In DataGrip, click File -> New > Project and name the project πŸ‘ Creating a new DataGrip project.
  2. In the Database Explorer, click the plus icon () and select Driver. πŸ‘ Adding a new Driver.
  3. In the Driver tab:
    • Set Name to a user-friendly name (e.g. "CData ActiveCampaign 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.activecampaign.jar).
    • Set Class to cdata.jdbc.activecampaign.ActiveCampaign.jar
  4. Click "Apply" then "OK" to save the Connection πŸ‘ A configured Driver (Salesforce is shown).

Configure a Connection to ActiveCampaign

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

    Built-in Connection String Designer

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

     java -jar cdata.jdbc.activecampaign.jar
     

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

    ActiveCampaign supports authenticating with the API Key. To connect to ActiveCampaign, set the following:

    • URL: This can be found in your account on the My Settings page under the Developer tab. For example: https://{yourAccountName}.api-us1.com
    • APIKey: This can be found in your account on the Settings page under the Developer tab. Each user in your ActiveCampaign account has their own unique API key.
    πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  3. Set URL to the connection string, e.g.,
    jdbc:activecampaign:URL=yourUrl;APIKey=yourApiKey
  4. Click "Apply" and "OK" to save the connection string πŸ‘ A configured Data Source (Salesforce is shown).

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

Execute SQL Queries Against ActiveCampaign

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

πŸ‘ Exploring the data (Salesforce is shown.)

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

πŸ‘ Opening a new Query Console.

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

SELECT LastName, Email FROM Contacts WHERE LastName = 'Smith'
πŸ‘ Querying with SQL (Salesforce is shown.)

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

Ready to get started?

Download a free trial of the ActiveCampaign Driver to get started:

 Download Now

Learn more:

πŸ‘ ActiveCampaign Icon
ActiveCampaign JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with ActiveCampaign account data including Accounts, Contacts, Deals, and more!