Mailchimp Connector Reference

64 metrics85 dimensions

 

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.

IDTypeNameDescription
account_idTEXTAccount IDAccount ID.
account_nameTEXTAccount NameAccount name.
data_centerTEXTData CenterThe data center of the account.

Mailchimp Automation Emails fields

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

IDTypeNameDescription
automation_email_archive_urlTEXTAutomation Email Archive URLThe URL of the automation email's public archive page.
automation_email_click_ratePERCENTAutomation Email Click RateThe 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_clicksNUMERICAutomation Email ClicksThe total number of clicks for the automation email.
automation_email_emails_sentNUMERICAutomation Email Emails SentThe total number of emails sent for the automation email.
automation_email_idTEXTAutomation Email IDA string that uniquely identifies the email within the automation workflow.
automation_email_open_ratePERCENTAutomation Email Open RateThe 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_opensNUMERICAutomation Email OpensThe total number of opens for the automation email.
automation_email_positionNUMERICAutomation Email PositionThe position of the email in the automation workflow.
automation_email_send_timeTIMESTAMPAutomation Email Send TimeThe date and time the automation email was sent.
automation_email_statusTEXTAutomation Email StatusThe current status of the automation email.
automation_email_subject_lineTEXTAutomation Email Subject LineThe subject line of the automation email.
automation_email_subscriber_clicksNUMERICAutomation Email Subscriber ClicksThe total number of subscribers who clicked in the automation email.
automation_email_titleTEXTAutomation Email TitleThe title of the automation email.
automation_email_unique_opensNUMERICAutomation Email Unique OpensThe total number of unique opens for the automation email.
automation_email_workflow_idTEXTAutomation Email Workflow IDA string that uniquely identifies the automation workflow the email belongs to.

Mailchimp Automations fields

The Automations report of the Mailchimp connector includes 12 fields.

IDTypeNameDescription
automation_create_timeTIMESTAMPAutomation Create TimeThe date and time the automation was created.
automation_emails_sentNUMERICAutomation Emails SentThe total number of emails sent for the automation.
automation_idTEXTAutomation IDA string that uniquely identifies this automation.
automation_recipients_list_idTEXTAutomation List IDThe unique list id the automation sends to.
automation_report_summary_click_ratePERCENTAutomation Click RateThe number of subscriber clicks divided by the total number of emails sent.
automation_report_summary_clicksNUMERICAutomation ClicksThe total number of clicks for the automation.
automation_report_summary_open_ratePERCENTAutomation Open RateThe number of unique opens divided by the total number of emails sent.
automation_report_summary_opensNUMERICAutomation OpensThe total number of opens for the automation.
automation_report_summary_subscriber_clicksNUMERICAutomation Subscriber ClicksThe total number of subscribers who clicked in the automation.
automation_report_summary_unique_opensNUMERICAutomation Unique OpensThe total number of unique opens for the automation.
automation_settings_titleTEXTAutomation TitleThe title of the automation.
automation_statusTEXTAutomation StatusThe current status of the automation (save, paused, or sending).

Mailchimp Campaigns fields

The Campaigns report of the Mailchimp connector includes 4 fields.

IDTypeNameDescription
campaign_archive_urlTEXTCampaign Archive URLThe shortened URL of the campaign's public archive (VIP) page.
campaign_folder_idTEXTCampaign Folder IDThe ID of the folder the campaign is stored in.
campaign_folder_nameTEXTCampaign Folder NameThe name of the folder the campaign is stored in, resolved from the campaign folders endpoint.
campaign_long_archive_urlTEXTCampaign Long Archive URLThe 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.

IDTypeNameDescription
urlTEXTURLThe URL for the link in the campaign.
url_campaign_idTEXTCampaign ID (Duplicate)A string that uniquely identifies this campaign.
url_click_percentagePERCENTURL Click PercentageThe percentage of total clicks a link generated for a campaign.
url_idTEXTURL IDThe unique id for the link.
url_last_clickTIMESTAMPURL Last ClickThe date and time for the last recorded click for a link.
url_total_clicksNUMERICURL Total ClicksThe number of total clicks for a link.
url_unique_click_percentagePERCENTURL Unique Click PercentageThe percentage of unique clicks a link generated for a campaign.
url_unique_clicksNUMERICURL Unique ClicksNumber 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)

