Mailchimp Connector Reference

64 metrics85 dimensions

Fields

http://connectors.windsor.ai/mailchimp?fields=abuse_reports,campaign_id,campaign_title,campaign_type,click_rate,clicks_total,date,emails_sent,forwards_count,forwards_opens,last_click,last_open,list_id,list_is_active,list_name,open_rate,opens_total,preview_text,rss_last_send,send_time,subject_line,unique_clicks,unique_opens,unique_subscriber_clicks&api_key=[your API key]&date_preset=last_7d

The Mailchimp connector lets you pull Mailchimp campaign and URL performance data. An example for querying campaign reports can be found above. If you specify the fields date_from and date_to it will query the data for absolute date ranges.

The Mailchimp connector exposes 149 fields (64 metrics, 85 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.

Mailchimp Fields

Mailchimp Accounts fields

The Accounts report of the Mailchimp connector includes 3 fields.

ID	Type	Name	Description
account_id	TEXT	Account ID	Account ID.
account_name	TEXT	Account Name	Account name.
data_center	TEXT	Data Center	The data center of the account.

Mailchimp Automation Emails fields

The Automation Emails report of the Mailchimp connector includes 15 fields.

ID	Type	Name	Description
automation_email_archive_url	TEXT	Automation Email Archive URL	The URL of the automation email's public archive page.
automation_email_click_rate	PERCENT	Automation Email Click Rate	The number of subscriber clicks divided by the total number of emails sent for the automation email (bounce data is not available for automations).
automation_email_clicks	NUMERIC	Automation Email Clicks	The total number of clicks for the automation email.
automation_email_emails_sent	NUMERIC	Automation Email Emails Sent	The total number of emails sent for the automation email.
automation_email_id	TEXT	Automation Email ID	A string that uniquely identifies the email within the automation workflow.
automation_email_open_rate	PERCENT	Automation Email Open Rate	The number of unique opens divided by the total number of emails sent for the automation email (bounce data is not available for automations).
automation_email_opens	NUMERIC	Automation Email Opens	The total number of opens for the automation email.
automation_email_position	NUMERIC	Automation Email Position	The position of the email in the automation workflow.
automation_email_send_time	TIMESTAMP	Automation Email Send Time	The date and time the automation email was sent.
automation_email_status	TEXT	Automation Email Status	The current status of the automation email.
automation_email_subject_line	TEXT	Automation Email Subject Line	The subject line of the automation email.
automation_email_subscriber_clicks	NUMERIC	Automation Email Subscriber Clicks	The total number of subscribers who clicked in the automation email.
automation_email_title	TEXT	Automation Email Title	The title of the automation email.
automation_email_unique_opens	NUMERIC	Automation Email Unique Opens	The total number of unique opens for the automation email.
automation_email_workflow_id	TEXT	Automation Email Workflow ID	A string that uniquely identifies the automation workflow the email belongs to.

Mailchimp Automations fields

The Automations report of the Mailchimp connector includes 12 fields.

ID	Type	Name	Description
automation_create_time	TIMESTAMP	Automation Create Time	The date and time the automation was created.
automation_emails_sent	NUMERIC	Automation Emails Sent	The total number of emails sent for the automation.
automation_id	TEXT	Automation ID	A string that uniquely identifies this automation.
automation_recipients_list_id	TEXT	Automation List ID	The unique list id the automation sends to.
automation_report_summary_click_rate	PERCENT	Automation Click Rate	The number of subscriber clicks divided by the total number of emails sent.
automation_report_summary_clicks	NUMERIC	Automation Clicks	The total number of clicks for the automation.
automation_report_summary_open_rate	PERCENT	Automation Open Rate	The number of unique opens divided by the total number of emails sent.
automation_report_summary_opens	NUMERIC	Automation Opens	The total number of opens for the automation.
automation_report_summary_subscriber_clicks	NUMERIC	Automation Subscriber Clicks	The total number of subscribers who clicked in the automation.
automation_report_summary_unique_opens	NUMERIC	Automation Unique Opens	The total number of unique opens for the automation.
automation_settings_title	TEXT	Automation Title	The title of the automation.
automation_status	TEXT	Automation Status	The current status of the automation (save, paused, or sending).

Mailchimp Campaigns fields

The Campaigns report of the Mailchimp connector includes 4 fields.

ID	Type	Name	Description
campaign_archive_url	TEXT	Campaign Archive URL	The shortened URL of the campaign's public archive (VIP) page.
campaign_folder_id	TEXT	Campaign Folder ID	The ID of the folder the campaign is stored in.
campaign_folder_name	TEXT	Campaign Folder Name	The name of the folder the campaign is stored in, resolved from the campaign folders endpoint.
campaign_long_archive_url	TEXT	Campaign Long Archive URL	The original, full-length URL of the campaign's public archive page.

Mailchimp Click Details fields

The Click Details report of the Mailchimp connector includes 8 fields.

ID	Type	Name	Description
url	TEXT	URL	The URL for the link in the campaign.
url_campaign_id	TEXT	Campaign ID (Duplicate)	A string that uniquely identifies this campaign.
url_click_percentage	PERCENT	URL Click Percentage	The percentage of total clicks a link generated for a campaign.
url_id	TEXT	URL ID	The unique id for the link.
url_last_click	TIMESTAMP	URL Last Click	The date and time for the last recorded click for a link.
url_total_clicks	NUMERIC	URL Total Clicks	The number of total clicks for a link.
url_unique_click_percentage	PERCENT	URL Unique Click Percentage	The percentage of unique clicks a link generated for a campaign.
url_unique_clicks	NUMERIC	URL Unique Clicks	Number of unique clicks for a link.

Mailchimp Lists fields

The Lists report of the Mailchimp connector includes 49 fields.

Mailchimp Lists fields (cleaned_count to list_subscribe_url_long)

ID	Type	Name	Description
cleaned_count	NUMERIC	List Cleaned Count	The number of members cleaned from the list.
cleaned_count_since_send	NUMERIC	List Cleaned Count Since Send	The number of members cleaned from the list since the last campaign was sent.
list_avg_sub_rate	NUMERIC	List Average Subscription Rate	The average number of subscriptions per month for the list (not returned if we haven't calculated it yet).
list_avg_sub_rate_non_aggregated	NUMERIC	(Internal) List Average Subscription Rate (Non-Aggregated)	(Internal) The average number of subscriptions per month for the list (not returned if we haven't calculated it yet).
list_avg_unsub_rate	NUMERIC	List Average Unsubscription Rate	The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet).
list_avg_unsub_rate_non_aggregated	NUMERIC	(Internal) List Average Unsubscription Rate (Non-Aggregated)	(Internal) The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet).
list_beamer_address	TEXT	List Beamer Address	The list's Email Beamer address.
list_campaign_count	NUMERIC	List Campaign Count	The number of campaigns in any status that use this list.
list_campaign_defaults_from_email	TEXT	List Campaign Defaults From Email	The default from email for campaigns sent to this list.
list_campaign_defaults_from_name	TEXT	List Campaign Defaults From Name	The default from name for campaigns sent to this list.
list_campaign_defaults_language	TEXT	List Campaign Defaults Language	The default language for this lists's forms.
list_campaign_defaults_subject	TEXT	List Campaign Defaults Subject	The default subject line for campaigns sent to this list.
list_campaign_last_sent	TIMESTAMP	List Campaign Last Sent	The date and time the last campaign was sent to this list. This is updated when a campaign is sent to 10 or more recipients.
list_click_rate	PERCENT	List Click Rate	The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet).
list_click_rate_non_aggregated	PERCENT	(Internal) List Click Rate (Non-Aggregated)	(Internal) The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet).
list_contact_address1	TEXT	List Contact Address 1	The street address for the list contact.
list_contact_address2	TEXT	List Contact Address 2	The street address for the list contact.
list_contact_city	CITY	List Contact City	The city for the list contact.
list_contact_company	TEXT	List Contact Company	The company name for the list.
list_contact_country	COUNTRY	List Contact Country	A two-character ISO3166 country code. Defaults to US if invalid.
list_contact_phone	TEXT	List Contact Phone	The phone number for the list contact.
list_contact_state	TEXT	List Contact State	The state for the list contact.
list_contact_zip	TEXT	List Contact Zip	The postal or zip code for the list contact.
list_created	TIMESTAMP	List Created	The date and time that this list was created.
list_double_opt_in	BOOLEAN	List Double Opt-in	Whether or not to require the subscriber to confirm subscription via email.
list_email_type_option	BOOLEAN	List Email Type Option	Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup.
list_has_welcome	BOOLEAN	List Has Welcome	Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup.
list_id	TEXT	List ID	A string that uniquely identifies this list.
list_last_subscribe	TIMESTAMP	List Last Subscribe	The date and time of the last time someone subscribed to this list.
list_last_unsubscribe	TIMESTAMP	List Last Unsubscribe	The date and time of the last time someone unsubscribed from this list.
list_marketing_permissions	BOOLEAN	List Marketing Permissions	Whether or not the list has marketing permissions (eg. GDPR) enabled.
list_merge_field_count	NUMERIC	List Merge Field Count	The number of merge fields (audience field) for this list (doesn't include EMAIL).
list_name	TEXT	List Name	The name of the list.
list_notify_on_subscribe	TEXT	List Notify On Subscribe	The email address to send subscribe notifications to.
list_notify_on_unsubscribe	TEXT	List Notify On Unsubscribe	The email address to send unsubscribe notifications to.
list_open_rate	PERCENT	List Open Rate	The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet).
list_open_rate_non_aggregated	PERCENT	(Internal) List Open Rate (Non-Aggregated)	(Internal) The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet).
list_permission_reminder	TEXT	List Permission Reminder	The permission reminder for the list.
list_rating	TEXT	List Rating	An auto-generated activity score for the list (0-5).
list_subscribe_url_long	TEXT	List Subscribe URL Long	The full version of this list's subscribe form (host will vary).

