Ready to get started?

Download a free trial of the eBay Analytics Driver to get started:

 Download Now

Learn more:

eBay Analytics Icon eBay Analytics JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with eBay Analytics.

Integrate eBay Analytics Data in the Pentaho Report Designer



Publish reports based on eBay Analytics data in the Pentaho BI tool.

The CData JDBC Driver for eBay Analytics data enables access to live data from dashboards and reports. This article shows how to connect to eBay Analytics data as a JDBC data source and publish reports based on eBay Analytics data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new eBay Analytics connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:ebayanalytics: and is followed by a semicolon-separated list of connection properties.

      You can authenticate to eBay Analytics only via the OAuth 2 authentication method. The eBay Analytics API requires an access token created with the authorization code grant flow to authorize the requests.

      You can follow the guide in the Help documentation for a step by step guide on how to authenticate using the OAuth 2 protocol.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.ebayanalytics.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.

      Below is a typical JDBC URL:

      jdbc:ebayanalytics:OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;InitiateOAuth=GETANDREFRESH
    • Custom Driver Class Name: Enter cdata.jdbc.ebayanalytics.EbayAnalyticsDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add eBay Analytics Data to a Report

You are now ready to create a report with eBay Analytics data.

  1. Add the eBay Analytics source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT ListingName, ClickThroughRate FROM TrafficReportByListing WHERE ListingId = '201284405428'
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the TrafficReportByListing table.
  4. Finally, run the report to see the chart.