In this tutorial, we will guide you through configuring Generic Extractor for a new API. In our case, MailChimp — an email marketing service.
Even though there already is a MailChimp extractor available in KBC as a component based on Generic Extractor, the MailChimp API is ideal for this tutorial because it is fairly easy to understand and has excellent documentation.
There are a few things you need to do before you start:
Let’s take a closer look at the MailChimp API now. There are plenty of documentation guides available. To explore the API and review what information is in each resource, use, for example, the Playground.
The basic properties of the API are outlined in the Getting Started Guide. The following are the crucial parts for our use-case:
<dc>refers to a data center for your account. The data center is the last part of the API key; if the API key is
c40xxxxxxxxxxxxxxxxxxxxxxxxxxxxx-us13, the root URL is
Now, go straight to the documentation of the Campaign resource. Because you intend to extract data from MailChimp, the only part you are interested in is the Read Method.
The documentation lists the URL (
/campaigns) of the Campaign Resource, and the query string
parameters (these go into the URL), such as
count, etc. It also lists example
requests and responses. The response body is in JSON format and starts like this:
Now you have everything you need to actually start extracting the data. Continue with your Generic Extractor configuration here: