This package models Mailchimp data from Fivetran’s connector. It uses data in the format described by this ERD.
The main focus of the package is to transform the ‘recipient’ and ‘activity’ tables into analytics-ready models and use that data to provide aggregate metrics about campaigns, automations, lists, members, and segments.
Modelslink
This package contains transformation models, designed to work simultaneously Mailchimp source package. A dependency on the source package is declared in this package’s packages.yml file, so it will automatically download when you run dbt deps. The primary outputs of this package are described below. Intermediate models are used to create these output models.
| model | description |
|---|---|
| mailchimp__automation_emails | Each record represents an automation email (that make up automations), enriched with click, open, and unsubscribe metrics. This output is enabled if you are using automations. |
| mailchimp__automations | Each record represents an automation in Mailchimp, enriched with click, open, and unsubscribe metrics. This output is enabled if you are using automations. |
| mailchimp__campaign_activities | Each record represents an activity taken in relation to a campaign email, enriched with data about when the campaign was sent and the lag between send and the activity. |
| mailchimp__campaign_recipients | Each record represents the send of a campaign email, enriched with click, open, and unsubscribe metrics. |
| mailchimp__campaigns | Each record represents a campaign in Mailchimp, enriched with click, open, and unsubscribe metrics. |
| mailchimp__lists | Each record represents a list in Mailchimp, enriched with campaign metrics, (optional) automation metrics, and (optional) information about members. |
| mailchimp__members | Each record represents a member in Mailchimp, enriched with campaign metrics and (optional) automation metrics. |
| mailchimp__segments | Each record represents a segment in Mailchimp, enriched with campaign metrics and (optional) automation metrics. This output is enabled if you are using segments. |
Installation Instructionslink
Check dbt Hub for the latest installation instructions, or read the dbt docs for more information on installing packages.
Include in your packages.yml
packages:
- package: fivetran/mailchimp
version: [">=0.6.0", "<0.7.0"]
Package Maintenancelink
The Fivetran team maintaining this package only maintains the latest version. We highly recommend you keep your packages.yml updated with the dbt hub latest version. You may refer to the CHANGELOG and release notes for more information on changes across versions.
Configurationlink
By default, this package looks for your Mailchimp data in the mailchimp schema of your target database. If this is not where your Mailchimp data is, add the following configuration to your dbt_project.yml file:
...
config-version: 2
vars:
mailchimp_schema: your_schema_name
mailchimp_database: your_database_name
Changing the Build Schemalink
By default this package will build the Mailchimp staging models within a schema titled (<target_schema> + _stg_mailchimp) and the Mailchimp final models within a schema titled (<target_schema> + _mailchimp) in your target database. If this is not where you would like your modeled Mailchimp data to be written to, add the following configuration to your dbt_project.yml file:
...
models:
mailchimp:
+schema: my_new_schema_name # leave blank for just the target_schema
mailchimp_source:
+schema: my_new_schema_name # leave blank for just the target_schema
Disabling modelslink
It’s possible that your Mailchimp connector does not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don’t use that functionality in Mailchimp or actively excluded some tables from your syncs. To disable the corresponding functionality in the package, you must add the relevant variables. By default, all variables are assumed to be true. Add variables for only the tables you would like to disable:
...
config-version: 2
vars:
mailchimp_using_automations: false #disable if you do not have the automation_email, automation_email, or automation_recipient_activity tables
mailchimp_using_segments: false #disable if you do not have the segment table
Database Supportlink
This package has been tested on BigQuery, Snowflake, Redshift, and Postgres.
Contributionslink
Additional contributions to this package are very welcome! Please create issues
or open PRs against main. Check out
this post
on the best workflow for contributing to a package.
Resources:link
- Provide feedback on our existing dbt packages or what you’d like to see next
- Have questions or feedback, or need help? Book a time during our office hours here or shoot us an email at solutions@fivetran.com
- Find all of Fivetran’s pre-built dbt packages in our dbt hub
- Learn how to orchestrate your models with Fivetran Transformations for dbt Core™
- Learn more about Fivetran overall in our docs
- Check out Fivetran’s blog
- Learn more about dbt in the dbt docs
- Check out Discourse for commonly asked questions and answers
- Join the chat on Slack for live discussions and support
- Find dbt events near you
- Check out the dbt blog for the latest news on dbt’s development and best practices