Design BIRT Reports on Unbounce Data



Provide current Unbounce data to your embedded analytics.

The CData JDBC Driver for Unbounce integrates connectivity to Unbounce APIs into your data-driven Java applications. You can use the CData JDBC Driver for Unbounce with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

  1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
  2. Click File -> New -> Report. The Report Design perspective is opened.
  3. In the Data Explorer, right-click Data Sources and click New Data Source.
  4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
  5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
  6. In the Database URL box, enter the JDBC URL containing the connection string.

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

    Unbounce API Profile Settings

    Unbounce uses OAuth to authenticate to your data.

    In order to authenticate to Unbounce, you will first need to register an OAuth application. To do so, go to https://developer.unbounce.com/getting_started/ and complete the Register OAuth Application form.

    After setting the following connection properties, you are ready to connect:

    • AuthScheme: Set this to OAuth.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
    • OAuthClientId: Set this to the Client Id that is specified in your app settings.
    • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
    • CallbackURL: Set this to the Redirect URI you specified in your app settings.

    Built-in Connection String Designer

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

    When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

    A typical JDBC URL is below:

    jdbc:api:Profile=C:\profiles\Unbounce.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH
  7. Right-click the Data Sets folder and select the JDBC data source for Unbounce.
  8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query: SELECT Id, Name FROM Tags WHERE State = 'active'
  9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
  10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
  11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Unbounce data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.

Ready to get started?

Connect to live data from Unbounce with the API Driver

Connect to Unbounce