Mailchimp Lists fields (list_subscribe_url_short to unsubscribe_count_since_send)

ID	Type	Name	Description
list_subscribe_url_short	TEXT	List Subscribe URL Short	Our url shortened version of this list's subscribe form.
list_target_sub_rate	NUMERIC	List Target Subscription Rate	The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet).
list_total_contacts	NUMERIC	List Total Contacts	The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed.
list_use_archive_bar	BOOLEAN	List Use Archive Bar	Whether campaigns for this list use the Archive Bar in archives by default.
list_web_id	TEXT	List Web ID	The ID used in the Mailchimp web application. View this list in your Mailchimp account at https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}.
member_count	NUMERIC	List Member Count	The number of active members in the list.
member_count_since_send	NUMERIC	List Member Count Since Send	The number of active members in the list since the last campaign was sent.
unsubscribe_count	NUMERIC	List Unsubscribe Count	The number of members who have unsubscribed from the list.
unsubscribe_count_since_send	NUMERIC	List Unsubscribe Count Since Send	The number of members who have unsubscribed since the last campaign was sent.

Mailchimp Reports fields

The Reports report of the Mailchimp connector includes 39 fields.

ID	Type	Name	Description
abuse_reports	NUMERIC	Abuse Reports	The number of abuse reports generated for this campaign.
bounce_rate	PERCENT	Bounce Rate	The number of bounces divided by the total number of emails sent.
bounces	NUMERIC	Bounces	The total number of bounced email addresses.
campaign	TEXT	Campaign	The title of the campaign.
campaign_id	TEXT	Campaign ID	A string that uniquely identifies this campaign.
campaign_title	TEXT	Campaign (Duplicate)	The title of the campaign.
campaign_type	TEXT	Campaign Type	The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto).
click_rate	PERCENT	Click Rate	The number of unique clicks divided by the total number of successful deliveries.
clicks_total	NUMERIC	Clicks Total	The total number of clicks for the campaign.
currency_code	TEXT	Currency Code	Currency code for the campaign's ecommerce revenue.
delivered	NUMERIC	Delivered	The total number of successfully delivered emails.
emails_sent	NUMERIC	Emails Sent	The total number of emails sent for this campaign.
forwards_count	NUMERIC	Forward Count	How many times the campaign has been forwarded.
forwards_opens	NUMERIC	Forwards Opens	How many times the forwarded campaign has been opened.
hard_bounces	NUMERIC	Hard Bounces	The total number of hard bounced email addresses.
last_click	TIMESTAMP	Last Click	The date and time of the last recorded click for the campaign.
last_open	TIMESTAMP	Last Open	The date and time of the last recorded open.
list_is_active	TEXT	List Is Active	The status of the list used, namely if it's deleted or disabled.
open_rate	PERCENT	Open Rate	The number of unique opens divided by the total number of successful deliveries.
open_rate_excluding_mpp	PERCENT	Open Rate (Excl. Apple MPP)	The number of unique opens excluding Apple Mail Privacy Protection divided by the total number of successful deliveries.
opens_total	NUMERIC	Opens Total	The total number of opens for a campaign.
opens_total_excluding_mpp	NUMERIC	Opens Total (Excl. Apple MPP)	The total number of opens for a campaign, excluding opens generated by Apple Mail Privacy Protection.
preview_text	TEXT	Preview Text	The preview text for the campaign.
revenue	NUMERIC	Revenue	Total revenue from the campaign's tracked ecommerce orders.
rss_last_send	TIMESTAMP	RSS Last Send	For RSS campaigns, the date and time of the last send.
send_time	TIMESTAMP	Send Time	The date and time a campaign was sent.
soft_bounces	NUMERIC	Soft Bounces	The total number of soft bounced email addresses.
sub_rate	NUMERIC	Subscription Rate	The average number of subscriptions per month for the list.
sub_rate_non_aggregated	NUMERIC	(Internal) Subscription Rate (Non-Aggregated)	(Internal) The average number of subscriptions per month for the list.
subject_line	TEXT	Subject Line	The subject line for the campaign.
syntax_errors	NUMERIC	Syntax Errors	The total number of addresses that were syntax-related bounces.
total_orders	NUMERIC	Total Orders	Total orders attributed to the campaign.
unique_clicks	NUMERIC	Unique Clicks	The total number of unique clicks for links across a campaign.
unique_opens	NUMERIC	Unique Opens	The total number of unique opens.
unique_opens_excluding_mpp	NUMERIC	Unique Opens (Excl. Apple MPP)	The total number of unique opens, excluding opens generated by Apple Mail Privacy Protection.
unique_subscriber_clicks	NUMERIC	Unique Subscriber Clicks	The total number of subscribers who clicked on a campaign.
unsub_rate	NUMERIC	Unsubscription Rate	The average number of unsubscriptions per month for the list.
unsub_rate_non_aggregated	NUMERIC	(Internal) Unsubscription Rate (Non-Aggregated)	(Internal) The average number of unsubscriptions per month for the list.
unsubscribed	NUMERIC	Unsubscribed	The total number of unsubscribed members for this campaign.

