Mailchimp

tap-mailchimp (lovepopcards variant)

Integrated Marketing Platform

The tap-mailchimp extractor pulls data from Mailchimp that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-mailchimp extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-mailchimp --variant lovepopcards
  2. Configure the tap-mailchimp settings using 
    meltano config
     : 
    3. meltano config tap-mailchimp set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-mailchimp test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-mailchimp may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-mailchimp settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-mailchimp list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Key (api_key)

  • Environment variable: TAP_MAILCHIMP_API_KEY

MailChimp API key.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set api_key [value]

Count (count)

  • Environment variable: TAP_MAILCHIMP_COUNT

Number of records to fetch at once through the API. Optional, default is 500.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set count [value]

Include Empty Activity (include_empty_activity)

  • Environment variable: TAP_MAILCHIMP_INCLUDE_EMPTY_ACTIVITY

If true, include empty activity when tapping email activity stream. Optional, default is false.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set include_empty_activity [value]

Interests Array (interests_array)

  • Environment variable: TAP_MAILCHIMP_INTERESTS_ARRAY

If true, convert interests to an array rather than an object. This results in a list member interests subtable. Optional, default is true.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set interests_array [value]

Keep Links (keep_links)

  • Environment variable: TAP_MAILCHIMP_KEEP_LINKS

If true, _links from the API response are preserved. These are generally not useful. Optional, default is false.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set keep_links [value]

Lag (lag)

  • Environment variable: TAP_MAILCHIMP_LAG

Lag in days for campaign reporting. Optional, default is 3.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set lag [value]

Max Run Time (max_run_time)

  • Environment variable: TAP_MAILCHIMP_MAX_RUN_TIME

Minutes to run before exiting early. Useful for e.g. hourly jobs. Optional, default is null (no early exit).


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set max_run_time [value]

Merge Fields Array (merge_fields_array)

  • Environment variable: TAP_MAILCHIMP_MERGE_FIELDS_ARRAY

If true, convert merge fields to an array rather than an object. This results in a list member merge fields subtable. Optional, default is true.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set merge_fields_array [value]

Request Timeout (request_timeout)

  • Environment variable: TAP_MAILCHIMP_REQUEST_TIMEOUT

Seconds before request times out. Optional, default is 300 (5 minutes).


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set request_timeout [value]

Start Date (start_date)

  • Environment variable: TAP_MAILCHIMP_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set start_date [value]

Use Email Activity Export (use_email_activity_export)

  • Environment variable: TAP_MAILCHIMP_USE_EMAIL_ACTIVITY_EXPORT

If true, use bulk export for email activity. Default is to fallback to value of use_export.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set use_email_activity_export [value]

Use Export (use_export)

  • Environment variable: TAP_MAILCHIMP_USE_EXPORT

If true, the MailChimp bulk export v1 API is used for list members and email activity. Highly recommended, default is true.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set use_export [value]

Use List Member Export (use_list_member_export)

  • Environment variable: TAP_MAILCHIMP_USE_LIST_MEMBER_EXPORT

If true, use bulk export for list members. Default is to fallback to value of use_export.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set use_list_member_export [value]

User Agent (user_agent)

  • Environment variable: TAP_MAILCHIMP_USER_AGENT

User agent for API requests, recommended.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set user_agent [value]

User Name (user_name)

  • Environment variable: TAP_MAILCHIMP_USER_NAME

MailChimp user name.


Configure this setting directly using the following Meltano command:

meltano config tap-mailchimp set user_name [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-mailchimp extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the 
#plugins-general
channel.

Install

meltano add extractor tap-mailchimp --variant lovepopcards

Maintenance Status

  • Maintenance Status

Repo

https://github.com/lovepopcards/tap-mailchimp
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • lovepop

Keywords

  • api