IDTypeNameDescription
cleaned_countNUMERICList Cleaned CountThe number of members cleaned from the list.
cleaned_count_since_sendNUMERICList Cleaned Count Since SendThe number of members cleaned from the list since the last campaign was sent.
list_avg_sub_rateNUMERICList Average Subscription RateThe average number of subscriptions per month for the list (not returned if we haven't calculated it yet).
list_avg_sub_rate_non_aggregatedNUMERIC(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_rateNUMERICList Average Unsubscription RateThe average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet).
list_avg_unsub_rate_non_aggregatedNUMERIC(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_addressTEXTList Beamer AddressThe list's Email Beamer address.
list_campaign_countNUMERICList Campaign CountThe number of campaigns in any status that use this list.
list_campaign_defaults_from_emailTEXTList Campaign Defaults From EmailThe default from email for campaigns sent to this list.
list_campaign_defaults_from_nameTEXTList Campaign Defaults From NameThe default from name for campaigns sent to this list.
list_campaign_defaults_languageTEXTList Campaign Defaults LanguageThe default language for this lists's forms.
list_campaign_defaults_subjectTEXTList Campaign Defaults SubjectThe default subject line for campaigns sent to this list.
list_campaign_last_sentTIMESTAMPList Campaign Last SentThe 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_ratePERCENTList Click RateThe 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_aggregatedPERCENT(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_address1TEXTList Contact Address 1The street address for the list contact.
list_contact_address2TEXTList Contact Address 2The street address for the list contact.
list_contact_cityCITYList Contact CityThe city for the list contact.
list_contact_companyTEXTList Contact CompanyThe company name for the list.
list_contact_countryCOUNTRYList Contact CountryA two-character ISO3166 country code. Defaults to US if invalid.
list_contact_phoneTEXTList Contact PhoneThe phone number for the list contact.
list_contact_stateTEXTList Contact StateThe state for the list contact.
list_contact_zipTEXTList Contact ZipThe postal or zip code for the list contact.
list_createdTIMESTAMPList CreatedThe date and time that this list was created.
list_double_opt_inBOOLEANList Double Opt-inWhether or not to require the subscriber to confirm subscription via email.
list_email_type_optionBOOLEANList Email Type OptionWhether 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_welcomeBOOLEANList Has WelcomeWhether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup.
list_idTEXTList IDA string that uniquely identifies this list.
list_last_subscribeTIMESTAMPList Last SubscribeThe date and time of the last time someone subscribed to this list.
list_last_unsubscribeTIMESTAMPList Last UnsubscribeThe date and time of the last time someone unsubscribed from this list.
list_marketing_permissionsBOOLEANList Marketing PermissionsWhether or not the list has marketing permissions (eg. GDPR) enabled.
list_merge_field_countNUMERICList Merge Field CountThe number of merge fields (audience field) for this list (doesn't include EMAIL).
list_nameTEXTList NameThe name of the list.
list_notify_on_subscribeTEXTList Notify On SubscribeThe email address to send subscribe notifications to.
list_notify_on_unsubscribeTEXTList Notify On UnsubscribeThe email address to send unsubscribe notifications to.
list_open_ratePERCENTList Open RateThe 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_aggregatedPERCENT(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_reminderTEXTList Permission ReminderThe permission reminder for the list.
list_ratingTEXTList RatingAn auto-generated activity score for the list (0-5).
list_subscribe_url_longTEXTList Subscribe URL LongThe full version of this list's subscribe form (host will vary).

Mailchimp Lists fields (list_subscribe_url_short to unsubscribe_count_since_send)

IDTypeNameDescription
list_subscribe_url_shortTEXTList Subscribe URL ShortOur url shortened version of this list's subscribe form.
list_target_sub_rateNUMERICList Target Subscription RateThe target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet).
list_total_contactsNUMERICList Total ContactsThe number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed.
list_use_archive_barBOOLEANList Use Archive BarWhether campaigns for this list use the Archive Bar in archives by default.
list_web_idTEXTList Web IDThe 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_countNUMERICList Member CountThe number of active members in the list.
member_count_since_sendNUMERICList Member Count Since SendThe number of active members in the list since the last campaign was sent.
unsubscribe_countNUMERICList Unsubscribe CountThe number of members who have unsubscribed from the list.
unsubscribe_count_since_sendNUMERICList Unsubscribe Count Since SendThe 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.

IDTypeNameDescription
abuse_reportsNUMERICAbuse ReportsThe number of abuse reports generated for this campaign.
bounce_ratePERCENTBounce RateThe number of bounces divided by the total number of emails sent.
bouncesNUMERICBouncesThe total number of bounced email addresses.
campaignTEXTCampaignThe title of the campaign.
campaign_idTEXTCampaign IDA string that uniquely identifies this campaign.
campaign_titleTEXTCampaign (Duplicate)The title of the campaign.
campaign_typeTEXTCampaign TypeThe type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto).
click_ratePERCENTClick RateThe number of unique clicks divided by the total number of successful deliveries.
clicks_totalNUMERICClicks TotalThe total number of clicks for the campaign.
currency_codeTEXTCurrency CodeCurrency code for the campaign's ecommerce revenue.
deliveredNUMERICDeliveredThe total number of successfully delivered emails.
emails_sentNUMERICEmails SentThe total number of emails sent for this campaign.
forwards_countNUMERICForward CountHow many times the campaign has been forwarded.
forwards_opensNUMERICForwards OpensHow many times the forwarded campaign has been opened.
hard_bouncesNUMERICHard BouncesThe total number of hard bounced email addresses.
last_clickTIMESTAMPLast ClickThe date and time of the last recorded click for the campaign.
last_openTIMESTAMPLast OpenThe date and time of the last recorded open.
list_is_activeTEXTList Is ActiveThe status of the list used, namely if it's deleted or disabled.
open_ratePERCENTOpen RateThe number of unique opens divided by the total number of successful deliveries.
open_rate_excluding_mppPERCENTOpen Rate (Excl. Apple MPP)The number of unique opens excluding Apple Mail Privacy Protection divided by the total number of successful deliveries.
opens_totalNUMERICOpens TotalThe total number of opens for a campaign.
opens_total_excluding_mppNUMERICOpens Total (Excl. Apple MPP)The total number of opens for a campaign, excluding opens generated by Apple Mail Privacy Protection.
preview_textTEXTPreview TextThe preview text for the campaign.
revenueNUMERICRevenueTotal revenue from the campaign's tracked ecommerce orders.
rss_last_sendTIMESTAMPRSS Last SendFor RSS campaigns, the date and time of the last send.
send_timeTIMESTAMPSend TimeThe date and time a campaign was sent.
soft_bouncesNUMERICSoft BouncesThe total number of soft bounced email addresses.
sub_rateNUMERICSubscription RateThe average number of subscriptions per month for the list.
sub_rate_non_aggregatedNUMERIC(Internal) Subscription Rate (Non-Aggregated)(Internal) The average number of subscriptions per month for the list.
subject_lineTEXTSubject LineThe subject line for the campaign.
syntax_errorsNUMERICSyntax ErrorsThe total number of addresses that were syntax-related bounces.
total_ordersNUMERICTotal OrdersTotal orders attributed to the campaign.
unique_clicksNUMERICUnique ClicksThe total number of unique clicks for links across a campaign.
unique_opensNUMERICUnique OpensThe total number of unique opens.
unique_opens_excluding_mppNUMERICUnique Opens (Excl. Apple MPP)The total number of unique opens, excluding opens generated by Apple Mail Privacy Protection.
unique_subscriber_clicksNUMERICUnique Subscriber ClicksThe total number of subscribers who clicked on a campaign.
unsub_rateNUMERICUnsubscription RateThe average number of unsubscriptions per month for the list.
unsub_rate_non_aggregatedNUMERIC(Internal) Unsubscription Rate (Non-Aggregated)(Internal) The average number of unsubscriptions per month for the list.
unsubscribedNUMERICUnsubscribedThe 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.

IDTypeNameDescription
data_fetched_atTIMESTAMPData fetched atUTC 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.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateThe date a campaign was sent.
day_of_monthTEXTDay of monthDay of the month
monthTEXTMonthNumber of the month
nowTIMESTAMPNowCurrent timestamp
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20