Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mailchimp

Guide to integrate your Mailchimp with Sprinkle

Pipeline Concepts

Before setting up the Pipeline, learn about Pipeline concepts here

Step by Step Guide

STEP-1: Configure Connection

To learn about Connection, refer here

  • Log into Sprinkle application

  • Navigate to Ingest -> Connections Tab -> New Connection ->

  • Select Mailchimp

  • Provide all the mandatory details

    • Name: Name to identify this connection

  • Connect to Mailchimp

  • Test Connection

  • Create

STEP-2: Configure Pipeline

To learn about Pipeline, refer here

  • Navigate to Ingest -> Pipeline Tab -> Add ->

  • Select Mailchimp

  • Provide the name -> Create

  • Connection Tab:

    • From the drop-down, select the name of connection created in STEP-2

    • Update

STEP-3: Create Dataset

Datasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details

  • Report Type (Required):

    • Automation:

      • Sub-Reports: Select from drop-down

    • Campaigns

    • Conversations

    • Landing_Pages

    • Reports

      • Sub-Reports: Select from drop-down

    • Lists

    • Members

    • Segments

  • Destination Schema (Required) : Data warehouse schema where the table will be ingested into

  • Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<pipelinename>_<tablename>

  • Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.

  • Create

STEP-4: Run and schedule Ingestion

In the Ingestion Jobs tab:

  • Trigger the Job, using Run button

  • To schedule, enable Auto-Run. Change the frequency if needed

Data Feilds

All the datasets can have following fields.

Campaigns

  • id

  • web_id

  • type

  • create_time

  • archive_url

  • long_archive_url

  • status

  • emails_sent

  • send_time

  • content_type

  • needs_block_refresh

  • resendable

  • recipients_list_id

  • recipients_list_is_active

  • recipients_list_name

  • recipients_segment_text

  • recipients_recipient_count

  • settings_subject_line

  • settings_title

  • settings_from_name

  • settings_reply_to

  • settings_use_conversation

  • settings_to_name

  • settings_folder_id

  • settings_authenticate

  • settings_auto_footer

  • settings_inline_css

  • settings_auto_tweet

  • settings_fb_comments

  • settings_timewarp

  • settings_template_id

  • settings_drag_and_drop

  • tracking_opens

  • tracking_html_clicks

  • tracking_text_clicks

  • tracking_goal_tracking

  • tracking_ecomm360

  • tracking_google_analytics

  • tracking_clicktale

  • delivery_status_enabled

  • report_summary_opens

  • report_summary_unique_opens

  • report_summary_open_rate

  • report_summary_clicks

  • report_summary_subscriber_clicks

  • report_summary_click_rate

  • report_summary_ecommerce_total_orders

  • report_summary_ecommerce_total_spent

  • report_summary_ecommerce_total_revenue

  • settings_preview_text

Connected_Sites

  • foreign_id

  • store_id

  • platform

  • domain

  • site_script_url

  • site_script_fragment

  • created_at

  • updated_at

Conversations

  • id

  • message_count

  • campaign_id

  • list_id

  • unread_message

  • from_label

  • from_email

  • subject

  • last_message

  • _links

Automation

Automations

  • id

  • create_time

  • start_time

  • status

  • emails_sent

  • recipients_list_id

  • recipients_list_is_active

  • recipients_list_name

  • settings_title

  • settings_from_name

  • settings_reply_to

  • settings_use_conversation

  • settings_to_name

  • settings_authenticate

  • settings_auto_footer

  • settings_inline_css

  • tracking_opens

  • tracking_html_clicks

  • tracking_text_clicks

  • tracking_goal_tracking

  • tracking_ecomm360

  • tracking_google_analytics

  • tracking_clicktale

  • trigger_settings_workflow_type

  • trigger_settings_workflow_title

  • trigger_settings_runtime_days_0_

  • trigger_settings_runtime_days_1_

  • trigger_settings_runtime_days_2_

  • trigger_settings_runtime_days_3_

  • trigger_settings_runtime_days_4_

  • trigger_settings_runtime_days_5_

  • trigger_settings_runtime_days_6_

  • trigger_settings_runtime_hours_type

  • trigger_settings_workflow_emails_count

  • report_summary_opens

  • report_summary_unique_opens

  • report_summary_open_rate

  • report_summary_clicks

  • report_summary_subscriber_clicks

  • report_summary_click_rate

