Analyze Gumroad Data in R via ODBC

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create data visualizations and use high-performance statistical functions to analyze Gumroad data in Microsoft R Open.

Access Gumroad data with pure R script and standard SQL. You can use the CData ODBC Driver for Gumroad and the RODBC package to work with remote Gumroad data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Gumroad data and visualize Gumroad data in R.

Install R

You can complement the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open (MRO).

Connect to Gumroad as an ODBC Data Source

Information for connecting to Gumroad follows, along with different instructions for configuring a DSN in Windows and Linux environments.

Using OAuth Authentication

To authenticate to Gumroad and connect to your own data or to allow other users to connect to their data, you can use the OAuth 2.0 standard. This is the recommended authentication method.

First you need to register an OAuth application with Gumroad. You can create an OAuth application by visiting your Gumroad account settings at https://app.gumroad.com/settings/advanced and navigating to the Applications section.

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

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Gumroad will automatically walk through the OAuth process in order to obtain the access token.
  • OAuthClientID: Set this to the client_id that is specified in your app settings.
  • OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.

Example connection string

Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

When you configure the DSN, 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.

Windows

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Linux

If you are installing the CData ODBC Driver for Gumroad in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData API Source]
Driver = CData ODBC Driver for Gumroad
Description = My Description
Profile = C:\profiles\Gumroad.apip
AuthScheme = OAuth
InitiateOAuth = GETANDREFRESH
OAuthClientId = your_client_id
OAuthClientSecret = your_client_secret
CallbackUrl = your_callback_url

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Load the RODBC Package

To use the driver, download the RODBC package. In RStudio, click Tools -> Install Packages and enter RODBC in the Packages box.

After installing the RODBC package, the following line loads the package:

library(RODBC)

Note: This article uses RODBC version 1.3-12. Using Microsoft R Open, you can test with the same version, using the checkpoint capabilities of Microsoft's MRAN repository. The checkpoint command enables you to install packages from a snapshot of the CRAN repository, hosted on the MRAN repository. The snapshot taken Jan. 1, 2016 contains version 1.3-12.

library(checkpoint)
checkpoint("2016-01-01")

Connect to Gumroad Data as an ODBC Data Source

You can connect to a DSN in R with the following line:

conn <- odbcConnect("CData API Source")

Schema Discovery

The driver models Gumroad APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

sqlTables(conn)

Execute SQL Queries

Use the sqlQuery function to execute any SQL query supported by the Gumroad API.

customfields <- sqlQuery(conn, "SELECT ,  FROM CustomFields WHERE ProductId = 'prod_abc123xyz'", believeNRows=FALSE, rows_at_time=1)

You can view the results in a data viewer window with the following command:

View(customfields)

Plot Gumroad Data

You can now analyze Gumroad data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2))
barplot(customfields$, main="Gumroad CustomFields", names.arg = customfields$, horiz=TRUE)

Ready to get started?

Connect to live data from Gumroad with the API Driver

Connect to Gumroad