Mailchimp Connector Objects

This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.
NameDescription
AuthorizedAppsA list of applications authorized to access the account.
AutomationEmailQueuesA summary of the queue for an email in an automation workflow.
AutomationEmailsA summary of the emails in an automation workflow.
AutomationsA summary of the automations within an account.
AutomationsRemovedSubscribersA summary of the subscribers removed from an automation workflow.
CampaignFeedbackA summary of the comment feedback for a specific campaign.
CampaignFoldersFolders for organizing campaigns
CampaignOpenEmailDetailsA list of members who opened the campaign email.
CampaignsA summary of the campaigns within an account.
ConversationMessagesMessages from a specific conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account.
ConversationsA collection of this account’s tracked conversations. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account.
EcommerceCartLinesA list of an ecommerce cart’s lines.
EcommerceCartsA list of an account’s ecommerce carts.
EcommerceCustomersA list of an account’s ecommerce customers.
EcommerceOrderLinesA list of an ecommerce order’s lines.
EcommerceOrdersA list of an account’s ecommerce orders.
EcommerceProductsA list of an account’s ecommerce products.
EcommerceProductVariantsA list of an ecommerce product’s variants.
EcommerceStoresA list of an account’s ecommerce stores.
FileManagerFilesA listing of all avaialable images and files within an account’s gallery.
FileManagerFoldersA listing of all avaialable folders within an account’s gallery.
ListAbuseA collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to ‘report spam’ in their email program.
ListActivityUp to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity.
ListClientsTop email clients used, as measured by their user-agent string
ListGrowthHistoryA month-by-month summary of a specific list’s growth activity.
ListInterestCategoriesA listing of this list’s interest categories.
ListInterestsA list of this category’s interests
ListMemberActivityThe last 50 member events for a list.
ListMemberEventsEvents information for a specific list.
ListMemberNotesThe last 10 notes for a specific list member, based on date created.
ListMembersIndividuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
ListMemberTagsTags assigned to specific members.
ListMergeFieldsThe merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp’s lists and subscriber profiles.
ListsA collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization.
ListSegmentMembersIndividuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
ListSegmentsA list of available segments.
ListSignupFormsCollection of List Signup Forms
ListsWebhooksWebhooks configured for the given list.
ReportAbuseA list of abuse complaints for a specific list.
ReportAdviceA list of feedback based on a campaign’s statistics.
ReportClickDetailsA list of URLs and unique IDs included in HTML and plain-text versions of a campaign.
ReportClickDetailsMembersA collection of members who clicked on a specific link within a campaign.
ReportDomainPerformanceStatistics for the top-performing email domains in a campaign.
ReportEmailActivityA list of member’s subscriber activity in a specific campaign.
ReportLocationsTop open locations for a specific campaign.
ReportsA list of reports containing campaigns marked as Sent.
ReportSentToA list of subscribers who were sent a specific campaign.
ReportUnsubscribesA list of members who have unsubscribed from a specific campaign.
SurveyResponsesList of survey responses.
SurveysGet reports for surveys.
TemplateFoldersFolders for organizing templates
TemplatesA list an account’s available templates.
NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id for this application integration.
NameStringFalseNoThe name of the application.
DescriptionStringFalseNoThe description for the application.
UsersStringFalseNoAn array of usernames of the users who have linked this app.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe MD5 hash of the lowercase version of the list member’s email address.
WorkflowId [KEY]StringFalseNoA string that uniquely identifies an automation workflow.
EmailId [KEY]StringFalseNoA string that uniquely identifies an email in an automation workflow.
ListIdStringTrueLists.IdNoA string that uniquely identifies a list.
EmailAddressStringFalseNoEmail Address
NextSendStringTrueNoNext Send

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that uniquely identifies the automation email.
WorkflowId [KEY]StringTrueNoA string that uniquely identifies an automation workflow.
PositionIntegerTrueNo
Delay_AmountIntegerFalseNoThe delay amount for an automation email.
Delay_TypeStringFalseNoThe type of delay for an automation email.
Delay_DirectionStringFalseNoWhether the delay settings describe before or after the delay action of an automation email.
Delay_ActionStringFalseNoThe action that triggers the delay of an automation emails.
CreateTimeDatetimeTrueNoThe date and time the campaign was created.
StartTimeDatetimeTrueNoThe date and time the campaign was started.
ArchiveUrlStringTrueNoThe link to the campaign’s archive version.
StatusStringTrueNoThe current status of the campaign (‘save’, ‘paused’, ‘sending’).
EmailsSentIntegerTrueNoThe total number of emails sent for this campaign.
SendTimeDatetimeTrueNoThe time and date a campaign was sent.
ContentTypeStringTrueNoHow the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
Recipients_ListIdStringFalseLists.IdNoThe id of the list.
Recipients_SegmentOptsStringFalseNoSegment options.
Settings_SubjectLineStringFalseNoThe subject line for the campaign.
Settings_TitleStringFalseNoThe title of the campaign.
Settings_FromNameStringFalseNoThe ‘from’ name on the campaign (not an email address).
Settings_ReplyToStringFalseNoThe reply-to email address for the campaign.
Settings_AuthenticateBooleanFalseNoWhether or not the campaign was authenticated by MailChimp. Defaults to ‘true’.
Settings_AutoFooterBooleanFalseNoAutomatically append MailChimp’s default footer to the campaign.
Settings_InlineCssBooleanFalseNoAutomatically inline the CSS included with the campaign content.
Settings_AutoTweetBooleanFalseNoAutomatically tweet a link to the campaign archive page when the campaign is sent.
Settings_AutoFbPostStringFalseNoAn array of Facebook page ids (integers) to auto-post to.
Settings_FbCommentsBooleanFalseNoAllows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to ‘true’.
Settings_TemplateIdIntegerFalseTemplates.IdNoThe id for the template used in this campaign.
Settings_DragAndDropBooleanTrueNoWhether the campaign uses the drag-and-drop editor.
Tracking_OpensBooleanFalseNoWhether to track opens. Defaults to ‘true’.
Tracking_HtmlClicksBooleanFalseNoWhether to track clicks in the HTML version of the campaign. Defaults to ‘true’.
Tracking_TextClicksBooleanFalseNoWhether to track clicks in the plain-text version of the campaign. Defaults to ‘true’.
Tracking_GoalTrackingBooleanFalseNoWhether to enable Goal racking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH
Tracking_Ecomm360BooleanFalseNoWhether to enable eCommerce360 tracking.
Tracking_GoogleAnalyticsStringFalseNoThe custom slug for Google Analytics tracking (max of 50 bytes).
Tracking_ClicktaleStringFalseNoThe custom slug for ClickTale Analytics tracking (max of 50 bytes).
Tracking_SalesforceStringFalseNoSalesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
Tracking_HighriseStringFalseNoHighrise tracking options for a campaign. Must be using MailChimp’s built-in Highrise integration.
Tracking_CapsuleStringFalseNoCapsule tracking option sfor a campaign. Must be using MailChimp’s built-in Capsule integration.
SocialCard_ImageUrlStringFalseNoThe url for the header image for the card.
SocialCard_DescriptionStringFalseNoA short summary of the campaign to display.
SocialCard_TitleStringFalseNoThe title for the card. Typically the subject line of the campaign.
TriggerSettings_RuntimeStringFalseNoThe advanced scheduling options for an automation email.
ReportSummaryStringFalseNoFor sent campaigns, a summary of opens, clicks, and unsubscribes.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that identifies this automation.
CreateTimeDatetimeTrueNoThe date and time the automation was created.
StartTimeDatetimeTrueNoThe date and time the automation was started.
StatusStringTrueNoThe current status of the automation (‘save’, ‘paused’, ‘sending’).
EmailsSentIntegerTrueNoThe total number of emails sent for this automation.
Recipients_ListIdStringFalseLists.IdNoThe id of the list.
Recipients_ListNameStringFalseNoList Name
Recipients_SegmentOptsStringFalseNoSegment options.
Settings_TitleStringFalseNoThe title of the automation.
Settings_FromNameStringFalseNoThe ‘from’ name on the automation (not an email address).
Settings_ReplyToStringFalseNoThe reply-to email address for the automation.
Settings_UseConversationBooleanFalseNoUse MailChimp’s Conversations feature to manage out of office replies.
Settings_ToNameStringFalseNoThe automation’s custom ‘to’ name. Typically something like the first name merge var.
Settings_AuthenticateBooleanFalseNoWhether or not the automation is authenticated by MailChimp. Defaults to ‘true’.
Settings_AutoFooterBooleanFalseNoAutomatically append MailChimp’s default footer to the automation.
Settings_InlineCssBooleanFalseNoAutomatically inline the CSS included with the automation content.
Tracking_OpensBooleanFalseNoWhether to track opens. Defaults to ‘true’.
Tracking_HtmlClicksBooleanFalseNoWhether to track clicks in the HTML version of the automation. Defaults to ‘true’.
Tracking_TextClicksBooleanFalseNoWhether to track clicks in the plain-text version of the automation. Defaults to ‘true’.
Tracking_GoalTrackingBooleanFalseNoWhether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH
Tracking_Ecomm360BooleanFalseNoWhether to enable eCommerce360 tracking.
Tracking_GoogleAnalyticsStringFalseNoThe custom slug for Google Analytics tracking (max of 50 bytes).
Tracking_ClicktaleStringFalseNoThe custom slug for ClickTale Analytics tracking (max of 50 bytes).
Tracking_SalesforceStringFalseNoSalesforce tracking options for an automation. Must be using MailChimp’s built-in Salesforce integration.
Tracking_HighriseStringFalseNoHighrise tracking options for an automation. Must be using MailChimp’s built-in Highrise integration.
Tracking_CapsuleStringFalseNoCapsule tracking options for an automation. Must be using MailChimp’s built-in Capsule integration.
TriggerSettingsStringFalseNoA summary of an automation workflow’s trigger settings.
ReportSummaryStringFalseNoA summary of open and click activity for an automation workflow.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe MD5 hash of the lowercase version of the list member’s email address.
WorkflowId [KEY]StringFalseNoA string that uniquely identifies an automation workflow.
ListIdStringTrueLists.IdNoA string that uniquely identifies a list.
EmailAddressStringFalseNoEmail Address

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
FeedbackId [KEY]IntegerTrueNoThe individual id for the feedback item.
ParentIdIntegerTrueNoIf a reply, the id of the parent feedback item.
BlockIdIntegerFalseNoThe block id for the editable block that the feedback addresses.
MessageStringFalseNoThe content of the feedback.
IsCompleteBooleanFalseNoThe status of feedback.
CreatedByStringTrueNoThe login name of the user who created the feedback.
CreatedAtDatetimeTrueNoThe date and time the feedback item was created.
UpdatedAtDatetimeTrueNoThe date and time the feedback was last updated.
SourceStringTrueNoThe source of the feedback (‘email’, ‘sms’, ‘web’, ‘ios’, ‘android’, or ‘api’).
CampaignId [KEY]StringFalseCampaigns.IdNoThe unique id for the campaign.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that uniquely identifieds this campaign folder
NameStringFalseNoThe name of the folder
CountIntegerTrueNoThe number of campaigns in the folder

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CampaignId [KEY]StringTrueNoThe Id for this application integration.
ListId [KEY]StringTrueLists.IdNoThe name of the application.
ListIsActiveBooleanTrueNoThe description for the application.
ContactStatusStringTrueNoAn array of usernames of the users who have linked this app.
EmailId [KEY]StringTrueNoThe description for the application.
EmailAddressStringTrueNoThe description for the application.
MergeFieldsStringTrueNoThe description for the application.
VipBooleanTrueNoThe description for the application.
OpensCountIntegerTrueNoThe description for the application.
OpensStringTrueNoThe description for the application.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that uniquely identifies this campaign.
TypeStringFalseNoThe type of campaign (regular, plaintext, absplit, or rss).
CreateTimeDatetimeTrueNoThe date and time the campaign was created.
ArchiveUrlStringTrueNoThe link to the campaign’s archive version.
LongArchiveUrlStringTrueNoThe original link to the campaign’s archive version.
StatusStringTrueNoThe current status of the campaign (‘save’, ‘paused’, ‘schedule’, ‘sending’, ‘sent’).
EmailsSentIntegerTrueNoThe total number of emails sent for this campaign.
SendTimeDatetimeTrueNoThe time and date a campaign was sent.
ContentTypeStringFalseNoHow the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
Recipients_ListIdStringFalseLists.IdNoThe id of the list.
Recipients_ListNameStringTrueNoThe name of the list.
Recipients_SegmentTextStringFalseNoA string marked-up with HTML explaining the segment used for the campaign in plain English.
Recipients_RecipientCountIntegerTrueNoCount of the recipients on the associated list. Formatted as an integer
Recipients_SegmentOptsStringFalseNoSegment options.
Settings_SubjectLineStringFalseNoThe subject line for the campaign.
Settings_TitleStringFalseNoThe title of the campaign.
Settings_FromNameStringFalseNoThe ‘from’ name on the campaign (not an email address).
Settings_ReplyToStringFalseNoThe reply-to email address for the campaign.
Settings_UseConversationBooleanFalseNoUse MailChimp Conversation feature to manage out of office replies.
Settings_ToNameStringFalseNoThe campaign’s custom ‘to’ name. Typically something like the first name merge var.
Settings_FolderIdStringFalseNoIf the campaign is listed in a folder, the id for that folder.
Settings_AuthenticateBooleanFalseNoWhether or not the campaign was authenticated by MailChimp. Defaults to ‘true’.
Settings_AutoFooterBooleanFalseNoAutomatically append MailChimp’s default footer to the campaign.
Settings_InlineCssBooleanFalseNoAutomatically inline the CSS included with the campaign content.
Settings_AutoTweetBooleanFalseNoAutomatically tweet a link to the campaign archive page when the campaign is sent.
Settings_AutoFbPostStringFalseNoAn array of Facebook page ids to auto-post to.
Settings_FbCommentsBooleanFalseNoAllows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to ‘true’.
Settings_TimewarpBooleanTrueNoSend this campaign using ‘timewarp.’ For more info, see the Knowledge Base article: http://eepurl.com/iAgs
Settings_TemplateIdIntegerFalseTemplates.IdNoThe id for the template used in this campaign.
Settings_DragAndDropBooleanTrueNoWhether the campaign uses the drag-and-drop editor.
VariateSettings_WinningCombinationIdStringTrueNoID of the combination that was chosen as the winner
VariateSettings_WinningCampaignIdStringTrueNoID of the campaign that was sent to the remaining recipients based on the winning combination
VariateSettings_WinnerCriteriaStringFalseNoHow the winning campaign will be chosen
VariateSettings_WaitTimeIntegerFalseNoThe number of minutes to wait before the winning campaign is picked
VariateSettings_TestSizeIntegerFalseNoThe percentage of subscribers to send the test combinations to, from 10 to 100
VariateSettings_SubjectLinesStringFalseNoPossible subject lines
VariateSettings_SendTimesStringFalseNoPossible send times
VariateSettings_FromNamesStringFalseNoPossible from names
VariateSettings_ReplyToAddressesStringFalseNoPossible reply To addresses
VariateSettings_ContentsStringTrueNoDescriptions of possible email contents
VariateSettings_CombinationsStringTrueNoCombinations of possible variables that were used to build emails
Tracking_OpensBooleanFalseNoWhether to track opens. Defaults to ‘true’.
Tracking_HtmlClicksBooleanFalseNoWhether to track clicks in the HTML version of the campaign. Defaults to ‘true’.
Tracking_TextClicksBooleanFalseNoWhether to track clicks in the plain-text version of the campaign. Defaults to ‘true’.
Tracking_GoalTrackingBooleanFalseNoWhether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH
Tracking_Ecomm360BooleanFalseNoWhether to enable eCommerce360 tracking.
Tracking_GoogleAnalyticsStringFalseNoThe custom slug for Google Analytics tracking (max of 50 bytes).
Tracking_ClicktaleStringFalseNoThe custom slug for ClickTale Analytics tracking (max of 50 bytes).
Tracking_SalesforceStringFalseNoSalesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
Tracking_HighriseStringFalseNoHighrise tracking options for a campaign. Must be using MailChimp’s built-in Highrise integration.
Tracking_CapsuleStringFalseNoCapsule tracking option sfor a campaign. Must be using MailChimp’s built-in Capsule integration.
RssOpts_FeedUrlStringFalseNoThe URL for the RSS feed.
RssOpts_FrequencyStringFalseNoThe frequency of the RSS-to-Email campaign (‘daily’, ‘weekly’, ‘monthly’).
RssOpts_ScheduleStringFalseNoThe schedule for sending the RSS campaign.
RssOpts_LastSentStringTrueNoThe date the campaign was last sent.
RssOpts_ConstrainRssImgBooleanFalseNoIf true we will add css to images in the rss feed to constrain their width in the campaign content.
AbSplitOpts_SplitTestStringFalseNoThe type of AB split to run (‘subject’, ‘from_name’, or ‘schedule’).
AbSplitOpts_PickWinnerStringFalseNoHow we should evaluate a winner. Based on ‘opens’, ‘clicks’, or ‘manual’.
AbSplitOpts_WaitUnitsStringFalseNoHow unit of time for measuring the winner (‘hours’ or ‘days’). This cannot be changed after a campaign is sent.
AbSplitOpts_WaitTimeIntegerFalseNoThe amount of time to wait before picking a winner. This cannot be changed after a campaign is sent.
AbSplitOpts_SplitSizeIntegerFalseNoThe size of the split groups. Campaigns split based on ‘schedule’ are forced to have a 50/50 split. Valid split integers are between 1-50. Ex. A 10% split would result in two groups of 10% of the subscribers plus a winner sending to the remaining 80%.
AbSplitOpts_FromNameAStringFalseNoFor campaigns split on ‘From Name’, the name for Group A.
AbSplitOpts_FromNameBStringFalseNoFor campaigns split on ‘From Name’, the name for Group B.
AbSplitOpts_ReplyEmailAStringFalseNoFor campaigns split on ‘From Name’, the reply-to address for Group A.
AbSplitOpts_ReplyEmailBStringFalseNoFor campaigns split on ‘From Name’, the reply-to address for Group B.
AbSplitOpts_SubjectAStringFalseNoFor campaings split on ‘Subject Line’, the subject line for Group A.
AbSplitOpts_SubjectBStringFalseNoFor campaings split on ‘Subject Line’, the subject line for Group B.
AbSplitOpts_SendTimeADatetimeFalseNoThe send time for Group A.
AbSplitOpts_SendTimeBDatetimeFalseNoThe send time for Group B.
AbSplitOpts_SendTimeWinnerDatetimeFalseNoThe send time for the winning version.
SocialCard_ImageUrlStringFalseNoThe url for the header image for the card.
SocialCard_DescriptionStringFalseNoA short summary of the campaign to display.
SocialCard_TitleStringFalseNoThe title for the card. Typically the subject line of the campaign.
ReportSummaryStringFalseNoFor sent campaigns, a summary of opens, clicks, and unsubscribes.
DeliveryStatusStringFalseNoUpdates on campaigns in the process of sending.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that uniquely identifies this message
ConversationId [KEY]StringTrueConversations.IdNoA string that identifies this message’s conversation
ListId [KEY]StringTrueLists.IdNoThe unique identifier of the list this conversation is associated with
FromLabelStringTrueNoA label representing the sender of this message
FromEmailStringFalseNoA label representing the email of the sender of this message
SubjectStringFalseNoThe subject of this message
MessageStringFalseNoThe plain-text content of the message
ReadBooleanFalseNoWhether or not this message has been marked as read
TimestampDatetimeTrueNoDate the message was either sent or received

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that uniquely identifies this conversation
MessageCountIntegerTrueNoThe total number of messages in this conversation
CampaignId [KEY]StringTrueCampaigns.IdNoThe unique identifier of the campaign this conversation is associated with
ListId [KEY]StringTrueNoThe unique identifier of the list this conversation is associated with
UnreadMessagesIntegerTrueNoThe number of unread messages in this conversation
FromLabelStringTrueNoA label representing the sender of this message
FromEmailStringTrueNoA label representing the email of the sender of this message
SubjectStringTrueNoThe subject of the message
LastMessage_FromLabelStringTrueNoA label representing the sender of this message
LastMessage_FromEmailStringTrueNoA label representing the email of the sender of this message
LastMessage_SubjectStringTrueNoThe subject of this message
LastMessage_MessageStringTrueNoThe plain-text content of the message
LastMessage_ReadBooleanFalseNoWhether or not this message has been marked as read
LastMessage_TimestampDatetimeTrueNoDate the message was either sent or received

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StoreId [KEY]StringFalseNoThe StoreId for the table.
CartId [KEY]StringFalseNoThe CartId for the table.
Id [KEY]StringFalseNoA unique identifier for the cart line item.
ProductIdStringFalseNoA unique identifier for the product associated with the cart line item.
ProductTitleStringTrueNoThe name of the product for the cart line item.
ProductVariantIdStringFalseNoA unique identifier for the product variant associated with the cart line item.
ProductVariantTitleStringTrueNoThe name of the product variant for the cart line item.
QuantityIntegerFalseNoThe quantity of a cart line item.
PriceDecimalFalseNoThe price of a cart line item.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StoreId [KEY]StringFalseNoThe StoreId for the table.
Id [KEY]StringFalseNoA unique identifier for the cart.
CustomerStringFalseNoInformation about a specific customer. Carts for existing customers should include only the id parameter in the customer object body.
CampaignIdStringFalseCampaigns.IdNoA string that uniquely identifies the campaign associated with a cart.
CheckoutUrlStringFalseNoThe URL for the cart.
CurrencyCodeStringFalseNoThe three-letter ISO 4217 code for the currency that the cart uses.
OrderTotalDecimalFalseNoThe order total for the cart.
TaxTotalDecimalFalseNoThe total tax for the cart.
LinesStringFalseNoAn array of the cart’s line items. The column will not work for Update. Lines can be updated using EcommerceCartLines table.
CreatedAtDatetimeTrueNoThe date and time when the cart was created.
UpdatedAtDatetimeTrueNoThe date and time when the cart was last updated.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StoreId [KEY]StringFalseNoThe StoreId for the table.
Id [KEY]StringFalseNoA unique identifier for the customer.
EmailAddressStringFalseNoThe customer’s email address.
OptInStatusBooleanFalseNoThe customer’s opt-in status. This value will never overwrite the opt-in status of a pre-existing MailChimp list member, but will apply to list members that are added through the e-commerce API endpoints.
CompanyStringFalseNoThe customer’s company.
FirstNameStringFalseNoThe customer’s first name.
LastNameStringFalseNoThe customer’s last name.
OrdersCountIntegerTrueNoThe customer’s total order count.
TotalSpentDecimalTrueNoThe total amount the customer has spent.
Address_Address1StringFalseNoThe mailing address of the customer.
Address_Address2StringFalseNoAn additional field for the customer’s mailing address.
Address_CityStringFalseNoThe city the customer is located in.
Address_ProvinceStringFalseNoThe customer’s state name or normalized province.
Address_ProvinceCodeStringFalseNoThe two-letter code for the customer’s province or state.
Address_PostalCodeStringFalseNoThe customer’s postal or zip code.
Address_CountryStringFalseNoThe customer’s country.
Address_CountryCodeStringFalseNoThe two-letter code for the customer’s country.
CreatedAtDatetimeTrueNoThe date and time the customer was created.
UpdatedAtDatetimeTrueNoThe date and time the customer was last updated.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StoreId [KEY]StringFalseNoThe StoreId for the table.
OrderId [KEY]StringFalseNoThe OrderId for the table.
Id [KEY]StringFalseNoA unique identifier for the order line item.
ProductIdStringFalseNoA unique identifier for the product associated with the order line item.
ProductTitleStringTrueNoThe name of the product for the order line item.
ProductVariantIdStringFalseNoA unique identifier for the product variant associated with the order line item.
ProductVariantTitleStringTrueNoThe name of the product variant for the order line item.
QuantityIntegerFalseNoThe quantity of an order line item.
PriceDecimalFalseNoThe price of an ecommerce order line item.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StoreId [KEY]StringFalseNoThe StoreId for the table.
Id [KEY]StringFalseNoA unique identifier for the order.
CustomerStringFalseNoInformation about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.
CampaignIdStringFalseCampaigns.IdNoA string that uniquely identifies the campaign associated with an order.
FinancialStatusStringFalseNoThe order status. For example: refunded, processing, cancelled, etc.
FulfillmentStatusStringFalseNoThe fulfillment status for the order. For example: partial, fulfilled, etc.
CurrencyCodeStringFalseNoThe three-letter ISO 4217 code for the currency that the store accepts.
OrderTotalDecimalFalseNoThe order total for the order.
TaxTotalDecimalFalseNoThe tax total for the order.
ShippingTotalDecimalFalseNoThe shipping total for the order.
TrackingCodeStringFalseNoThe MailChimp tracking code for the order. Uses the ‘mc_tc’ parameter in eCommerce360-enabled tracking urls.
ProcessedAtForeignDatetimeFalseNoThe date and time the order was processed.
CancelledAtForeignDatetimeFalseNoThe date and time the order was cancelled.
UpdatedAtForeignDatetimeFalseNoThe date and time the order was updated.
ShippingAddress_NameStringFalseNoThe name associated with an order’s shipping address.
ShippingAddress_Address1StringFalseNoThe shipping address for the order.
ShippingAddress_Address2StringFalseNoAn additional field for the shipping address.
ShippingAddress_CityStringFalseNoThe city in the order’s shipping address.
ShippingAddress_ProvinceStringFalseNoThe state or normalized province in the order’s shipping address.
ShippingAddress_ProvinceCodeStringFalseNoThe two-letter code for the province or state the order’s shipping address is located in.
ShippingAddress_PostalCodeStringFalseNoThe postal or zip code in the order’s shipping address.
ShippingAddress_CountryStringFalseNoThe country in the order’s shipping address.
ShippingAddress_CountryCodeStringFalseNoThe two-letter code for the country in the shipping address.
ShippingAddress_LongitudeDoubleFalseNoThe longitude for the shipping address location.
ShippingAddress_LatitudeDoubleFalseNoThe latitude for the shipping address location.
ShippingAddress_PhoneStringFalseNoThe phone number for the order’s shipping address
ShippingAddress_CompanyStringFalseNoThe company associated with an order’s shipping address.
BillingAddress_NameStringFalseNoThe name associated with an order’s billing address.
BillingAddress_Address1StringFalseNoThe billing address for the order.
BillingAddress_Address2StringFalseNoAn additional field for the billing address.
BillingAddress_CityStringFalseNoThe city in the billing address.
BillingAddress_ProvinceStringFalseNoThe state or normalized province in the billing address.
BillingAddress_ProvinceCodeStringFalseNoThe two-letter code for the province or state in the billing address.
BillingAddress_PostalCodeStringFalseNoThe postal or zip code in the billing address.
BillingAddress_CountryStringFalseNoThe country in the billing address.
BillingAddress_CountryCodeStringFalseNoThe two-letter code for the country in the billing address.
BillingAddress_LongitudeDoubleFalseNoThe longitude for the billing address location.
BillingAddress_LatitudeDoubleFalseNoThe latitude for the billing address location.
BillingAddress_PhoneStringFalseNoThe phone number for the billing address.
BillingAddress_CompanyStringFalseNoThe company associated with the billing address.
LinesStringFalseNoAn array of the order’s line items. The column will not work for Update. Lines can be updated using EcommerceOrderLines table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StoreId [KEY]StringFalseNoThe StoreId for the table.
Id [KEY]StringFalseNoA unique identifier for the product.
TitleStringFalseNoThe title of a product.
HandleStringFalseNoThe handle of a product.
UrlStringFalseNoThe URL of a product.
DescriptionStringFalseNoThe description of a product.
TypeStringFalseNoThe type of product.
VendorStringFalseNoThe vendor for a product.
ImageUrlStringFalseNoThe image URL for a product.
VariantsStringFalseNoAn array of the product’s variants.
PublishedAtForeignDatetimeFalseNoThe date and time when the product was published.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StoreId [KEY]StringFalseNoThe StoreId for the table.
ProductId [KEY]StringFalseNoThe ProductId for the table.
Id [KEY]StringFalseNoA unique identifier for the product variant.
TitleStringFalseNoThe title of a product variant.
UrlStringFalseNoThe URL of a product variant.
SkuStringFalseNoThe stock keeping unit (SKU) of a product variant.
PriceDecimalFalseNoThe price of a product variant.
InventoryQuantityIntegerFalseNoThe inventory quantity of a product variant.
ImageUrlStringFalseNoThe image URL for a product variant.
BackordersStringFalseNoThe backorders of a product variant.
VisibilityStringFalseNoThe visibility of a product variant.
CreatedAtDatetimeTrueNoThe date and time when the product was created.
UpdatedAtDatetimeTrueNoThe date and time the product was last updated.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identifier for the store.
ListId [KEY]StringTrueLists.IdNoThe unique identifier for the MailChimp list that’s associated with the store. The list_id for a specific store can’t change.
NameStringFalseNoThe name of the store.
PlatformStringFalseNoThe ecommerce platform of the store.
DomainStringFalseNoThe store domain.
EmailAddressStringFalseNoThe email address for the store.
CurrencyCodeStringFalseNoThe three-letter ISO 4217 code for the currency that the store accepts.
MoneyFormatStringFalseNoThe currency format for the store. For example: $, etc.
PrimaryLocaleStringFalseNoThe primary locale for the store. For example: en, de, etc.
TimezoneStringFalseNoThe timezone for the store.
PhoneStringFalseNoThe store phone number.
Address_Address1StringFalseNoThe store’s mailing address.
Address_Address2StringFalseNoAn additional field for the store’s mailing address.
Address_CityStringFalseNoThe city the store is located in.
Address_ProvinceStringFalseNoThe store’s state name or normalized province.
Address_ProvinceCodeStringFalseNoThe two-letter code for the store’s province or state.
Address_PostalCodeStringFalseNoThe store’s postal or zip code.
Address_CountryStringFalseNoThe store’s country.
Address_CountryCodeStringFalseNoThe two-letter code for to the store’s country.
Address_LongitudeDoubleFalseNoThe longitude of the store location.
Address_LatitudeDoubleFalseNoThe latitude of the store location.
CreatedAtDatetimeTrueNoThe date and time the store was created.
UpdatedAtDatetimeTrueNoThe date and time the store was last updated.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique id given to the file.
FolderIdIntegerFalseNoThe id of the folder.
TypeStringTrueNoThe type of file in the gallery: Image or file.
NameStringFalseNoThe name of the file.
FullSizeUrlStringTrueNoThe url of the full-size file.
ThumbnailUrlStringTrueNoThe url of the thumbnail preview.
SizeIntegerTrueNoThe size of the file in bytes.
CreatedAtDatetimeTrueNoThe date and time a file was added to the gallery.
CreatedByStringTrueNoThe username of the profile that uploaded the file.
WidthIntegerTrueNoThe width of the image.
HeightIntegerTrueNoThe height of an image.
FileDataStringFalseNoWhen adding a new file, the base64-encoded file. Required for INSERT statement.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique id given to the folder.
NameStringFalseNoThe name of the folder.
FileCountIntegerTrueNoThe number of files within the folder.
CreatedAtDatetimeTrueNoThe date and time a file was added to the gallery.
CreatedByStringTrueNoThe username of the profile that created the folder.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe id for the abuse report
CampaignId [KEY]StringTrueCampaigns.IdNoThe campaign id for the abuse report
ListId [KEY]StringTrueLists.IdNoThe list id for the abuse report.
EmailId [KEY]StringTrueNoThe MD5 hash of the list member’s email address.
EmailAddressStringTrueNoEmail address for a subscriber
DateStringTrueNoDate for the abuse report

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ListId [KEY]StringTrueLists.IdNoThe ListId for the table.
Day [KEY]DateTrueNoThe date for the activity summary.
EmailsSentIntegerTrueNoThe total number of emails sent on the date for the activity summary.
UniqueOpensIntegerTrueNoThe number of unique opens.
RecipientClicksIntegerTrueNoThe number of clicks.
HardBounceIntegerTrueNoThe number of hard bounces.
SoftBounceIntegerTrueNoThe number of soft bounces
SubsIntegerTrueNoThe number of subscribes.
UnsubsIntegerTrueNoThe number of unsubscribes.
OtherAddsIntegerTrueNoThe number of subscribers who may have been added outside of the double opt-in process such as imports or API activity.
OtherRemovesIntegerTrueNoThe number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam. For example, deleted subscribers.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ClientStringTrueNoThe name of the email client.
MembersIntegerTrueNoThe number of subscribed members who used this email client.
ListId [KEY]StringTrueLists.IdNoThe unique id for the list.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ListId [KEY]StringTrueLists.IdNoThe list id for the growth activity report.
Month [KEY]StringTrueNoThe month that the growth history is describing.
SubscribedIntegerTrueNoTotal subscribed members on the list at the end of the month.
UnsubscribedIntegerTrueNoNewly unsubscribed members on the list for a specific month.
ReconfirmIntegerTrueNoNewly reconfirmed members on the list for a specific month.
CleanedIntegerTrueNoNewly cleaned (hard-bounced) members on the list for a specific month.
PendingIntegerTrueNoPending members on the list for a specific month.
DeletedIntegerTrueNoNewly deleted members on the list for a specific month.
TransactionalIntegerTrueNoSubscribers that have been sent transactional emails via Mandrill.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ListId [KEY]StringFalseLists.IdNoThe ID for the list that this category belongs to.
Id [KEY]StringTrueNo
TitleStringFalseNoThe text description of this category. This field is displayed on signup forms and is often phrased as a question.
DisplayOrderIntegerFalseNoOrder in which the categories display in the list. Lower numbers display first.
TypeStringFalseNoDetermines how this category’s interests are displayed on signup forms.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoryId [KEY]StringFalseNoThe id for the interest category.
ListId [KEY]StringFalseLists.IdNoThe ID for the list that this interest belongs to.
Id [KEY]StringTrueNoThe ID for the interest.
NameStringFalseNoThe name of the interest. This can be shown publicly on a subscription form.
SubscriberCountStringTrueNoThe number of subscribers associated with this interest.
DisplayOrderIntegerFalseNoOrder in which the interests display.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
MemberId [KEY]StringTrueListMembers.IdNoThe MemberId of the member to get events for.
EmailId [KEY]StringTrueNoThe EmailId for the table.
ListId [KEY]StringTrueLists.IdNoThe ListId for the table.
ActionStringFalseNoThe type of action recorded for the subscriber.
Timestamp [KEY]DatetimeFalseNoThe date and time recorded for the action.
UrlStringFalseNoFor clicks, the URL the subscriber clicked on.
TypeStringFalseNoThe type of campaign that was sent.
CampaignId [KEY]StringFalseCampaigns.IdNoThe web-based ID for the campaign.
TitleStringFalseNoIf set, the campaign’s title.
ParentCampaignStringFalseNoThe ID of the parent campaign.
ContactIdStringTrueNoThe ID of the contact.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
NameStringFalseNoThe name of the event.
OccurredAtDatetimeFalseNoThe occurred datetime of the event.
PropertiesStringFalseNoProperties of the event in an aggregate JSON Format.
ListId [KEY]StringFalseLists.IdNoThe unique id for the list.
MemberId [KEY]StringFalseListMembers.IdNoThe MD5 hash of the list member’s email address.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoThe note’s ID.
CreatedAtDatetimeTrueNoThe date the note was created.
CreatedByStringTrueNoThe author of the note.
UpdatedAtDatetimeTrueNoThe date the note was last updated
NoteStringFalseNoThe content of the note.
ListId [KEY]StringFalseLists.IdNoThe unique id for the list.
MemberId [KEY]StringFalseListMembers.IdNoThe MD5 hash of the list member’s email address.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe MD5 hash of the list member’s email address.
EmailAddressStringFalseNoEmail address for a subscriber.
UniqueEmailId [KEY]StringTrueNoAn identifier for the address across all of MailChimp.
EmailTypeStringFalseNoType of email this member asked to get (‘html’ or ‘text’).
FullNameStringTrueNoThe contact’s full name.
StatusStringFalseNoSubscriber’s current status (‘subscribed’, ‘unsubscribed’, ‘cleaned’, ‘pending’ or ‘transactional’).
StatusIfNewStringFalseNoSubscriber’s status (‘subscribed’, ‘unsubscribed’, ‘cleaned’, or ‘pending’), to be used only on a PUT request if the email is not already present on the list.
InterestsStringFalseNoThe key of this object’s properties is the ID of the interest in question.
Stats_AvgOpenRateDoubleTrueNoA subscriber’s average open rate.
Stats_AvgClickRateDoubleTrueNoA subscriber’s average clickthrough rate.
IpSignupStringFalseNoIP address the subscriber signed up from.
TimestampSignupDatetimeFalseNoDate and time the subscriber signed up for the list.
IpOptStringFalseNoIP address the subscriber confirmed their opt-in status.
TimestampOptDatetimeFalseNoDate and time the subscribe confirmed their opt-in status.
MemberRatingIntegerTrueNoStar rating for this member between 1 and 5.
LastChangedDatetimeTrueNoDate and time the member’s info was last changed.
LanguageStringFalseNoIf set/detected, the language of the subscriber.
VipBooleanFalseNoVIP status for subscriber.
EmailClientStringTrueNoThe email client the address as using.
Location_LatitudeDoubleFalseNo
Location_LongitudeDoubleFalseNo
Location_GmtoffIntegerTrueNo
Location_DstoffIntegerTrueNo
Location_CountryCodeStringTrueNo
Location_TimezoneStringTrueNo
LastNote_NoteIdIntegerTrueListMemberNotes.IdNoThe note’s ID.
LastNote_CreatedAtStringTrueNoThe date the note was created.
LastNote_CreatedByStringTrueNoThe author of the note.
LastNote_NoteStringTrueNoThe content of the note.
ListId [KEY]StringFalseLists.IdNoThe id for the list.
TagsAggregateStringFalseNoTags of the member, displayed as an aggregate.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique ID of the tag.
NameStringFalseNoName of the tag. When inserting, if the name doesn’t exist, it will be created and then assigned to the member specified.
TimeAddedDatetimeTrueNoDate and time the tag was added to the member.
ListIdStringFalseLists.IdNoThe ID of the list on which the member of this tag belongs to.
MemberIdStringFalseListMembers.IdNoThe ID of the member this tag is assigned to.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
MergeId [KEY]IntegerTrueNoAn unchanging id for the merge field.
TagStringFalseNoThe tag used in MailChimp campaigns and for the /members endpoint.
NameStringFalseNo
TypeStringFalseNoThe type for the merge field.
RequiredBooleanFalseNoBoolean value for if the merge field is required
DefaultValueStringFalseNoThe default value for the merge field if null.
PublicBooleanFalseNoWhether or not the merge field is displayed on the signup form.
DisplayOrderIntegerFalseNoThe order on the form where the merge field is displayed.
Options_DefaultCountryIntegerFalseNoIn an address field, the default country code if none supplied.
Options_PhoneFormatStringFalseNoIn a phone field, the phone number type: US or International.
Options_DateFormatStringFalseNoIn a date or birthday field, the format of the date.
Options_ChoicesStringFalseNoIn a radio or dropdown non-group field, the available options for members to pick from.
Options_SizeIntegerFalseNoIn a text field, the default length of the text field.
HelpTextStringFalseNoAny extra text to help the subscriber.
ListId [KEY]StringFalseLists.IdNoA string that identifies this merge field collections’ list.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that uniquely identifies this list
NameStringFalseNoThe name of the list.
Contact_CompanyStringFalseNoThe company name associated with the list.
Contact_Address1StringFalseNoThe street address for the list contact.
Contact_Address2StringFalseNoThe street address for the list contact.
Contact_CityStringFalseNoThe city for the list contact.
Contact_StateStringFalseNoThe state for the list contact.
Contact_ZipStringFalseNoThe postal or zip code for the list contact.
Contact_CountryStringFalseNoA two-character ISO3166 country code. Defaults to US if invalid.
Contact_PhoneStringFalseNoThe phone number for the list contact.
PermissionReminderStringFalseNoThe permission reminder for the list: a line of text that appears in the footer of each campaign that explains why subscribers are receiving the email campaign.
UseArchiveBarBooleanFalseNoWhether or not campaigns for this list use the Archive Bar in archives by default.
CampaignDefaults_FromNameStringFalseNoThe default from name for campaigns sent to this list.
CampaignDefaults_FromEmailStringFalseNoThe default from email (must be a valid email address) for campaigns sent to this list.
CampaignDefaults_SubjectStringFalseNoThe default subject line for campaigns sent to this list.
CampaignDefaults_LanguageStringFalseNoThe default language for this lists’s forms.
NotifyOnSubscribeStringFalseNoThe email address to send subscribe notifications to, when enabled.
NotifyOnUnsubscribeStringFalseNoThe email address to send unsubscribe notifications to, when enabled.
DateCreatedDatetimeTrueNoThe date and time that this list was created.
ListRatingIntegerTrueNoAn auto-generated activity score for the list (0-5).
EmailTypeOptionBooleanFalseNoWhether or not the list supports multiple formats for emails.
SubscribeUrlShortStringTrueNoOur eepurl shortened version of this list’s subscribe form.
SubscribeUrlLongStringTrueNoThe full version of this list’s subscribe form (host will vary).
BeamerAddressStringTrueNoThe email address to use for this list’s Email Beamer.
VisibilityStringFalseNoWhether this list is public (pub) or private (prv). Used internally for projects like Wavelength.
ModulesStringTrueNoAny list-specific modules installed for this list.
Stats_MemberCountIntegerTrueNoThe number of active members in the given list.
Stats_UnsubscribeCountIntegerTrueNoThe number of members who have unsubscribed from the given list.
Stats_CleanedCountIntegerTrueNoThe number of members cleaned from the given list.
Stats_MemberCountSinceSendIntegerTrueNoThe number of active members in the given list since the last campaign was sent.
Stats_UnsubscribeCountSinceSendIntegerTrueNoThe number of members who have unsubscribed since the last campaign was sent.
Stats_CleanedCountSinceSendIntegerTrueNoThe number of members cleaned from the given list since the last campaign was sent.
Stats_CampaignCountIntegerTrueNoThe number of campaigns in any status that use this list.
Stats_CampaignLastSentDatetimeTrueNoThe date and time the last campaign was sent to this list.
Stats_MergeFieldCountIntegerTrueNoThe number of merge vars for this list (not including the required EMAIL one).
Stats_AvgSubRateDoubleTrueNoThe average number of subscriptions per month for the list (not returned if we haven’t calculated it yet).
Stats_AvgUnsubRateDoubleTrueNoThe average number of unsubscriptions per month for the list (not returned if we haven’t calculated it yet).
Stats_TargetSubRateDoubleTrueNoThe target numberof subscriptions per month for the list to keep it growing (not returned if we haven’t calculated it yet).
Stats_OpenRateDoubleTrueNoThe 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).
Stats_ClickRateDoubleTrueNoThe 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).
Stats_LastSubDateDatetimeTrueNoThe date and time of the last time someone subscribed to this list.
Stats_LastUnsubDateDatetimeTrueNoThe date and time of the last time someone unsubscribed from this list.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe MD5 hash of the list member’s email address.
EmailAddressStringFalseNoEmail address for a subscriber.
UniqueEmailId [KEY]StringTrueNoAn identifier for the address across all of MailChimp.
EmailTypeStringTrueNoType of email this member asked to get (‘html’ or ‘text’).
StatusStringTrueNoSubscriber’s current status (‘subscribed’, ‘unsubscribed’, ‘cleaned’, or ‘pending’).
StatusIfNewStringTrueNoSubscriber’s status (‘subscribed’, ‘unsubscribed’, ‘cleaned’, or ‘pending’), to be used only on a PUT request if the email is not already present on the list.
InterestsStringTrueNoThe key of this object’s properties is the ID of the interest in question.
Stats_AvgOpenRateDoubleTrueNoA subscriber’s average open rate.
Stats_AvgClickRateDoubleTrueNoA subscriber’s average clickthrough rate.
IpSignupStringTrueNoIP address the subscriber signed up from.
TimestampSignupDatetimeTrueNoDate and time the subscriber signed up for the list.
IpOptStringTrueNoIP address the subscriber confirmed their opt-in status.
TimestampOptDatetimeTrueNoDate and time the subscribe confirmed their opt-in status.
MemberRatingIntegerTrueNoStar rating for this member between 1 and 5.
LastChangedDatetimeTrueNoDate and time the member’s info was last changed.
LanguageStringTrueNoIf set/detected, the language of the subscriber.
VipBooleanTrueNoVIP status for subscriber.
EmailClientStringTrueNoThe email client the address as using.
Location_LatitudeDoubleTrueNo
Location_LongitudeDoubleTrueNo
Location_GmtoffIntegerTrueNo
Location_DstoffIntegerTrueNo
Location_CountryCodeStringTrueNo
Location_TimezoneStringTrueNo
LastNote_NoteIdIntegerTrueListMemberNotes.IdNoThe note’s ID.
LastNote_CreatedAtStringTrueNoThe date the note was created.
LastNote_CreatedByStringTrueNoThe author of the note.
LastNote_NoteStringTrueNoThe content of the note.
ListId [KEY]StringFalseLists.IdNoThe id for the list.
SegmentId [KEY]StringFalseListSegments.IdNoThe id for the segment.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoAn integer to uniquely identify the segment.
NameStringFalseNoThe name of the segment.
MemberCountIntegerTrueNoThe number of active subscribers currently included in the segment.
TypeStringTrueNoThe type of segment: saved, static, or fuzzy.
CreatedAtDatetimeTrueNoThe time and date the segment was created.
UpdatedAtDatetimeTrueNoThe time and date the segment was last updated.
Options_MatchStringFalseNoMatch type of ‘any’ or ‘all’.
Options_ConditionsStringFalseNoAn array of segment conditions.
ListId [KEY]StringFalseLists.IdNoThe id for the list.
EmailListStringFalseYesA comma-separated list of emails that you want to include in this ListSegment.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Header_ImageUrlStringFalseNoHeader Image Url
Header_TextStringFalseNoHeader Text
Header_ImageWidthStringFalseNoImage width
Header_ImageHeightStringFalseNoImage height
Header_ImageAltStringFalseNoImage Alt
Header_ImageLinkStringFalseNoImage Link
Header_ImageAlignStringFalseNoImage align
Header_ImageBorderWidthStringFalseNoImage border width
Header_ImageBorderStyleStringFalseNoImage border style
Header_ImageBorderColorStringFalseNoImage border color
Header_ImageTargetStringFalseNoImage target
ContentsStringFalseNoSignup form body contents options
StylesStringFalseNoAn array of objects, each representing each element of signup forms.
SignupFormUrlStringFalseNoSignup form URL
ListId [KEY]StringTrueLists.IdNoA string that identifies this signup forms’ list.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoAn identifier for the webhook across all of MailChimp.
UrlStringFalseNothe URL for this Webhook.
Events_SubscribeBooleanFalseNo
Events_UnsubscribeBooleanFalseNo
Events_ProfileBooleanFalseNo
Events_CleanedBooleanFalseNo
Events_UpemailBooleanFalseNo
Events_CampaignBooleanFalseNo
Sources_UserBooleanFalseNo
Sources_AdminBooleanFalseNo
Sources_ApiBooleanFalseNo
ListId [KEY]StringFalseLists.IdNoThe id for the list.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique id for the abuse report.
CampaignId [KEY]StringTrueCampaigns.IdNoThe campaign id for the abuse report
ListId [KEY]StringTrueLists.IdNoThe list id for the abuse report.
EmailId [KEY]StringTrueNoThe list-specific ID for the given email address
EmailAddressStringTrueNoEmail address for a subscriber
DateStringTrueNoDate for the abuse report

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CampaignIdStringTrueCampaigns.IdNoThe CampaignId for the table.
TypeStringTrueNoThe ‘type’ of message (‘negative’, ‘positive’, ‘neutral’).
MessageStringTrueNoThe advice message.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNo
UrlStringTrueNoThe URL for the link in the campaign.
TotalClicksIntegerTrueNoThe number of total clicks for a given link.
ClickPercentageDoubleTrueNoThe percentage of total clicks a given link generated for a campaign.
UniqueClicksIntegerTrueNoNumber of unique clicks for a given link.
UniqueClickPercentageDoubleTrueNoThe percentage of unique clicks a given link generated for a campaign.
LastClickDatetimeTrueNoThe date and time for the last recorded click for a given link.
AbSplit_AStringFalseNo
AbSplit_BStringFalseNo
CampaignId [KEY]StringTrueCampaigns.IdNoThe id for the campaign.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
EmailId [KEY]StringTrueNoThe list-specific ID for the given email address.
EmailAddressStringTrueNoEmail address for a subscriber
ClicksIntegerTrueNoThe total number of times the subscriber clicked on the link.
CampaignId [KEY]StringTrueCampaigns.IdNoThe id for the campaign.
UrlId [KEY]StringTrueNoThe id for the tracked URL in the campaign.
ListId [KEY]StringTrueLists.IdNoThe id for the list.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CampaignIdStringTrueCampaigns.IdNoThe CampaignId for the table.
DomainStringTrueNoThe name of the domain (gmail.com, hotmail.com, yahoo.com).
EmailsSentIntegerTrueNoThe number of emails sent to that specific domain.
BouncesIntegerTrueNoThe number of bounces at a domain.
OpensIntegerTrueNoThe number of opens for a domain.
ClicksIntegerTrueNoThe number of clicks for a domain.
UnsubsIntegerTrueNoThe total number of unsubscribes for a domain.
DeliveredIntegerTrueNoThe number of successful deliveries for a domain.
EmailsPctDoubleTrueNoThe percentage of total emails that went to this domain.
BouncesPctDoubleTrueNoThe percentage of total bounces that came from this domain.
OpensPctDoubleTrueNoThe percentage of total opens that came from this domain.
ClicksPctDoubleFalseNoThe percentage of total clicks tht came from this domain.
UnsubsPctDoubleTrueNoThe percentage of total unsubscribes taht came from this domain.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CampaignId [KEY]StringTrueCampaigns.IdNoThe unique id for the campaign.
ListId [KEY]StringTrueLists.IdNoThe unique id for the list.
EmailId [KEY]StringTrueNoThe list-specific ID for the given email address.
EmailAddressStringTrueNoEmail address for a subscriber
ActivityStringFalseNoAn array of objects, each showing an interaction with the email.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CampaignId [KEY]StringTrueCampaigns.IdNoThe CampaignId for the table.
Region [KEY]StringTrueNoA more specific location area such as city or state.
OpensIntegerTrueNoThe number of unique campaign opens for a given region.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA string that uniquely identifies this campaign.
CampaignTitleStringTrueNoThe title of the campaign.
TypeStringFalseNoThe type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto).
EmailsSentIntegerFalseNoThe total number of emails sent for this campaign.
AbuseReportsIntegerFalseNoThe number of abuse reports generated for this campaign.
UnsubscribedIntegerTrueNoThe total number of unsubscribed members for this campaign.
SendTimeDatetimeTrueNoThe time and date a campaign was sent.
Bounces_HardBouncesIntegerFalseNoThe total number of hard bounced email addresses.
Bounces_SoftBouncesIntegerFalseNoThe total number of soft bounced email addresses.
Bounces_SyntaxErrorsIntegerFalseNoThe total number of addresses that were syntax-related bounces.
Forwards_ForwardsCountIntegerFalseNo
Forwards_ForwardsOpensIntegerFalseNo
Opens_OpensTotalIntegerFalseNoThe total number of opens for a campaign.
Opens_UniqueOpensIntegerFalseNoThe total number of unique subscribers who opened a campaign.
Opens_OpenRateDoubleFalseNoThe number of unique subscribers who opened divided by the total number of successful deliveries.
Opens_LastOpenDatetimeFalseNoThe date and time of the last recorded open.
Clicks_ClicksTotalIntegerFalseNoThe total number of clicks for the campaign.
Clicks_UniqueClicksIntegerFalseNoThe total number of unique clicks for links across a campaign.
Clicks_UniqueSubscriberClicksIntegerFalseNoThe total number of subscribers who clicked on a campaign.
Clicks_ClickRateDoubleFalseNoThe number of unique subscribers who clicked divided by the total number of successful deliveries.
Clicks_LastClickDatetimeFalseNoThe date and time of the last recorded click for the campaign.
FacebookLikes_RecipientLikesIntegerFalseNo
FacebookLikes_UniqueLikesIntegerFalseNo
FacebookLikes_FacebookLikesIntegerFalseNo
IndustryStats_TypeStringFalseNo
IndustryStats_OpenRateDoubleFalseNo
IndustryStats_ClickRateDoubleFalseNo
IndustryStats_BounceRateDoubleFalseNo
IndustryStats_UnopenRateDoubleFalseNo
IndustryStats_UnsubRateDoubleFalseNo
IndustryStats_AbuseRateDoubleFalseNo
ListStats_SubRateDoubleTrueNoThe average number of subscriptions per month for the list.
ListStats_UnsubRateDoubleTrueNoThe average number of unsubscriptions per month for the list.
ListStats_OpenRateDoubleTrueNoThe average open rate (a percentage represented as a number between 0 and 100) per campaign for the list.
ListStats_ClickRateDoubleTrueNoThe average click rate (a percentage represented as a number between 0 and 100) per campaign for the list.
AbSplit_AStringFalseNo
AbSplit_BStringFalseNo
TimewarpStringFalseNoAn hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp.
TimeseriesStringFalseNoAn hourly breakdown of the performance of the campaign over the first 24 hours.
ShareReport_ShareUrlStringTrueNoThe URL for the VIP report.
ShareReport_SharePasswordStringTrueNoIf password protected, the password for the VIP report.
DeliveryStatusStringFalseNoUpdates on campaigns in the process of sending.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
EmailId [KEY]StringTrueNoThe list-specific ID for the given email address.
EmailAddressStringTrueNoEmail address for a subscriber.
StatusStringFalseNoThe status of the member (‘sent’, ‘hard’ for hard bounce, or ‘soft’ for soft bounce).
OpenCountIntegerFalseNoThe number of times a campaign was opened by this member.
LastOpenStringFalseNoThe date and time of the last open for this member.
AbsplitGroupStringFalseNoFor A/B Split Campaigns, the group the member was apart of (‘a’, ‘b’, or ‘winner’).
GmtOffsetIntegerFalseNoFor campaigns sent with timewarp, the time zone group the member is apart of.
CampaignId [KEY]StringTrueCampaigns.IdNoThe id for the campaign.
ListId [KEY]StringTrueLists.IdNoThe id for the list.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
EmailId [KEY]StringTrueNoThe list-specific ID for the given email address
EmailAddressStringTrueNoEmail address for a subscriber
TimestampDatetimeTrueNoThe date and time the member opted-out.
ReasonStringTrueNoIf available, the reason listed by the member for unsubscribing.
CampaignId [KEY]StringTrueCampaigns.IdNoThe id for the campaign.
ListId [KEY]StringTrueLists.IdNoThe id for the list.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe ID for the survey response.
SubmittedAtDatetimeTrueNoThe date and time when the survey response was submitted.
ContactEmailIdStringTrueNoThe MD5 hash of the lowercase version of the list member email address.
ContactIdStringTrueNoThe ID of this contact.
ContactStatusStringTrueNoThe contact’s current status.
ContactEmailStringTrueNoThe contact’s email address.
ContactFullNameStringTrueNoThe contact’s full name.
ContactConsentsToOneToOneMessagingBooleanTrueNoIndicates whether a contact consents to 1:1 messaging.
ContactAvatarUrlStringTrueNoURL for the contact’s avatar or profile image.
IsNewContactBooleanTrueNoIf this contact was added to the Mailchimp audience via this survey.
SurveyId [KEY]StringTrueSurveys.IdNoA string that uniquely identifies this survey.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that uniquely identifies this survey.
WebIdIntegerTrueNoThe ID used in the Mailchimp web application.
ListIdStringTrueNoThe ID of the list connected to this survey.
ListNameStringTrueNoThe name of the list connected to this survey.
TitleStringTrueNoThe title of the survey.
UrlStringTrueNoThe URL for the survey.
StatusStringTrueNoThe status of the Surney. Possible values: published or unpublished.
PublishedAtDatetimeTrueNoThe date and time the survey was published.
CreatedAtDatetimeTrueNoThe date and time the survey was created.
UpdatedAtDatetimeTrueNoThe date and time the survey was last updated.
TotalResponsesIntegerTrueNoThe total number of responses to this survey.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA string that uniquely identifieds this folder
NameStringFalseNoThe name of the folder
CountIntegerTrueNoThe number of templates in the folder

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoThe individual id for the template.
TypeStringTrueNoThe type of template (user, base, or gallery).
NameStringFalseNoThe name of the template.
DragAndDropBooleanTrueNoWhether or not the template uses the drag and drop editor.
ResponsiveBooleanTrueNoWhether or not the template contains media queries to make it responsive.
CategoryStringTrueNoIf available, the category the template is listed in.
DateCreatedDatetimeTrueNoThe date and time the template was created.
CreatedByStringTrueNoThe login name for template’s creator.
ActiveBooleanFalseNoUser templates are not ‘deleted,’ but rather marked as ‘inactive.’ Returns whether or not the template is still active.
FolderIdStringFalseNoThe id of the folder the template is currently in.
ThumbnailStringTrueNoIf available, the URL for a thumbnail of the template.
ShareUrlStringTrueNoThe URL used for template sharing. For more information, see: http://kb.mailchimp.com/templates/basic-and-themes/how-to-share-a-template

Return to Top