README.md

tap-campaign-monitor

Author: Connor McArthur ([email protected])

This is a Singer tap that produces JSON-formatted data following the Singer spec.

It:

• Generates a catalog of available data in Campaign Monitor
• Extracts the following resources:
  • Campaigns
  • Campaign Summaries
  • Campaign Opens
  • Campaign Clicks
  • Campaign Unsubscribes
  • Campaign Bounces
  • Campaign Recipients
  • Campaign Email Client Usage
  • Lists
  • List Details
  • List Bounced Subscribers
  • List Active Subscribers
  • List Deleted Subscribers
  • List Unconfirmed Subscribers
  • List Unsubscribed Subscribers

Quick Start

1. Install

git clone [email protected]:fishtown-analytics/tap-campaign-monitor.git
cd tap-campaign-monitor
pip install .

2. Get credentials from Campaign Monitor. You'll need your client ID and an API key.

3. Create the config file.

There is a template you can use at config.example.json, just copy it to config.json in the repo root and insert your client ID and secret.

4. Run the application to generate a catalog.

tap-campaign-monitor -c config.json --discover > catalog.json

5. Select the tables you'd like to replicate

Step 4 creates a file called catalog.json that specifies all the available endpoints and fields. You'll need to open the file and select the ones you'd like to replicate. See the Singer guide on Catalog Format for more information on how tables are selected.

6. Run it!

tap-campaign-monitor -c config.json --properties catalog.json

Gotchas

• If you select any of the campaign_* streams, you MUST select campaigns as well. Likewise for list_* and lists.

---

Copyright © 2018 Stitch