Learn more
 

Ready to get started?

Connect to live data from ConstantContact with the API Driver

Connect to ConstantContact

In this article

Related articles

Analyze ConstantContact Data in R


Create data visualizations and use high-performance statistical functions to analyze ConstantContact data in Microsoft R Open.

Access ConstantContact data with pure R script and standard SQL. You can use the CData ODBC Driver for ConstantContact and the RODBC package to work with remote ConstantContact 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 ConstantContact data and visualize ConstantContact 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 ConstantContact as an ODBC Data Source

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

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

ConstantContact API Profile Settings

ConstantContact uses OAuth-based authentication.

First, you will need to register an OAuth application with ConstantContact. You can do so from the ConstantContact API Guide (https://v3.developer.constantcontact.com/api_guide/index.html), under "MyApplications" > "New Application". Your Oauth application will be assigned a client id (API Key) and you can generate a client secret (Secret).

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 you app settings.
  • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.

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 ConstantContact 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 ConstantContact Description = My Description Profile = C:\profiles\ConstantContact.apip Authscheme = OAuth 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 ConstantContact 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 ConstantContact 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 ConstantContact API.

contacts <- sqlQuery(conn, "SELECT Id, EmailAddress FROM Contacts WHERE CompanyName = 'Acme, Inc.'", believeNRows=FALSE, rows_at_time=1)

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

View(contacts)

Plot ConstantContact Data

You can now analyze ConstantContact 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(contacts$EmailAddress, main="ConstantContact Contacts", names.arg = contacts$Id, horiz=TRUE)