Mailchimp other fields

The Mailchimp connector has 19 fields that do not belong to a named report, or belong to a report with only one or two fields.

ID	Type	Name	Description
data_fetched_at	TIMESTAMP	Data fetched at	UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasource	TEXT	Data Source	The name of the Windsor connector returning the row
date	DATE	Date	The date a campaign was sent.
day_of_month	TEXT	Day of month	Day of the month
month	TEXT	Month	Number of the month
now	TIMESTAMP	Now	Current timestamp
source	TEXT	Source	The name of the Windsor connector returning the row
today	DATE	Today	Today's date
week	TEXT	Week	Week (Sun-Sat).
week_day	TEXT	Day of week and day number	Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_iso	TEXT	Day of week and day number, ISO	Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_iso	TEXT	Week ISO	Week, ISO format (Mon-Sun).
year	TEXT	Year	Year
year_month	TEXT	Yearmonth	Year and month, e.g. 2024\|3
year_month_name	TEXT	Year month name	Year and month with the month name written out, e.g. "Jan 2025".
year_of_week	TEXT	Year of week	The year that contains first day of the week (Sun-Sat).
year_of_week_iso	TEXT	Year of week, ISO	The year that contains first day of the ISO week (Mon-Sun).
year_week	TEXT	Year week	Year and week for US weeks (Sun-Sat), e.g. 2024\|15
year_week_iso	TEXT	Year week ISO	Year and week for ISO weeks (Mon-Sun), e.g. 2024\|20

API Connectors