This integration is powered by Singer's MailChimp tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
MailChimp integration summary
Stitch’s MailChimp integration replicates data using the MailChimp API 3.0. Refer to the Schema section for a list of objects available for replication.
MailChimp feature snapshot
A high-level look at Stitch's MailChimp (v1) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on March 9, 2020 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting MailChimp
MailChimp setup requirements
To set up MailChimp in Stitch, you need:
-
To verify your access in MailChimp. Stitch will only be able to replicate the same data as the user who authorizes the integration.
If this user has restricted permissions - meaning the user doesn’t have access to all campaigns or lists, for example - Stitch may encounter issues replicating data.
Step 1: Add MailChimp as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the MailChimp icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch MailChimp” would create a schema called
stitch_mailchimpin the destination. Note: Schema names cannot be changed after you save the integration.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your MailChimp integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond MailChimp’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
MailChimp integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch to access MailChimp
- When finished in the Integration Settings page, click the Authorize button. You’ll be prompted to sign into your MailChimp account.
- Sign into your MailChimp account.
- After the authorization process is successfully completed, you’ll be directed back to Stitch.
- Click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For MailChimp integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up MailChimp, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
MailChimp table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the MailChimp integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
automations
The automations table contains summary info about your MailChimp account’s automations. In MailChimp, an automation is a feature that sends a series of emails to subscribers when triggered by a specific date, activity, or event.
|
Full Table |
|
|
Primary Key |
id |
|
Replication Key |
create_time |
| Useful links |
| Join automations with | on |
|---|---|
| campaigns |
automations.recipients.list_id = campaigns.recipients.list_id |
| list_members |
automations.recipients.list_id = list_members.list_id |
| list_segment_members |
automations.recipients.list_id = list_segment_members.list_id |
| list_segments |
automations.recipients.list_id = list_segments.list_id |
| lists |
automations.recipients.list_id = lists.id |
| reports_email_activity |
automations.recipients.list_id = reports_email_activity.list_id |
|
create_time
DATE-TIME |
||||||||||||
|
emails_sent INTEGER |
||||||||||||
|
id
STRING |
||||||||||||
|
recipients OBJECT
|
||||||||||||
|
report_summary OBJECT
|
||||||||||||
|
settings OBJECT
|
||||||||||||
|
start_time DATE-TIME |
||||||||||||
|
status STRING |
||||||||||||
|
tracking OBJECT
|
||||||||||||
|
trigger_settings OBJECT
|
campaigns
The campaigns table contains info about the campaigns in your MailChimp account.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
| Join campaigns with | on |
|---|---|
| reports_email_activity |
campaigns.id = reports_email_activity.campaign_id campaigns.recipients.list_id = reports_email_activity.list_id |
| automations |
campaigns.recipients.list_id = automations.recipients.list_id |
| list_members |
campaigns.recipients.list_id = list_members.list_id |
| list_segment_members |
campaigns.recipients.list_id = list_segment_members.list_id |
| list_segments |
campaigns.recipients.list_id = list_segments.list_id |
| lists |
campaigns.recipients.list_id = lists.id |
|
archive_url STRING |
||||||||||||||||
|
content_type STRING |
||||||||||||||||
|
create_time DATE-TIME |
||||||||||||||||
|
delivery_status OBJECT
|
||||||||||||||||
|
emails_sent INTEGER |
||||||||||||||||
|
has_logo_merge_tag BOOLEAN |
||||||||||||||||
|
id
STRING |
||||||||||||||||
|
long_archive_url STRING |
||||||||||||||||
|
needs_block_refresh BOOLEAN |
||||||||||||||||
|
recipients OBJECT
|
||||||||||||||||
|
report_summary OBJECT
|
||||||||||||||||
|
resendable BOOLEAN |
||||||||||||||||
|
send_time DATE-TIME |
||||||||||||||||
|
settings OBJECT
|
||||||||||||||||
|
social_card OBJECT |
||||||||||||||||
|
status STRING |
||||||||||||||||
|
tracking OBJECT
|
||||||||||||||||
|
type STRING |
||||||||||||||||
|
web_id INTEGER |
list_members
The list_members table contains info about the members in a specific MailChimp list, including currently subscribed, unsubscribed, and bounced members.
|
Key-based Incremental |
|
|
Primary Keys |
id list_id |
|
Replication Key |
last_changed |
| Useful links |
| Join list_members with | on |
|---|---|
| automations |
list_members.list_id = automations.recipients.list_id |
| campaigns |
list_members.list_id = campaigns.recipients.list_id |
| list_segment_members |
list_members.list_id = list_segment_members.list_id |
| list_segments |
list_members.list_id = list_segments.list_id |
| lists |
list_members.list_id = lists.id |
| reports_email_activity |
list_members.list_id = reports_email_activity.list_id |
|
email_address STRING |
||||||
|
email_client STRING |
||||||
|
email_type STRING |
||||||
|
id
STRING |
||||||
|
ip_opt STRING |
||||||
|
ip_signup STRING |
||||||
|
language STRING |
||||||
|
last_changed
DATE-TIME |
||||||
|
list_id
STRING |
||||||
|
location OBJECT
|
||||||
|
member_rating NUMBER |
||||||
|
source STRING |
||||||
|
stats OBJECT
|
||||||
|
status STRING |
||||||
|
tags ARRAY |
||||||
|
tags_count INTEGER |
||||||
|
timestamp_opt DATE-TIME |
||||||
|
timestamp_signup DATE-TIME |
||||||
|
unique_email_id STRING |
||||||
|
unsubscribe_reason STRING |
||||||
|
vip BOOLEAN |
||||||
|
web_id INTEGER |
list_segment_members
The list_segment_members table contains info about members in a saved segment
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
| Join list_segment_members with | on |
|---|---|
| automations |
list_segment_members.list_id = automations.recipients.list_id |
| campaigns |
list_segment_members.list_id = campaigns.recipients.list_id |
| list_members |
list_segment_members.list_id = list_members.list_id |
| list_segments |
list_segment_members.list_id = list_segments.list_id |
| lists |
list_segment_members.list_id = lists.id |
| reports_email_activity |
list_segment_members.list_id = reports_email_activity.list_id |
|
email_address STRING |
||||||
|
email_client STRING |
||||||
|
email_type STRING |
||||||
|
id
STRING |
||||||
|
ip_opt STRING |
||||||
|
ip_signup STRING |
||||||
|
language STRING |
||||||
|
last_changed DATE-TIME |
||||||
|
list_id STRING |
||||||
|
location OBJECT
|
||||||
|
member_rating NUMBER |
||||||
|
stats OBJECT
|
||||||
|
status STRING |
||||||
|
timestamp_opt DATE-TIME |
||||||
|
timestamp_signup STRING |
||||||
|
unique_email_id STRING |
||||||
|
vip BOOLEAN |
list_segments
The list_segments table contains info about the available segments for a specific list.
|
Full Table |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join list_segments with | on |
|---|---|
| automations |
list_segments.list_id = automations.recipients.list_id |
| campaigns |
list_segments.list_id = campaigns.recipients.list_id |
| list_members |
list_segments.list_id = list_members.list_id |
| list_segment_members |
list_segments.list_id = list_segment_members.list_id |
| lists |
list_segments.list_id = lists.id |
| reports_email_activity |
list_segments.list_id = reports_email_activity.list_id |
|
created_at DATE-TIME |
||||||
|
id
STRING |
||||||
|
list_id STRING |
||||||
|
member_count INTEGER |
||||||
|
name STRING |
||||||
|
options OBJECT
|
||||||
|
type STRING |
||||||
|
updated_at
DATE-TIME |
lists
The lists table contains info about all the lists in your MailChimp account. A list is also known as an audience, and is where all contacts are stored and managed in MailChimp.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
| Join lists with | on |
|---|---|
| automations |
lists.id = automations.recipients.list_id |
| campaigns |
lists.id = campaigns.recipients.list_id |
| list_members |
lists.id = list_members.list_id |
| list_segment_members |
lists.id = list_segment_members.list_id |
| list_segments |
lists.id = list_segments.list_id |
| reports_email_activity |
lists.id = reports_email_activity.list_id |
|
beamer_address STRING |
||||||||||||||||
|
campaign_defaults OBJECT
|
||||||||||||||||
|
contact OBJECT
|
||||||||||||||||
|
date_created DATE-TIME |
||||||||||||||||
|
double_optin BOOLEAN |
||||||||||||||||
|
email_type_option BOOLEAN |
||||||||||||||||
|
has_welcome BOOLEAN |
||||||||||||||||
|
id
STRING |
||||||||||||||||
|
list_rating INTEGER |
||||||||||||||||
|
marketing_permissions BOOLEAN |
||||||||||||||||
|
modules ARRAY |
||||||||||||||||
|
name STRING |
||||||||||||||||
|
notify_on_subscribe STRING |
||||||||||||||||
|
notify_on_unsubscribe STRING |
||||||||||||||||
|
permission_reminder STRING |
||||||||||||||||
|
stats OBJECT
|
||||||||||||||||
|
subscribe_url_long STRING |
||||||||||||||||
|
subscribe_url_short STRING |
||||||||||||||||
|
use_archive_bar BOOLEAN |
||||||||||||||||
|
visibility STRING |
||||||||||||||||
|
web_id STRING |
reports_email_activity
The reports_email_activity table contains info about a member’s subscriber activity in a specific campaign.
|
Key-based Incremental |
|
|
Primary Keys |
action campaign_id email_id timestamp |
| Useful links |
| Join reports_email_activity with | on |
|---|---|
| campaigns |
reports_email_activity.campaign_id = campaigns.id reports_email_activity.list_id = campaigns.recipients.list_id |
| automations |
reports_email_activity.list_id = automations.recipients.list_id |
| list_members |
reports_email_activity.list_id = list_members.list_id |
| list_segment_members |
reports_email_activity.list_id = list_segment_members.list_id |
| list_segments |
reports_email_activity.list_id = list_segments.list_id |
| lists |
reports_email_activity.list_id = lists.id |
|
action
STRING |
|
campaign_id
STRING |
|
email_address STRING |
|
email_id
STRING |
|
ip STRING |
|
list_id STRING |
|
list_is_active BOOLEAN |
|
timestamp
DATE-TIME |
|
type STRING |
|
url STRING |
unsubscribes
The unsubscribes table contains info about members who have unsubscribed from a specific campaign.
|
Full Table |
|
|
Primary Keys |
campaign_id email_id |
| Useful links |
|
campaign_id
STRING |
|
email_address STRING |
|
email_id
STRING |
|
list_id STRING |
|
list_is_active BOOLEAN |
|
reason STRING |
|
timestamp DATE-TIME |
|
vip BOOLEAN |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.
description
STRING
image_url
STRING
title
STRING