{"id":22793243,"url":"https://github.com/fivetran/dbt_mailchimp","last_synced_at":"2025-04-16T18:48:58.104Z","repository":{"id":43452177,"uuid":"255745202","full_name":"fivetran/dbt_mailchimp","owner":"fivetran","description":"Fivetran's Mailchimp dbt package","archived":false,"fork":false,"pushed_at":"2025-01-22T00:35:51.000Z","size":1781,"stargazers_count":3,"open_issues_count":2,"forks_count":5,"subscribers_count":42,"default_branch":"main","last_synced_at":"2025-03-29T05:33:06.641Z","etag":null,"topics":["dbt","dbt-packages","fivetran","mailchimp"],"latest_commit_sha":null,"homepage":"https://fivetran.github.io/dbt_mailchimp/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fivetran.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-14T22:47:34.000Z","updated_at":"2025-01-22T00:35:55.000Z","dependencies_parsed_at":"2024-08-28T17:12:37.924Z","dependency_job_id":"7245caae-dae0-4399-ae1a-57ebe23f12f4","html_url":"https://github.com/fivetran/dbt_mailchimp","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivetran%2Fdbt_mailchimp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivetran%2Fdbt_mailchimp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivetran%2Fdbt_mailchimp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivetran%2Fdbt_mailchimp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fivetran","download_url":"https://codeload.github.com/fivetran/dbt_mailchimp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249266477,"owners_count":21240762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dbt","dbt-packages","fivetran","mailchimp"],"created_at":"2024-12-12T03:18:45.181Z","updated_at":"2025-04-16T18:48:58.097Z","avatar_url":"https://github.com/fivetran.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mailchimp Transformation dbt Package ([Docs](https://fivetran.github.io/dbt_mailchimp/))\n\n\u003cp align=\"left\"\u003e\n    \u003ca alt=\"License\"\n        href=\"https://github.com/fivetran/dbt_mailchimp/blob/main/LICENSE\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\" /\u003e\u003c/a\u003e\n    \u003ca alt=\"dbt-core\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/dbt_Core™_version-\u003e=1.3.0_\u003c2.0.0-orange.svg\" /\u003e\u003c/a\u003e\n    \u003ca alt=\"Maintained?\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Maintained%3F-yes-green.svg\" /\u003e\u003c/a\u003e\n    \u003ca alt=\"PRs\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Contributions-welcome-blueviolet\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## What does this dbt package do?\n- Produces modeled tables that leverage Mailchimp data from [Fivetran's connector](https://fivetran.com/docs/applications/mailchimp) in the format described by [this ERD](https://fivetran.com/docs/applications/mailchimp#schemainformation) and builds off the output of our [Mailchimp source package](https://github.com/fivetran/dbt_mailchimp_source).\n- Transforms the 'recipient' and 'activity' tables into analytics-ready models and use that data to provide aggregate metrics about campaigns, automations, lists, members, and segments.\n\n\u003c!--section=\"mailchimp_transformation_model--\u003e\n- Generates a comprehensive data dictionary of your source and modeled Mailchimp data through the [dbt docs site](https://fivetran.github.io/dbt_mailchimp/#!/overview).\nThe following table provides a detailed list of all tables materialized within this package by default.\n\u003e TIP: See more details about these tables in the package's [dbt docs site](https://fivetran.github.io/dbt_mailchimp/#!/overview?g_v=1).\n\n| **Table**                | **Description**                                                                                                                                |\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [mailchimp__automations_activities](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.mailchimp__automations_activities)       | Each record represents an activity taken in relation to a automation email. |\n| [mailchimp__automation_emails](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.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.       |\n| [mailchimp__automations](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.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.                            |\n| [mailchimp__campaign_activities](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.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. |\n| [mailchimp__campaign_recipients](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.mailchimp__campaign_recipients) | Each record represents the send of a campaign email, enriched with click, open, and unsubscribe metrics.                                                                  |\n| [mailchimp__campaigns](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.mailchimp__campaigns)          | Each record represents a campaign in Mailchimp, enriched with click, open, and unsubscribe metrics.                                                                       |\n| [mailchimp__lists](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.mailchimp__lists)             | Each record represents a list in Mailchimp, enriched with campaign metrics, (optional) automation metrics, and (optional) information about members.                               |\n| [mailchimp__members](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.mailchimp__members)           | Each record represents a member in Mailchimp, enriched with campaign metrics and (optional) automation metrics.                                                        |\n| [mailchimp__segments](https://fivetran.github.io/dbt_mailchimp/#!/model/model.mailchimp.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.                  |\n\n### Materialized Models\nEach Quickstart transformation job run materializes 33 models if all components of this data model are enabled. This count includes all staging, intermediate, and final models materialized as `view`, `table`, or `incremental`.\n\u003c!--section-end--\u003e\n\n## How do I use the dbt package?\n\n### Step 1: Prerequisites\nTo use this dbt package, you must have the following:\n\n- At least one Fivetran Mailchimp connection syncing data into your destination.\n- A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination.\n\n### Step 2: Install the package\nInclude the following mailchimp package version in your `packages.yml` file:\n\u003e TIP: Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages.\n```yaml\npackages:\n  - package: fivetran/mailchimp\n    version: [\"\u003e=0.10.0\", \"\u003c0.11.0\"] # we recommend using ranges to capture non-breaking changes automatically\n```\nDo **NOT** include the `mailchimp_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.\n\n#### Databricks dispatch configuration\nIf you are using a Databricks destination with this package, you must add the following (or a variation of the following) dispatch configuration within your `dbt_project.yml`. This is required in order for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages respectively.\n```yml\ndispatch:\n  - macro_namespace: dbt_utils\n    search_order: ['spark_utils', 'dbt_utils']\n\n## Step 3: Define database and schema variables\nBy default, this package runs using your destination and the `mailchimp` schema. If this is not where your Mailchimp data is (for example, if your Mailchimp schema is named `mailchimp_fivetran`), add the following configuration to your root `dbt_project.yml` file:\n\n```yml\nvars:\n    mailchimp_schema: your_schema_name\n    mailchimp_database: your_database_name\n```\n\n## Step 4: Disable models for non-existent sources\nYour Mailchimp connection might 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 have actively excluded some tables from your syncs. To disable the corresponding functionality in the package, you must set the relevant config variables to `false`. By default, all variables are set to `true`. Alter variables for only the tables you want to disable: \n\n```yml\nvars:\n  mailchimp_using_automations: false # disable if you do not have the automation_email, automation_email, or automation_recipient_activity tables\n  mailchimp_using_segments: false # disable if you do not have the segment table\n  mailchimp_using_unsubscribes: false #disable if you do not have the unsubscribe table\n```\n\n## (Optional) Step 5: Additional configurations\n\u003cdetails open\u003e\u003csummary\u003eExpand/collapse configurations\u003c/summary\u003e\n\n### Changing the Build Schema\nBy default this package will build the Mailchimp staging models within a schema titled (\u003ctarget_schema\u003e + `_stg_mailchimp`) and the Mailchimp final models within a schema titled (\u003ctarget_schema\u003e + `_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:\n\n```yml\nmodels:\n  mailchimp:\n    +schema: my_new_schema_name # leave blank for just the target_schema\n  mailchimp_source:\n    +schema: my_new_schema_name # leave blank for just the target_schema\n\n```\n\n### Change the source table references\nIf an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:\n\n\u003e IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_mailchimp_source/blob/main/dbt_project.yml) variable declarations to see the expected names.\n\n```yml\nvars:\n    mailchimp_\u003cdefault_source_table_name\u003e_identifier: your_table_name \n```\n\u003c/details\u003e\n\n## (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™\n\u003cdetails\u003e\u003csummary\u003eExpand for details\u003c/summary\u003e\n\u003cbr\u003e\n    \nFivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core setup guides](https://fivetran.com/docs/transformations/dbt#setupguide).\n\u003c/details\u003e\n\n# 🔍 Does this package have dependencies?\nThis dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site.\n\u003e IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts.\n    \n```yml\npackages:\n    - package: fivetran/fivetran_utils\n      version: [\"\u003e=0.4.0\", \"\u003c0.5.0\"]\n\n    - package: dbt-labs/dbt_utils\n      version: [\"\u003e=1.0.0\", \"\u003c2.0.0\"]\n\n    - package: fivetran/mailchip_source\n      version: [\"\u003e=0.6.0\", \"\u003c0.7.0\"]\n```\n\n# 🙌 How is this package maintained and can I contribute?\n## Package Maintenance\nThe Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/mailchimp/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_mailchimp/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.\n\n## Contributions\nA small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions! \n\nWe highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) on the best workflow for contributing to a package!\n\n# 🏪 Are there any resources available?\n- If you have questions or want to reach out for help, see the [GitHub Issue](https://github.com/fivetran/dbt_mailchimp/issues/new/choose) section to find the right avenue of support for you.\n- If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffivetran%2Fdbt_mailchimp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffivetran%2Fdbt_mailchimp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffivetran%2Fdbt_mailchimp/lists"}