Connect to SendPulse Data in Aqua Data Studio

The CData JDBC Driver for SendPulse integrates SendPulse data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to SendPulse 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 SendPulse 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, SendPulse.
   • 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.

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

     SendPulse API Profile Settings

     Log into your SendPulse account, navigate to Profile > Account Settings > API, and retrieve your API ID and Secret to use as your OAuth Client ID and Secret.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the SendPulse 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\SendPulse.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

   

Query SendPulse Data

You can now query the tables exposed.