Automation_Email

  • id

  • web_id

  • workflow_id

  • position

  • delay_type

  • delay_action

  • delay_action_description

  • delay_full_description

  • create_time

  • start_time

  • archive_url

  • status

  • emails_sent

  • send_time

  • content_type

  • needs_block_refresh

  • has_logo_merge_tag

  • recipients_list_id

  • recipients_list_is_active

  • recipients_list_name

  • recipients_segment_text

  • recipients_recipient_count

  • settings_subject_line

  • settings_preview_text

  • settings_title

  • settings_from_name

  • settings_reply_to

  • settings_authenticate

  • settings_auto_footer

  • settings_inline_css

  • settings_auto_tweet

  • settings_fb_comments

  • settings_template_id

  • settings_drag_and_drop

  • tracking_opens

  • tracking_html_clicks

  • tracking_text_clicks

  • tracking_goal_tracking

  • tracking_ecomm360

  • tracking_google_analytics

  • tracking_clicktale

  • trigger_settings_workflow_type

  • trigger_settings_workflow_title

  • trigger_settings_runtime_days_0_

  • trigger_settings_runtime_days_1_

  • trigger_settings_runtime_days_2_

  • trigger_settings_runtime_days_3_

  • trigger_settings_runtime_days_4_

  • trigger_settings_runtime_days_5_

  • trigger_settings_runtime_days_6_

  • trigger_settings_runtime_hours_type

  • trigger_settings_workflow_emails_count

  • report_summary_opens

  • report_summary_unique_opens

  • report_summary_open_rate

  • report_summary_clicks

  • report_summary_subscriber_clicks

  • report_summary_click_rate

Reports

Campaign_Reports

  • id

  • campaign_title

  • type

  • list_id

  • list_is_active

  • list_name

  • subject_line

  • preview_text

  • emails_sent

  • abuse_reports

  • unsubscribed

  • send_time

  • bounces_hard_bounces

  • bounces_soft_bounces

  • bounces_syntax_errors

  • forwards_forwards_count

  • forwards_forwards_opens

  • opens_opens_total

  • opens_unique_opens

  • opens_open_rate

  • opens_last_open

  • clicks_clicks_total

  • clicks_unique_clicks

  • clicks_unique_subscriber_clicks

  • clicks_click_rate

  • clicks_last_click

  • facebook_likes_recipient_likes

  • facebook_likes_unique_likes

  • facebook_likes_facebook_likes

  • list_stats_sub_rate

  • list_stats_unsub_rate

  • list_stats_open_rate

  • list_stats_click_rate

  • timeseries_0__timestamp

  • timeseries_0__emails_sent

  • timeseries_0__unique_opens

  • timeseries_0__recipients_clicks

  • timeseries_1__timestamp

  • timeseries_1__emails_sent

  • timeseries_1__unique_opens

  • timeseries_1__recipients_clicks

  • timeseries_2__timestamp

  • timeseries_2__emails_sent

  • timeseries_2__unique_opens

  • timeseries_2__recipients_clicks

  • timeseries_3__timestamp

  • timeseries_3__emails_sent

  • timeseries_3__unique_opens

  • timeseries_3__recipients_clicks

  • timeseries_4__timestamp

  • timeseries_4__emails_sent

  • timeseries_4__unique_opens

  • timeseries_4__recipients_clicks

  • timeseries_5__timestamp

  • timeseries_5__emails_sent

  • timeseries_5__unique_opens

  • timeseries_5__recipients_clicks

  • timeseries_6__timestamp

  • timeseries_6__emails_sent

  • timeseries_6__unique_opens

  • timeseries_6__recipients_clicks

  • timeseries_7__timestamp

  • timeseries_7__emails_sent

  • timeseries_7__unique_opens

  • timeseries_7__recipients_clicks

  • timeseries_8__timestamp

  • timeseries_8__emails_sent

  • timeseries_8__unique_opens

  • timeseries_8__recipients_clicks

  • timeseries_9__timestamp

  • timeseries_9__emails_sent

  • timeseries_9__unique_opens

  • timeseries_9__recipients_clicks

  • timeseries_10__timestamp

  • timeseries_10__emails_sent

  • timeseries_10__unique_opens

  • timeseries_10__recipients_clicks

  • timeseries_11__timestamp

  • timeseries_11__emails_sent

  • timeseries_11__unique_opens

  • timeseries_11__recipients_clicks

  • timeseries_12__timestamp

  • timeseries_12__emails_sent

  • timeseries_12__unique_opens

  • timeseries_12__recipients_clicks

  • timeseries_13__timestamp

  • timeseries_13__emails_sent

  • timeseries_13__unique_opens

  • timeseries_13__recipients_clicks

  • timeseries_14__timestamp

  • timeseries_14__emails_sent

  • timeseries_14__unique_opens

  • timeseries_14__recipients_clicks

  • timeseries_15__timestamp

  • timeseries_15__emails_sent

  • timeseries_15__unique_opens

  • timeseries_15__recipients_clicks

  • timeseries_16__timestamp

  • timeseries_16__emails_sent

  • timeseries_16__unique_opens

