Mailchimp

tap-mailchimp from singer-io

Integrated Marketing Platform

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

Available Variants

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
  3. Configure the tap-mailchimp settings using
    meltano config
    :
  4. meltano config tap-mailchimp set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. 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 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.

Request Timeout (request_timeout)

  • Environment variable: TAP_MAILCHIMP_REQUEST_TIMEOUT

Time for which request should wait to get response. Default, 300.

Data Center (dc)

  • Environment variable: TAP_MAILCHIMP_DC

The Mailchimp data center, only requried when using API key auth. E.g. "us14".

Page Size (page_size)

  • Environment variable: TAP_MAILCHIMP_PAGE_SIZE

The request page size, default 1000.

User Agent (user_agent)

  • Environment variable: TAP_MAILCHIMP_USER_AGENT

The user agent to send on every request.

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.

Access Token (access_token)

  • Environment variable: TAP_MAILCHIMP_ACCESS_TOKEN

The access token from the OAuth2 flow.

API Key (api_key)

  • Environment variable: TAP_MAILCHIMP_API_KEY

The Mailchimp API key, if using API key auth instead of OAuth.

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

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api