Click_Details

  • id

  • url

  • total_clicks

  • click_percentage

  • unique_clicks

  • unique_click_percentage

  • last_click

  • campaign_id

Email_Activity

  • campaign_id

  • list_id

  • list_is_active

  • email_id

  • email_address

  • activity_0__action

  • activity_0__timestamp

  • activity_0__ip

  • activity_1__action

  • activity_1__timestamp

  • activity_1__ip

  • activity_2__action

  • activity_2__timestamp

  • activity_2__ip

  • activity_3__action

  • activity_3__timestamp

  • activity_3__ip

  • activity_4__action

  • activity_4__timestamp

  • activity_4__ip

  • activity

  • activity_0__type

Sent_To

  • email_id

  • email_address

  • merge_fields_fname

  • merge_fields_lname

  • merge_fields_address_addr1

  • merge_fields_address_addr2

  • merge_fields_address_city

  • merge_fields_address_state

  • merge_fields_address_zip

  • merge_fields_address_country

  • merge_fields_phone

  • merge_fields_birthday

  • vip

  • status

  • open_count

  • last_open

  • absplit_group

  • gmt_offset

  • campaign_id

  • list_id

  • list_is_active

  • merge_fields_address

Unsubscribed

  • email_id

  • email_address

  • merge_fields

  • vip

  • timestamp

  • reason

  • campaign_id

  • list_id

  • list_is_active

  • _links

Landing_Pages

  • id

  • name

  • title

  • description

  • template_id

  • content_type

  • status

  • list_id

  • web_id

  • created_by_source

  • created_at

  • published_at

  • unpublished_at

  • updated_at

  • tracking_track_with_mailchimp

  • tracking_enable_restricted_data_processing

  • url

Lists

  • id

  • web_id

  • name

  • contact

  • permission_reminder

  • use_archive_bar

  • campaign_defaults

  • notify_on_subscribe

  • notify_on_unsubscribe

  • date_created

  • list_rating

  • email_type_option

  • subscribe_url_short

  • subscribe_url_long

  • beamer_address

  • visibility

  • double_optin

  • double_optin

  • marketing_permissions

  • modules

  • stats

  • _links

Members

  • id

  • email_address

  • unique_email_id

  • contact_id

  • full_name

  • web_id

  • email_type

  • status

  • consents_to_one_to_one_messaging

  • merge_fields_fname

  • merge_fields_lname

  • merge_fields_address_addr1

  • merge_fields_address_addr2

  • merge_fields_address_city

  • merge_fields_address_state

  • merge_fields_address_zip

  • merge_fields_address_country

  • merge_fields_phone

  • merge_fields_birthday

  • stats_avg_open_rate

  • stats_avg_click_rate

  • ip_signup

  • timestamp_signup

  • ip_opt

  • timestamp_opt

  • member_rating

  • last_changed

  • language

  • vip

  • email_client

  • location_latitude

  • location_longitude

  • location_gmtoff

  • location_dstoff

  • location_country_code

  • location_timezone

  • location_region

  • source

  • tags_count

  • tags

  • list_id

  • tags_0__id

  • tags_0__name

  • merge_fields_address

Segments

  • id

  • name

  • member_count

  • type

  • created_at

  • updated_at

  • list_id

Last updated