Mailchimp Connector Objects
Name | Description |
---|---|
AuthorizedApps | A list of applications authorized to access the account. |
AutomationEmailQueues | A summary of the queue for an email in an automation workflow. |
AutomationEmails | A summary of the emails in an automation workflow. |
Automations | A summary of the automations within an account. |
AutomationsRemovedSubscribers | A summary of the subscribers removed from an automation workflow. |
CampaignFeedback | A summary of the comment feedback for a specific campaign. |
CampaignFolders | Folders for organizing campaigns |
CampaignOpenEmailDetails | A list of members who opened the campaign email. |
Campaigns | A summary of the campaigns within an account. |
ConversationMessages | Messages 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. |
Conversations | A 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. |
EcommerceCartLines | A list of an ecommerce cart's lines. |
EcommerceCarts | A list of an account's ecommerce carts. |
EcommerceCustomers | A list of an account's ecommerce customers. |
EcommerceOrderLines | A list of an ecommerce order's lines. |
EcommerceOrders | A list of an account's ecommerce orders. |
EcommerceProducts | A list of an account's ecommerce products. |
EcommerceProductVariants | A list of an ecommerce product's variants. |
EcommerceStores | A list of an account's ecommerce stores. |
FileManagerFiles | A listing of all avaialable images and files within an account's gallery. |
FileManagerFolders | A listing of all avaialable folders within an account's gallery. |
ListAbuse | A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. |
ListActivity | Up to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity. |
ListClients | Top email clients used, as measured by their user-agent string |
ListGrowthHistory | A month-by-month summary of a specific list's growth activity. |
ListInterestCategories | A listing of this list's interest categories. |
ListInterests | A list of this category's interests |
ListMemberActivity | The last 50 member events for a list. |
ListMemberEvents | Events information for a specific list. |
ListMemberNotes | The last 10 notes for a specific list member, based on date created. |
ListMembers | Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed. |
ListMemberTags | Tags assigned to specific members. |
ListMergeFields | The merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles. |
Lists | A collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization. |
ListSegmentMembers | Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed. |
ListSegments | A list of available segments. |
ListSignupForms | Collection of List Signup Forms |
ListsWebhooks | Webhooks configured for the given list. |
ReportAbuse | A list of abuse complaints for a specific list. |
ReportAdvice | A list of feedback based on a campaign's statistics. |
ReportClickDetails | A list of URLs and unique IDs included in HTML and plain-text versions of a campaign. |
ReportClickDetailsMembers | A collection of members who clicked on a specific link within a campaign. |
ReportDomainPerformance | Statistics for the top-performing email domains in a campaign. |
ReportEmailActivity | A list of member's subscriber activity in a specific campaign. |
ReportLocations | Top open locations for a specific campaign. |
Reports | A list of reports containing campaigns marked as Sent. |
ReportSentTo | A list of subscribers who were sent a specific campaign. |
ReportUnsubscribes | A list of members who have unsubscribed from a specific campaign. |
SurveyResponses | List of survey responses. |
Surveys | Get reports for surveys. |
TemplateFolders | Folders for organizing templates |
Templates | A list an account's available templates. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id for this application integration. | |
Name | String | False | No | The name of the application. | |
Description | String | False | No | The description for the application. | |
Users | String | False | No | An array of usernames of the users who have linked this app. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The MD5 hash of the lowercase version of the list member's email address. | |
WorkflowId [KEY] | String | False | No | A string that uniquely identifies an automation workflow. | |
EmailId [KEY] | String | False | No | A string that uniquely identifies an email in an automation workflow. | |
ListId | String | True | Lists.Id | No | A string that uniquely identifies a list. |
EmailAddress | String | False | No | Email Address | |
NextSend | String | True | No | Next Send |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that uniquely identifies the automation email. | |
WorkflowId [KEY] | String | True | No | A string that uniquely identifies an automation workflow. | |
Position | Integer | True | No | ||
Delay_Amount | Integer | False | No | The delay amount for an automation email. | |
Delay_Type | String | False | No | The type of delay for an automation email. | |
Delay_Direction | String | False | No | Whether the delay settings describe before or after the delay action of an automation email. | |
Delay_Action | String | False | No | The action that triggers the delay of an automation emails. | |
CreateTime | Datetime | True | No | The date and time the campaign was created. | |
StartTime | Datetime | True | No | The date and time the campaign was started. | |
ArchiveUrl | String | True | No | The link to the campaign's archive version. | |
Status | String | True | No | The current status of the campaign ('save', 'paused', 'sending'). | |
EmailsSent | Integer | True | No | The total number of emails sent for this campaign. | |
SendTime | Datetime | True | No | The time and date a campaign was sent. | |
ContentType | String | True | No | How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). | |
Recipients_ListId | String | False | Lists.Id | No | The id of the list. |
Recipients_SegmentOpts | String | False | No | Segment options. | |
Settings_SubjectLine | String | False | No | The subject line for the campaign. | |
Settings_Title | String | False | No | The title of the campaign. | |
Settings_FromName | String | False | No | The 'from' name on the campaign (not an email address). | |
Settings_ReplyTo | String | False | No | The reply-to email address for the campaign. | |
Settings_Authenticate | Boolean | False | No | Whether or not the campaign was authenticated by MailChimp. Defaults to 'true'. | |
Settings_AutoFooter | Boolean | False | No | Automatically append MailChimp's default footer to the campaign. | |
Settings_InlineCss | Boolean | False | No | Automatically inline the CSS included with the campaign content. | |
Settings_AutoTweet | Boolean | False | No | Automatically tweet a link to the campaign archive page when the campaign is sent. | |
Settings_AutoFbPost | String | False | No | An array of Facebook page ids (integers) to auto-post to. | |
Settings_FbComments | Boolean | False | No | Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to 'true'. | |
Settings_TemplateId | Integer | False | Templates.Id | No | The id for the template used in this campaign. |
Settings_DragAndDrop | Boolean | True | No | Whether the campaign uses the drag-and-drop editor. | |
Tracking_Opens | Boolean | False | No | Whether to track opens. Defaults to 'true'. | |
Tracking_HtmlClicks | Boolean | False | No | Whether to track clicks in the HTML version of the campaign. Defaults to 'true'. | |
Tracking_TextClicks | Boolean | False | No | Whether to track clicks in the plain-text version of the campaign. Defaults to 'true'. | |
Tracking_GoalTracking | Boolean | False | No | Whether to enable Goal racking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH | |
Tracking_Ecomm360 | Boolean | False | No | Whether to enable eCommerce360 tracking. | |
Tracking_GoogleAnalytics | String | False | No | The custom slug for Google Analytics tracking (max of 50 bytes). | |
Tracking_Clicktale | String | False | No | The custom slug for ClickTale Analytics tracking (max of 50 bytes). | |
Tracking_Salesforce | String | False | No | Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration. | |
Tracking_Highrise | String | False | No | Highrise tracking options for a campaign. Must be using MailChimp's built-in Highrise integration. | |
Tracking_Capsule | String | False | No | Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration. | |
SocialCard_ImageUrl | String | False | No | The url for the header image for the card. | |
SocialCard_Description | String | False | No | A short summary of the campaign to display. | |
SocialCard_Title | String | False | No | The title for the card. Typically the subject line of the campaign. | |
TriggerSettings_Runtime | String | False | No | The advanced scheduling options for an automation email. | |
ReportSummary | String | False | No | For sent campaigns, a summary of opens, clicks, and unsubscribes. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that identifies this automation. | |
CreateTime | Datetime | True | No | The date and time the automation was created. | |
StartTime | Datetime | True | No | The date and time the automation was started. | |
Status | String | True | No | The current status of the automation ('save', 'paused', 'sending'). | |
EmailsSent | Integer | True | No | The total number of emails sent for this automation. | |
Recipients_ListId | String | False | Lists.Id | No | The id of the list. |
Recipients_ListName | String | False | No | List Name | |
Recipients_SegmentOpts | String | False | No | Segment options. | |
Settings_Title | String | False | No | The title of the automation. | |
Settings_FromName | String | False | No | The 'from' name on the automation (not an email address). | |
Settings_ReplyTo | String | False | No | The reply-to email address for the automation. | |
Settings_UseConversation | Boolean | False | No | Use MailChimp's Conversations feature to manage out of office replies. | |
Settings_ToName | String | False | No | The automation's custom 'to' name. Typically something like the first name merge var. | |
Settings_Authenticate | Boolean | False | No | Whether or not the automation is authenticated by MailChimp. Defaults to 'true'. | |
Settings_AutoFooter | Boolean | False | No | Automatically append MailChimp's default footer to the automation. | |
Settings_InlineCss | Boolean | False | No | Automatically inline the CSS included with the automation content. | |
Tracking_Opens | Boolean | False | No | Whether to track opens. Defaults to 'true'. | |
Tracking_HtmlClicks | Boolean | False | No | Whether to track clicks in the HTML version of the automation. Defaults to 'true'. | |
Tracking_TextClicks | Boolean | False | No | Whether to track clicks in the plain-text version of the automation. Defaults to 'true'. | |
Tracking_GoalTracking | Boolean | False | No | Whether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH | |
Tracking_Ecomm360 | Boolean | False | No | Whether to enable eCommerce360 tracking. | |
Tracking_GoogleAnalytics | String | False | No | The custom slug for Google Analytics tracking (max of 50 bytes). | |
Tracking_Clicktale | String | False | No | The custom slug for ClickTale Analytics tracking (max of 50 bytes). | |
Tracking_Salesforce | String | False | No | Salesforce tracking options for an automation. Must be using MailChimp's built-in Salesforce integration. | |
Tracking_Highrise | String | False | No | Highrise tracking options for an automation. Must be using MailChimp's built-in Highrise integration. | |
Tracking_Capsule | String | False | No | Capsule tracking options for an automation. Must be using MailChimp's built-in Capsule integration. | |
TriggerSettings | String | False | No | A summary of an automation workflow's trigger settings. | |
ReportSummary | String | False | No | A summary of open and click activity for an automation workflow. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The MD5 hash of the lowercase version of the list member's email address. | |
WorkflowId [KEY] | String | False | No | A string that uniquely identifies an automation workflow. | |
ListId | String | True | Lists.Id | No | A string that uniquely identifies a list. |
EmailAddress | String | False | No | Email Address |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
FeedbackId [KEY] | Integer | True | No | The individual id for the feedback item. | |
ParentId | Integer | True | No | If a reply, the id of the parent feedback item. | |
BlockId | Integer | False | No | The block id for the editable block that the feedback addresses. | |
Message | String | False | No | The content of the feedback. | |
IsComplete | Boolean | False | No | The status of feedback. | |
CreatedBy | String | True | No | The login name of the user who created the feedback. | |
CreatedAt | Datetime | True | No | The date and time the feedback item was created. | |
UpdatedAt | Datetime | True | No | The date and time the feedback was last updated. | |
Source | String | True | No | The source of the feedback ('email', 'sms', 'web', 'ios', 'android', or 'api'). | |
CampaignId [KEY] | String | False | Campaigns.Id | No | The unique id for the campaign. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that uniquely identifieds this campaign folder | |
Name | String | False | No | The name of the folder | |
Count | Integer | True | No | The number of campaigns in the folder |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CampaignId [KEY] | String | True | No | The Id for this application integration. | |
ListId [KEY] | String | True | Lists.Id | No | The name of the application. |
ListIsActive | Boolean | True | No | The description for the application. | |
ContactStatus | String | True | No | An array of usernames of the users who have linked this app. | |
EmailId [KEY] | String | True | No | The description for the application. | |
EmailAddress | String | True | No | The description for the application. | |
MergeFields | String | True | No | The description for the application. | |
Vip | Boolean | True | No | The description for the application. | |
OpensCount | Integer | True | No | The description for the application. | |
Opens | String | True | No | The description for the application. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that uniquely identifies this campaign. | |
Type | String | False | No | The type of campaign (regular, plaintext, absplit, or rss). | |
CreateTime | Datetime | True | No | The date and time the campaign was created. | |
ArchiveUrl | String | True | No | The link to the campaign's archive version. | |
LongArchiveUrl | String | True | No | The original link to the campaign's archive version. | |
Status | String | True | No | The current status of the campaign ('save', 'paused', 'schedule', 'sending', 'sent'). | |
EmailsSent | Integer | True | No | The total number of emails sent for this campaign. | |
SendTime | Datetime | True | No | The time and date a campaign was sent. | |
ContentType | String | False | No | How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). | |
Recipients_ListId | String | False | Lists.Id | No | The id of the list. |
Recipients_ListName | String | True | No | The name of the list. | |
Recipients_SegmentText | String | False | No | A string marked-up with HTML explaining the segment used for the campaign in plain English. | |
Recipients_RecipientCount | Integer | True | No | Count of the recipients on the associated list. Formatted as an integer | |
Recipients_SegmentOpts | String | False | No | Segment options. | |
Settings_SubjectLine | String | False | No | The subject line for the campaign. | |
Settings_Title | String | False | No | The title of the campaign. | |
Settings_FromName | String | False | No | The 'from' name on the campaign (not an email address). | |
Settings_ReplyTo | String | False | No | The reply-to email address for the campaign. | |
Settings_UseConversation | Boolean | False | No | Use MailChimp Conversation feature to manage out of office replies. | |
Settings_ToName | String | False | No | The campaign's custom 'to' name. Typically something like the first name merge var. | |
Settings_FolderId | String | False | No | If the campaign is listed in a folder, the id for that folder. | |
Settings_Authenticate | Boolean | False | No | Whether or not the campaign was authenticated by MailChimp. Defaults to 'true'. | |
Settings_AutoFooter | Boolean | False | No | Automatically append MailChimp's default footer to the campaign. | |
Settings_InlineCss | Boolean | False | No | Automatically inline the CSS included with the campaign content. | |
Settings_AutoTweet | Boolean | False | No | Automatically tweet a link to the campaign archive page when the campaign is sent. | |
Settings_AutoFbPost | String | False | No | An array of Facebook page ids to auto-post to. | |
Settings_FbComments | Boolean | False | No | Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to 'true'. | |
Settings_Timewarp | Boolean | True | No | Send this campaign using 'timewarp.' For more info, see the Knowledge Base article: http://eepurl.com/iAgs | |
Settings_TemplateId | Integer | False | Templates.Id | No | The id for the template used in this campaign. |
Settings_DragAndDrop | Boolean | True | No | Whether the campaign uses the drag-and-drop editor. | |
VariateSettings_WinningCombinationId | String | True | No | ID of the combination that was chosen as the winner | |
VariateSettings_WinningCampaignId | String | True | No | ID of the campaign that was sent to the remaining recipients based on the winning combination | |
VariateSettings_WinnerCriteria | String | False | No | How the winning campaign will be chosen | |
VariateSettings_WaitTime | Integer | False | No | The number of minutes to wait before the winning campaign is picked | |
VariateSettings_TestSize | Integer | False | No | The percentage of subscribers to send the test combinations to, from 10 to 100 | |
VariateSettings_SubjectLines | String | False | No | Possible subject lines | |
VariateSettings_SendTimes | String | False | No | Possible send times | |
VariateSettings_FromNames | String | False | No | Possible from names | |
VariateSettings_ReplyToAddresses | String | False | No | Possible reply To addresses | |
VariateSettings_Contents | String | True | No | Descriptions of possible email contents | |
VariateSettings_Combinations | String | True | No | Combinations of possible variables that were used to build emails | |
Tracking_Opens | Boolean | False | No | Whether to track opens. Defaults to 'true'. | |
Tracking_HtmlClicks | Boolean | False | No | Whether to track clicks in the HTML version of the campaign. Defaults to 'true'. | |
Tracking_TextClicks | Boolean | False | No | Whether to track clicks in the plain-text version of the campaign. Defaults to 'true'. | |
Tracking_GoalTracking | Boolean | False | No | Whether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH | |
Tracking_Ecomm360 | Boolean | False | No | Whether to enable eCommerce360 tracking. | |
Tracking_GoogleAnalytics | String | False | No | The custom slug for Google Analytics tracking (max of 50 bytes). | |
Tracking_Clicktale | String | False | No | The custom slug for ClickTale Analytics tracking (max of 50 bytes). | |
Tracking_Salesforce | String | False | No | Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration. | |
Tracking_Highrise | String | False | No | Highrise tracking options for a campaign. Must be using MailChimp's built-in Highrise integration. | |
Tracking_Capsule | String | False | No | Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration. | |
RssOpts_FeedUrl | String | False | No | The URL for the RSS feed. | |
RssOpts_Frequency | String | False | No | The frequency of the RSS-to-Email campaign ('daily', 'weekly', 'monthly'). | |
RssOpts_Schedule | String | False | No | The schedule for sending the RSS campaign. | |
RssOpts_LastSent | String | True | No | The date the campaign was last sent. | |
RssOpts_ConstrainRssImg | Boolean | False | No | If true we will add css to images in the rss feed to constrain their width in the campaign content. | |
AbSplitOpts_SplitTest | String | False | No | The type of AB split to run ('subject', 'from_name', or 'schedule'). | |
AbSplitOpts_PickWinner | String | False | No | How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. | |
AbSplitOpts_WaitUnits | String | False | No | How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. | |
AbSplitOpts_WaitTime | Integer | False | No | The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. | |
AbSplitOpts_SplitSize | Integer | False | No | The 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_FromNameA | String | False | No | For campaigns split on 'From Name', the name for Group A. | |
AbSplitOpts_FromNameB | String | False | No | For campaigns split on 'From Name', the name for Group B. | |
AbSplitOpts_ReplyEmailA | String | False | No | For campaigns split on 'From Name', the reply-to address for Group A. | |
AbSplitOpts_ReplyEmailB | String | False | No | For campaigns split on 'From Name', the reply-to address for Group B. | |
AbSplitOpts_SubjectA | String | False | No | For campaings split on 'Subject Line', the subject line for Group A. | |
AbSplitOpts_SubjectB | String | False | No | For campaings split on 'Subject Line', the subject line for Group B. | |
AbSplitOpts_SendTimeA | Datetime | False | No | The send time for Group A. | |
AbSplitOpts_SendTimeB | Datetime | False | No | The send time for Group B. | |
AbSplitOpts_SendTimeWinner | Datetime | False | No | The send time for the winning version. | |
SocialCard_ImageUrl | String | False | No | The url for the header image for the card. | |
SocialCard_Description | String | False | No | A short summary of the campaign to display. | |
SocialCard_Title | String | False | No | The title for the card. Typically the subject line of the campaign. | |
ReportSummary | String | False | No | For sent campaigns, a summary of opens, clicks, and unsubscribes. | |
DeliveryStatus | String | False | No | Updates on campaigns in the process of sending. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that uniquely identifies this message | |
ConversationId [KEY] | String | True | Conversations.Id | No | A string that identifies this message's conversation |
ListId [KEY] | String | True | Lists.Id | No | The unique identifier of the list this conversation is associated with |
FromLabel | String | True | No | A label representing the sender of this message | |
FromEmail | String | False | No | A label representing the email of the sender of this message | |
Subject | String | False | No | The subject of this message | |
Message | String | False | No | The plain-text content of the message | |
Read | Boolean | False | No | Whether or not this message has been marked as read | |
Timestamp | Datetime | True | No | Date the message was either sent or received |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that uniquely identifies this conversation | |
MessageCount | Integer | True | No | The total number of messages in this conversation | |
CampaignId [KEY] | String | True | Campaigns.Id | No | The unique identifier of the campaign this conversation is associated with |
ListId [KEY] | String | True | No | The unique identifier of the list this conversation is associated with | |
UnreadMessages | Integer | True | No | The number of unread messages in this conversation | |
FromLabel | String | True | No | A label representing the sender of this message | |
FromEmail | String | True | No | A label representing the email of the sender of this message | |
Subject | String | True | No | The subject of the message | |
LastMessage_FromLabel | String | True | No | A label representing the sender of this message | |
LastMessage_FromEmail | String | True | No | A label representing the email of the sender of this message | |
LastMessage_Subject | String | True | No | The subject of this message | |
LastMessage_Message | String | True | No | The plain-text content of the message | |
LastMessage_Read | Boolean | False | No | Whether or not this message has been marked as read | |
LastMessage_Timestamp | Datetime | True | No | Date the message was either sent or received |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StoreId [KEY] | String | False | No | The StoreId for the table. | |
CartId [KEY] | String | False | No | The CartId for the table. | |
Id [KEY] | String | False | No | A unique identifier for the cart line item. | |
ProductId | String | False | No | A unique identifier for the product associated with the cart line item. | |
ProductTitle | String | True | No | The name of the product for the cart line item. | |
ProductVariantId | String | False | No | A unique identifier for the product variant associated with the cart line item. | |
ProductVariantTitle | String | True | No | The name of the product variant for the cart line item. | |
Quantity | Integer | False | No | The quantity of a cart line item. | |
Price | Decimal | False | No | The price of a cart line item. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StoreId [KEY] | String | False | No | The StoreId for the table. | |
Id [KEY] | String | False | No | A unique identifier for the cart. | |
Customer | String | False | No | Information about a specific customer. Carts for existing customers should include only the id parameter in the customer object body. | |
CampaignId | String | False | Campaigns.Id | No | A string that uniquely identifies the campaign associated with a cart. |
CheckoutUrl | String | False | No | The URL for the cart. | |
CurrencyCode | String | False | No | The three-letter ISO 4217 code for the currency that the cart uses. | |
OrderTotal | Decimal | False | No | The order total for the cart. | |
TaxTotal | Decimal | False | No | The total tax for the cart. | |
Lines | String | False | No | An array of the cart's line items. The column will not work for Update. Lines can be updated using EcommerceCartLines table. | |
CreatedAt | Datetime | True | No | The date and time when the cart was created. | |
UpdatedAt | Datetime | True | No | The date and time when the cart was last updated. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StoreId [KEY] | String | False | No | The StoreId for the table. | |
Id [KEY] | String | False | No | A unique identifier for the customer. | |
EmailAddress | String | False | No | The customer's email address. | |
OptInStatus | Boolean | False | No | The 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. | |
Company | String | False | No | The customer's company. | |
FirstName | String | False | No | The customer's first name. | |
LastName | String | False | No | The customer's last name. | |
OrdersCount | Integer | True | No | The customer's total order count. | |
TotalSpent | Decimal | True | No | The total amount the customer has spent. | |
Address_Address1 | String | False | No | The mailing address of the customer. | |
Address_Address2 | String | False | No | An additional field for the customer's mailing address. | |
Address_City | String | False | No | The city the customer is located in. | |
Address_Province | String | False | No | The customer's state name or normalized province. | |
Address_ProvinceCode | String | False | No | The two-letter code for the customer's province or state. | |
Address_PostalCode | String | False | No | The customer's postal or zip code. | |
Address_Country | String | False | No | The customer's country. | |
Address_CountryCode | String | False | No | The two-letter code for the customer's country. | |
CreatedAt | Datetime | True | No | The date and time the customer was created. | |
UpdatedAt | Datetime | True | No | The date and time the customer was last updated. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StoreId [KEY] | String | False | No | The StoreId for the table. | |
OrderId [KEY] | String | False | No | The OrderId for the table. | |
Id [KEY] | String | False | No | A unique identifier for the order line item. | |
ProductId | String | False | No | A unique identifier for the product associated with the order line item. | |
ProductTitle | String | True | No | The name of the product for the order line item. | |
ProductVariantId | String | False | No | A unique identifier for the product variant associated with the order line item. | |
ProductVariantTitle | String | True | No | The name of the product variant for the order line item. | |
Quantity | Integer | False | No | The quantity of an order line item. | |
Price | Decimal | False | No | The price of an ecommerce order line item. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StoreId [KEY] | String | False | No | The StoreId for the table. | |
Id [KEY] | String | False | No | A unique identifier for the order. | |
Customer | String | False | No | Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body. | |
CampaignId | String | False | Campaigns.Id | No | A string that uniquely identifies the campaign associated with an order. |
FinancialStatus | String | False | No | The order status. For example: refunded , processing , cancelled , etc. | |
FulfillmentStatus | String | False | No | The fulfillment status for the order. For example: partial , fulfilled , etc. | |
CurrencyCode | String | False | No | The three-letter ISO 4217 code for the currency that the store accepts. | |
OrderTotal | Decimal | False | No | The order total for the order. | |
TaxTotal | Decimal | False | No | The tax total for the order. | |
ShippingTotal | Decimal | False | No | The shipping total for the order. | |
TrackingCode | String | False | No | The MailChimp tracking code for the order. Uses the 'mc_tc' parameter in eCommerce360-enabled tracking urls. | |
ProcessedAtForeign | Datetime | False | No | The date and time the order was processed. | |
CancelledAtForeign | Datetime | False | No | The date and time the order was cancelled. | |
UpdatedAtForeign | Datetime | False | No | The date and time the order was updated. | |
ShippingAddress_Name | String | False | No | The name associated with an order's shipping address. | |
ShippingAddress_Address1 | String | False | No | The shipping address for the order. | |
ShippingAddress_Address2 | String | False | No | An additional field for the shipping address. | |
ShippingAddress_City | String | False | No | The city in the order's shipping address. | |
ShippingAddress_Province | String | False | No | The state or normalized province in the order's shipping address. | |
ShippingAddress_ProvinceCode | String | False | No | The two-letter code for the province or state the order's shipping address is located in. | |
ShippingAddress_PostalCode | String | False | No | The postal or zip code in the order's shipping address. | |
ShippingAddress_Country | String | False | No | The country in the order's shipping address. | |
ShippingAddress_CountryCode | String | False | No | The two-letter code for the country in the shipping address. | |
ShippingAddress_Longitude | Double | False | No | The longitude for the shipping address location. | |
ShippingAddress_Latitude | Double | False | No | The latitude for the shipping address location. | |
ShippingAddress_Phone | String | False | No | The phone number for the order's shipping address | |
ShippingAddress_Company | String | False | No | The company associated with an order's shipping address. | |
BillingAddress_Name | String | False | No | The name associated with an order's billing address. | |
BillingAddress_Address1 | String | False | No | The billing address for the order. | |
BillingAddress_Address2 | String | False | No | An additional field for the billing address. | |
BillingAddress_City | String | False | No | The city in the billing address. | |
BillingAddress_Province | String | False | No | The state or normalized province in the billing address. | |
BillingAddress_ProvinceCode | String | False | No | The two-letter code for the province or state in the billing address. | |
BillingAddress_PostalCode | String | False | No | The postal or zip code in the billing address. | |
BillingAddress_Country | String | False | No | The country in the billing address. | |
BillingAddress_CountryCode | String | False | No | The two-letter code for the country in the billing address. | |
BillingAddress_Longitude | Double | False | No | The longitude for the billing address location. | |
BillingAddress_Latitude | Double | False | No | The latitude for the billing address location. | |
BillingAddress_Phone | String | False | No | The phone number for the billing address. | |
BillingAddress_Company | String | False | No | The company associated with the billing address. | |
Lines | String | False | No | An array of the order's line items. The column will not work for Update. Lines can be updated using EcommerceOrderLines table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StoreId [KEY] | String | False | No | The StoreId for the table. | |
Id [KEY] | String | False | No | A unique identifier for the product. | |
Title | String | False | No | The title of a product. | |
Handle | String | False | No | The handle of a product. | |
Url | String | False | No | The URL of a product. | |
Description | String | False | No | The description of a product. | |
Type | String | False | No | The type of product. | |
Vendor | String | False | No | The vendor for a product. | |
ImageUrl | String | False | No | The image URL for a product. | |
Variants | String | False | No | An array of the product's variants. | |
PublishedAtForeign | Datetime | False | No | The date and time when the product was published. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StoreId [KEY] | String | False | No | The StoreId for the table. | |
ProductId [KEY] | String | False | No | The ProductId for the table. | |
Id [KEY] | String | False | No | A unique identifier for the product variant. | |
Title | String | False | No | The title of a product variant. | |
Url | String | False | No | The URL of a product variant. | |
Sku | String | False | No | The stock keeping unit (SKU) of a product variant. | |
Price | Decimal | False | No | The price of a product variant. | |
InventoryQuantity | Integer | False | No | The inventory quantity of a product variant. | |
ImageUrl | String | False | No | The image URL for a product variant. | |
Backorders | String | False | No | The backorders of a product variant. | |
Visibility | String | False | No | The visibility of a product variant. | |
CreatedAt | Datetime | True | No | The date and time when the product was created. | |
UpdatedAt | Datetime | True | No | The date and time the product was last updated. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identifier for the store. | |
ListId [KEY] | String | True | Lists.Id | No | The unique identifier for the MailChimp list that's associated with the store. The list_id for a specific store can't change. |
Name | String | False | No | The name of the store. | |
Platform | String | False | No | The ecommerce platform of the store. | |
Domain | String | False | No | The store domain. | |
EmailAddress | String | False | No | The email address for the store. | |
CurrencyCode | String | False | No | The three-letter ISO 4217 code for the currency that the store accepts. | |
MoneyFormat | String | False | No | The currency format for the store. For example: $ , etc. | |
PrimaryLocale | String | False | No | The primary locale for the store. For example: en , de , etc. | |
Timezone | String | False | No | The timezone for the store. | |
Phone | String | False | No | The store phone number. | |
Address_Address1 | String | False | No | The store's mailing address. | |
Address_Address2 | String | False | No | An additional field for the store's mailing address. | |
Address_City | String | False | No | The city the store is located in. | |
Address_Province | String | False | No | The store's state name or normalized province. | |
Address_ProvinceCode | String | False | No | The two-letter code for the store's province or state. | |
Address_PostalCode | String | False | No | The store's postal or zip code. | |
Address_Country | String | False | No | The store's country. | |
Address_CountryCode | String | False | No | The two-letter code for to the store's country. | |
Address_Longitude | Double | False | No | The longitude of the store location. | |
Address_Latitude | Double | False | No | The latitude of the store location. | |
CreatedAt | Datetime | True | No | The date and time the store was created. | |
UpdatedAt | Datetime | True | No | The date and time the store was last updated. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique id given to the file. | |
FolderId | Integer | False | No | The id of the folder. | |
Type | String | True | No | The type of file in the gallery: Image or file. | |
Name | String | False | No | The name of the file. | |
FullSizeUrl | String | True | No | The url of the full-size file. | |
ThumbnailUrl | String | True | No | The url of the thumbnail preview. | |
Size | Integer | True | No | The size of the file in bytes. | |
CreatedAt | Datetime | True | No | The date and time a file was added to the gallery. | |
CreatedBy | String | True | No | The username of the profile that uploaded the file. | |
Width | Integer | True | No | The width of the image. | |
Height | Integer | True | No | The height of an image. | |
FileData | String | False | No | When adding a new file, the base64-encoded file. Required for INSERT statement. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique id given to the folder. | |
Name | String | False | No | The name of the folder. | |
FileCount | Integer | True | No | The number of files within the folder. | |
CreatedAt | Datetime | True | No | The date and time a file was added to the gallery. | |
CreatedBy | String | True | No | The username of the profile that created the folder. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The id for the abuse report | |
CampaignId [KEY] | String | True | Campaigns.Id | No | The campaign id for the abuse report |
ListId [KEY] | String | True | Lists.Id | No | The list id for the abuse report. |
EmailId [KEY] | String | True | No | The MD5 hash of the list member's email address. | |
EmailAddress | String | True | No | Email address for a subscriber | |
Date | String | True | No | Date for the abuse report |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ListId [KEY] | String | True | Lists.Id | No | The ListId for the table. |
Day [KEY] | Date | True | No | The date for the activity summary. | |
EmailsSent | Integer | True | No | The total number of emails sent on the date for the activity summary. | |
UniqueOpens | Integer | True | No | The number of unique opens. | |
RecipientClicks | Integer | True | No | The number of clicks. | |
HardBounce | Integer | True | No | The number of hard bounces. | |
SoftBounce | Integer | True | No | The number of soft bounces | |
Subs | Integer | True | No | The number of subscribes. | |
Unsubs | Integer | True | No | The number of unsubscribes. | |
OtherAdds | Integer | True | No | The number of subscribers who may have been added outside of the double opt-in process such as imports or API activity. | |
OtherRemoves | Integer | True | No | The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam. For example, deleted subscribers. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Client | String | True | No | The name of the email client. | |
Members | Integer | True | No | The number of subscribed members who used this email client. | |
ListId [KEY] | String | True | Lists.Id | No | The unique id for the list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ListId [KEY] | String | True | Lists.Id | No | The list id for the growth activity report. |
Month [KEY] | String | True | No | The month that the growth history is describing. | |
Subscribed | Integer | True | No | Total subscribed members on the list at the end of the month. | |
Unsubscribed | Integer | True | No | Newly unsubscribed members on the list for a specific month. | |
Reconfirm | Integer | True | No | Newly reconfirmed members on the list for a specific month. | |
Cleaned | Integer | True | No | Newly cleaned (hard-bounced) members on the list for a specific month. | |
Pending | Integer | True | No | Pending members on the list for a specific month. | |
Deleted | Integer | True | No | Newly deleted members on the list for a specific month. | |
Transactional | Integer | True | No | Subscribers that have been sent transactional emails via Mandrill. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ListId [KEY] | String | False | Lists.Id | No | The ID for the list that this category belongs to. |
Id [KEY] | String | True | No | ||
Title | String | False | No | The text description of this category. This field is displayed on signup forms and is often phrased as a question. | |
DisplayOrder | Integer | False | No | Order in which the categories display in the list. Lower numbers display first. | |
Type | String | False | No | Determines how this category's interests are displayed on signup forms. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CategoryId [KEY] | String | False | No | The id for the interest category. | |
ListId [KEY] | String | False | Lists.Id | No | The ID for the list that this interest belongs to. |
Id [KEY] | String | True | No | The ID for the interest. | |
Name | String | False | No | The name of the interest. This can be shown publicly on a subscription form. | |
SubscriberCount | String | True | No | The number of subscribers associated with this interest. | |
DisplayOrder | Integer | False | No | Order in which the interests display. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
MemberId [KEY] | String | True | ListMembers.Id | No | The MemberId of the member to get events for. |
EmailId [KEY] | String | True | No | The EmailId for the table. | |
ListId [KEY] | String | True | Lists.Id | No | The ListId for the table. |
Action | String | False | No | The type of action recorded for the subscriber. | |
Timestamp [KEY] | Datetime | False | No | The date and time recorded for the action. | |
Url | String | False | No | For clicks, the URL the subscriber clicked on. | |
Type | String | False | No | The type of campaign that was sent. | |
CampaignId [KEY] | String | False | Campaigns.Id | No | The web-based ID for the campaign. |
Title | String | False | No | If set, the campaign's title. | |
ParentCampaign | String | False | No | The ID of the parent campaign. | |
ContactId | String | True | No | The ID of the contact. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name | String | False | No | The name of the event. | |
OccurredAt | Datetime | False | No | The occurred datetime of the event. | |
Properties | String | False | No | Properties of the event in an aggregate JSON Format. | |
ListId [KEY] | String | False | Lists.Id | No | The unique id for the list. |
MemberId [KEY] | String | False | ListMembers.Id | No | The MD5 hash of the list member's email address. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | The note's ID. | |
CreatedAt | Datetime | True | No | The date the note was created. | |
CreatedBy | String | True | No | The author of the note. | |
UpdatedAt | Datetime | True | No | The date the note was last updated | |
Note | String | False | No | The content of the note. | |
ListId [KEY] | String | False | Lists.Id | No | The unique id for the list. |
MemberId [KEY] | String | False | ListMembers.Id | No | The MD5 hash of the list member's email address. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The MD5 hash of the list member's email address. | |
EmailAddress | String | False | No | Email address for a subscriber. | |
UniqueEmailId [KEY] | String | True | No | An identifier for the address across all of MailChimp. | |
EmailType | String | False | No | Type of email this member asked to get ('html' or 'text'). | |
FullName | String | True | No | The contact's full name. | |
Status | String | False | No | Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', 'pending' or 'transactional'). | |
StatusIfNew | String | False | No | Subscriber'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. | |
Interests | String | False | No | The key of this object's properties is the ID of the interest in question. | |
Stats_AvgOpenRate | Double | True | No | A subscriber's average open rate. | |
Stats_AvgClickRate | Double | True | No | A subscriber's average clickthrough rate. | |
IpSignup | String | False | No | IP address the subscriber signed up from. | |
TimestampSignup | Datetime | False | No | Date and time the subscriber signed up for the list. | |
IpOpt | String | False | No | IP address the subscriber confirmed their opt-in status. | |
TimestampOpt | Datetime | False | No | Date and time the subscribe confirmed their opt-in status. | |
MemberRating | Integer | True | No | Star rating for this member between 1 and 5. | |
LastChanged | Datetime | True | No | Date and time the member's info was last changed. | |
Language | String | False | No | If set/detected, the language of the subscriber. | |
Vip | Boolean | False | No | VIP status for subscriber. | |
EmailClient | String | True | No | The email client the address as using. | |
Location_Latitude | Double | False | No | ||
Location_Longitude | Double | False | No | ||
Location_Gmtoff | Integer | True | No | ||
Location_Dstoff | Integer | True | No | ||
Location_CountryCode | String | True | No | ||
Location_Timezone | String | True | No | ||
LastNote_NoteId | Integer | True | ListMemberNotes.Id | No | The note's ID. |
LastNote_CreatedAt | String | True | No | The date the note was created. | |
LastNote_CreatedBy | String | True | No | The author of the note. | |
LastNote_Note | String | True | No | The content of the note. | |
ListId [KEY] | String | False | Lists.Id | No | The id for the list. |
TagsAggregate | String | False | No | Tags of the member, displayed as an aggregate. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique ID of the tag. | |
Name | String | False | No | Name of the tag. When inserting, if the name doesn't exist, it will be created and then assigned to the member specified. | |
TimeAdded | Datetime | True | No | Date and time the tag was added to the member. | |
ListId | String | False | Lists.Id | No | The ID of the list on which the member of this tag belongs to. |
MemberId | String | False | ListMembers.Id | No | The ID of the member this tag is assigned to. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
MergeId [KEY] | Integer | True | No | An unchanging id for the merge field. | |
Tag | String | False | No | The tag used in MailChimp campaigns and for the /members endpoint. | |
Name | String | False | No | ||
Type | String | False | No | The type for the merge field. | |
Required | Boolean | False | No | Boolean value for if the merge field is required | |
DefaultValue | String | False | No | The default value for the merge field if null. | |
Public | Boolean | False | No | Whether or not the merge field is displayed on the signup form. | |
DisplayOrder | Integer | False | No | The order on the form where the merge field is displayed. | |
Options_DefaultCountry | Integer | False | No | In an address field, the default country code if none supplied. | |
Options_PhoneFormat | String | False | No | In a phone field, the phone number type: US or International. | |
Options_DateFormat | String | False | No | In a date or birthday field, the format of the date. | |
Options_Choices | String | False | No | In a radio or dropdown non-group field, the available options for members to pick from. | |
Options_Size | Integer | False | No | In a text field, the default length of the text field. | |
HelpText | String | False | No | Any extra text to help the subscriber. | |
ListId [KEY] | String | False | Lists.Id | No | A string that identifies this merge field collections' list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that uniquely identifies this list | |
Name | String | False | No | The name of the list. | |
Contact_Company | String | False | No | The company name associated with the list. | |
Contact_Address1 | String | False | No | The street address for the list contact. | |
Contact_Address2 | String | False | No | The street address for the list contact. | |
Contact_City | String | False | No | The city for the list contact. | |
Contact_State | String | False | No | The state for the list contact. | |
Contact_Zip | String | False | No | The postal or zip code for the list contact. | |
Contact_Country | String | False | No | A two-character ISO3166 country code. Defaults to US if invalid. | |
Contact_Phone | String | False | No | The phone number for the list contact. | |
PermissionReminder | String | False | No | The 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. | |
UseArchiveBar | Boolean | False | No | Whether or not campaigns for this list use the Archive Bar in archives by default. | |
CampaignDefaults_FromName | String | False | No | The default from name for campaigns sent to this list. | |
CampaignDefaults_FromEmail | String | False | No | The default from email (must be a valid email address) for campaigns sent to this list. | |
CampaignDefaults_Subject | String | False | No | The default subject line for campaigns sent to this list. | |
CampaignDefaults_Language | String | False | No | The default language for this lists's forms. | |
NotifyOnSubscribe | String | False | No | The email address to send subscribe notifications to, when enabled. | |
NotifyOnUnsubscribe | String | False | No | The email address to send unsubscribe notifications to, when enabled. | |
DateCreated | Datetime | True | No | The date and time that this list was created. | |
ListRating | Integer | True | No | An auto-generated activity score for the list (0-5). | |
EmailTypeOption | Boolean | False | No | Whether or not the list supports multiple formats for emails. | |
SubscribeUrlShort | String | True | No | Our eepurl shortened version of this list's subscribe form. | |
SubscribeUrlLong | String | True | No | The full version of this list's subscribe form (host will vary). | |
BeamerAddress | String | True | No | The email address to use for this list's Email Beamer. | |
Visibility | String | False | No | Whether this list is public (pub) or private (prv). Used internally for projects like Wavelength. | |
Modules | String | True | No | Any list-specific modules installed for this list. | |
Stats_MemberCount | Integer | True | No | The number of active members in the given list. | |
Stats_UnsubscribeCount | Integer | True | No | The number of members who have unsubscribed from the given list. | |
Stats_CleanedCount | Integer | True | No | The number of members cleaned from the given list. | |
Stats_MemberCountSinceSend | Integer | True | No | The number of active members in the given list since the last campaign was sent. | |
Stats_UnsubscribeCountSinceSend | Integer | True | No | The number of members who have unsubscribed since the last campaign was sent. | |
Stats_CleanedCountSinceSend | Integer | True | No | The number of members cleaned from the given list since the last campaign was sent. | |
Stats_CampaignCount | Integer | True | No | The number of campaigns in any status that use this list. | |
Stats_CampaignLastSent | Datetime | True | No | The date and time the last campaign was sent to this list. | |
Stats_MergeFieldCount | Integer | True | No | The number of merge vars for this list (not including the required EMAIL one). | |
Stats_AvgSubRate | Double | True | No | The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). | |
Stats_AvgUnsubRate | Double | True | No | The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). | |
Stats_TargetSubRate | Double | True | No | The target numberof subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). | |
Stats_OpenRate | Double | True | No | 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). | |
Stats_ClickRate | Double | True | No | 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). | |
Stats_LastSubDate | Datetime | True | No | The date and time of the last time someone subscribed to this list. | |
Stats_LastUnsubDate | Datetime | True | No | The date and time of the last time someone unsubscribed from this list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The MD5 hash of the list member's email address. | |
EmailAddress | String | False | No | Email address for a subscriber. | |
UniqueEmailId [KEY] | String | True | No | An identifier for the address across all of MailChimp. | |
EmailType | String | True | No | Type of email this member asked to get ('html' or 'text'). | |
Status | String | True | No | Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'). | |
StatusIfNew | String | True | No | Subscriber'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. | |
Interests | String | True | No | The key of this object's properties is the ID of the interest in question. | |
Stats_AvgOpenRate | Double | True | No | A subscriber's average open rate. | |
Stats_AvgClickRate | Double | True | No | A subscriber's average clickthrough rate. | |
IpSignup | String | True | No | IP address the subscriber signed up from. | |
TimestampSignup | Datetime | True | No | Date and time the subscriber signed up for the list. | |
IpOpt | String | True | No | IP address the subscriber confirmed their opt-in status. | |
TimestampOpt | Datetime | True | No | Date and time the subscribe confirmed their opt-in status. | |
MemberRating | Integer | True | No | Star rating for this member between 1 and 5. | |
LastChanged | Datetime | True | No | Date and time the member's info was last changed. | |
Language | String | True | No | If set/detected, the language of the subscriber. | |
Vip | Boolean | True | No | VIP status for subscriber. | |
EmailClient | String | True | No | The email client the address as using. | |
Location_Latitude | Double | True | No | ||
Location_Longitude | Double | True | No | ||
Location_Gmtoff | Integer | True | No | ||
Location_Dstoff | Integer | True | No | ||
Location_CountryCode | String | True | No | ||
Location_Timezone | String | True | No | ||
LastNote_NoteId | Integer | True | ListMemberNotes.Id | No | The note's ID. |
LastNote_CreatedAt | String | True | No | The date the note was created. | |
LastNote_CreatedBy | String | True | No | The author of the note. | |
LastNote_Note | String | True | No | The content of the note. | |
ListId [KEY] | String | False | Lists.Id | No | The id for the list. |
SegmentId [KEY] | String | False | ListSegments.Id | No | The id for the segment. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | An integer to uniquely identify the segment. | |
Name | String | False | No | The name of the segment. | |
MemberCount | Integer | True | No | The number of active subscribers currently included in the segment. | |
Type | String | True | No | The type of segment: saved, static, or fuzzy. | |
CreatedAt | Datetime | True | No | The time and date the segment was created. | |
UpdatedAt | Datetime | True | No | The time and date the segment was last updated. | |
Options_Match | String | False | No | Match type of 'any' or 'all'. | |
Options_Conditions | String | False | No | An array of segment conditions. | |
ListId [KEY] | String | False | Lists.Id | No | The id for the list. |
EmailList | String | False | Yes | A comma-separated list of emails that you want to include in this ListSegment. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Header_ImageUrl | String | False | No | Header Image Url | |
Header_Text | String | False | No | Header Text | |
Header_ImageWidth | String | False | No | Image width | |
Header_ImageHeight | String | False | No | Image height | |
Header_ImageAlt | String | False | No | Image Alt | |
Header_ImageLink | String | False | No | Image Link | |
Header_ImageAlign | String | False | No | Image align | |
Header_ImageBorderWidth | String | False | No | Image border width | |
Header_ImageBorderStyle | String | False | No | Image border style | |
Header_ImageBorderColor | String | False | No | Image border color | |
Header_ImageTarget | String | False | No | Image target | |
Contents | String | False | No | Signup form body contents options | |
Styles | String | False | No | An array of objects, each representing each element of signup forms. | |
SignupFormUrl | String | False | No | Signup form URL | |
ListId [KEY] | String | True | Lists.Id | No | A string that identifies this signup forms' list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | An identifier for the webhook across all of MailChimp. | |
Url | String | False | No | the URL for this Webhook. | |
Events_Subscribe | Boolean | False | No | ||
Events_Unsubscribe | Boolean | False | No | ||
Events_Profile | Boolean | False | No | ||
Events_Cleaned | Boolean | False | No | ||
Events_Upemail | Boolean | False | No | ||
Events_Campaign | Boolean | False | No | ||
Sources_User | Boolean | False | No | ||
Sources_Admin | Boolean | False | No | ||
Sources_Api | Boolean | False | No | ||
ListId [KEY] | String | False | Lists.Id | No | The id for the list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique id for the abuse report. | |
CampaignId [KEY] | String | True | Campaigns.Id | No | The campaign id for the abuse report |
ListId [KEY] | String | True | Lists.Id | No | The list id for the abuse report. |
EmailId [KEY] | String | True | No | The list-specific ID for the given email address | |
EmailAddress | String | True | No | Email address for a subscriber | |
Date | String | True | No | Date for the abuse report |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CampaignId | String | True | Campaigns.Id | No | The CampaignId for the table. |
Type | String | True | No | The 'type' of message ('negative', 'positive', 'neutral'). | |
Message | String | True | No | The advice message. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | ||
Url | String | True | No | The URL for the link in the campaign. | |
TotalClicks | Integer | True | No | The number of total clicks for a given link. | |
ClickPercentage | Double | True | No | The percentage of total clicks a given link generated for a campaign. | |
UniqueClicks | Integer | True | No | Number of unique clicks for a given link. | |
UniqueClickPercentage | Double | True | No | The percentage of unique clicks a given link generated for a campaign. | |
LastClick | Datetime | True | No | The date and time for the last recorded click for a given link. | |
AbSplit_A | String | False | No | ||
AbSplit_B | String | False | No | ||
CampaignId [KEY] | String | True | Campaigns.Id | No | The id for the campaign. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
EmailId [KEY] | String | True | No | The list-specific ID for the given email address. | |
EmailAddress | String | True | No | Email address for a subscriber | |
Clicks | Integer | True | No | The total number of times the subscriber clicked on the link. | |
CampaignId [KEY] | String | True | Campaigns.Id | No | The id for the campaign. |
UrlId [KEY] | String | True | No | The id for the tracked URL in the campaign. | |
ListId [KEY] | String | True | Lists.Id | No | The id for the list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CampaignId | String | True | Campaigns.Id | No | The CampaignId for the table. |
Domain | String | True | No | The name of the domain (gmail.com, hotmail.com, yahoo.com). | |
EmailsSent | Integer | True | No | The number of emails sent to that specific domain. | |
Bounces | Integer | True | No | The number of bounces at a domain. | |
Opens | Integer | True | No | The number of opens for a domain. | |
Clicks | Integer | True | No | The number of clicks for a domain. | |
Unsubs | Integer | True | No | The total number of unsubscribes for a domain. | |
Delivered | Integer | True | No | The number of successful deliveries for a domain. | |
EmailsPct | Double | True | No | The percentage of total emails that went to this domain. | |
BouncesPct | Double | True | No | The percentage of total bounces that came from this domain. | |
OpensPct | Double | True | No | The percentage of total opens that came from this domain. | |
ClicksPct | Double | False | No | The percentage of total clicks tht came from this domain. | |
UnsubsPct | Double | True | No | The percentage of total unsubscribes taht came from this domain. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CampaignId [KEY] | String | True | Campaigns.Id | No | The unique id for the campaign. |
ListId [KEY] | String | True | Lists.Id | No | The unique id for the list. |
EmailId [KEY] | String | True | No | The list-specific ID for the given email address. | |
EmailAddress | String | True | No | Email address for a subscriber | |
Activity | String | False | No | An array of objects, each showing an interaction with the email. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CampaignId [KEY] | String | True | Campaigns.Id | No | The CampaignId for the table. |
Region [KEY] | String | True | No | A more specific location area such as city or state. | |
Opens | Integer | True | No | The number of unique campaign opens for a given region. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | A string that uniquely identifies this campaign. | |
CampaignTitle | String | True | No | The title of the campaign. | |
Type | String | False | No | The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). | |
EmailsSent | Integer | False | No | The total number of emails sent for this campaign. | |
AbuseReports | Integer | False | No | The number of abuse reports generated for this campaign. | |
Unsubscribed | Integer | True | No | The total number of unsubscribed members for this campaign. | |
SendTime | Datetime | True | No | The time and date a campaign was sent. | |
Bounces_HardBounces | Integer | False | No | The total number of hard bounced email addresses. | |
Bounces_SoftBounces | Integer | False | No | The total number of soft bounced email addresses. | |
Bounces_SyntaxErrors | Integer | False | No | The total number of addresses that were syntax-related bounces. | |
Forwards_ForwardsCount | Integer | False | No | ||
Forwards_ForwardsOpens | Integer | False | No | ||
Opens_OpensTotal | Integer | False | No | The total number of opens for a campaign. | |
Opens_UniqueOpens | Integer | False | No | The total number of unique subscribers who opened a campaign. | |
Opens_OpenRate | Double | False | No | The number of unique subscribers who opened divided by the total number of successful deliveries. | |
Opens_LastOpen | Datetime | False | No | The date and time of the last recorded open. | |
Clicks_ClicksTotal | Integer | False | No | The total number of clicks for the campaign. | |
Clicks_UniqueClicks | Integer | False | No | The total number of unique clicks for links across a campaign. | |
Clicks_UniqueSubscriberClicks | Integer | False | No | The total number of subscribers who clicked on a campaign. | |
Clicks_ClickRate | Double | False | No | The number of unique subscribers who clicked divided by the total number of successful deliveries. | |
Clicks_LastClick | Datetime | False | No | The date and time of the last recorded click for the campaign. | |
FacebookLikes_RecipientLikes | Integer | False | No | ||
FacebookLikes_UniqueLikes | Integer | False | No | ||
FacebookLikes_FacebookLikes | Integer | False | No | ||
IndustryStats_Type | String | False | No | ||
IndustryStats_OpenRate | Double | False | No | ||
IndustryStats_ClickRate | Double | False | No | ||
IndustryStats_BounceRate | Double | False | No | ||
IndustryStats_UnopenRate | Double | False | No | ||
IndustryStats_UnsubRate | Double | False | No | ||
IndustryStats_AbuseRate | Double | False | No | ||
ListStats_SubRate | Double | True | No | The average number of subscriptions per month for the list. | |
ListStats_UnsubRate | Double | True | No | The average number of unsubscriptions per month for the list. | |
ListStats_OpenRate | Double | True | No | The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. | |
ListStats_ClickRate | Double | True | No | The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. | |
AbSplit_A | String | False | No | ||
AbSplit_B | String | False | No | ||
Timewarp | String | False | No | An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. | |
Timeseries | String | False | No | An hourly breakdown of the performance of the campaign over the first 24 hours. | |
ShareReport_ShareUrl | String | True | No | The URL for the VIP report. | |
ShareReport_SharePassword | String | True | No | If password protected, the password for the VIP report. | |
DeliveryStatus | String | False | No | Updates on campaigns in the process of sending. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
EmailId [KEY] | String | True | No | The list-specific ID for the given email address. | |
EmailAddress | String | True | No | Email address for a subscriber. | |
Status | String | False | No | The status of the member ('sent', 'hard' for hard bounce, or 'soft' for soft bounce). | |
OpenCount | Integer | False | No | The number of times a campaign was opened by this member. | |
LastOpen | String | False | No | The date and time of the last open for this member. | |
AbsplitGroup | String | False | No | For A/B Split Campaigns, the group the member was apart of ('a', 'b', or 'winner'). | |
GmtOffset | Integer | False | No | For campaigns sent with timewarp, the time zone group the member is apart of. | |
CampaignId [KEY] | String | True | Campaigns.Id | No | The id for the campaign. |
ListId [KEY] | String | True | Lists.Id | No | The id for the list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
EmailId [KEY] | String | True | No | The list-specific ID for the given email address | |
EmailAddress | String | True | No | Email address for a subscriber | |
Timestamp | Datetime | True | No | The date and time the member opted-out. | |
Reason | String | True | No | If available, the reason listed by the member for unsubscribing. | |
CampaignId [KEY] | String | True | Campaigns.Id | No | The id for the campaign. |
ListId [KEY] | String | True | Lists.Id | No | The id for the list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The ID for the survey response. | |
SubmittedAt | Datetime | True | No | The date and time when the survey response was submitted. | |
ContactEmailId | String | True | No | The MD5 hash of the lowercase version of the list member email address. | |
ContactId | String | True | No | The ID of this contact. | |
ContactStatus | String | True | No | The contact's current status. | |
ContactEmail | String | True | No | The contact's email address. | |
ContactFullName | String | True | No | The contact's full name. | |
ContactConsentsToOneToOneMessaging | Boolean | True | No | Indicates whether a contact consents to 1:1 messaging. | |
ContactAvatarUrl | String | True | No | URL for the contact's avatar or profile image. | |
IsNewContact | Boolean | True | No | If this contact was added to the Mailchimp audience via this survey. | |
SurveyId [KEY] | String | True | Surveys.Id | No | A string that uniquely identifies this survey. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that uniquely identifies this survey. | |
WebId | Integer | True | No | The ID used in the Mailchimp web application. | |
ListId | String | True | No | The ID of the list connected to this survey. | |
ListName | String | True | No | The name of the list connected to this survey. | |
Title | String | True | No | The title of the survey. | |
Url | String | True | No | The URL for the survey. | |
Status | String | True | No | The status of the Surney. Possible values: published or unpublished. | |
PublishedAt | Datetime | True | No | The date and time the survey was published. | |
CreatedAt | Datetime | True | No | The date and time the survey was created. | |
UpdatedAt | Datetime | True | No | The date and time the survey was last updated. | |
TotalResponses | Integer | True | No | The total number of responses to this survey. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A string that uniquely identifieds this folder | |
Name | String | False | No | The name of the folder | |
Count | Integer | True | No | The number of templates in the folder |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | The individual id for the template. | |
Type | String | True | No | The type of template (user, base, or gallery). | |
Name | String | False | No | The name of the template. | |
DragAndDrop | Boolean | True | No | Whether or not the template uses the drag and drop editor. | |
Responsive | Boolean | True | No | Whether or not the template contains media queries to make it responsive. | |
Category | String | True | No | If available, the category the template is listed in. | |
DateCreated | Datetime | True | No | The date and time the template was created. | |
CreatedBy | String | True | No | The login name for template's creator. | |
Active | Boolean | False | No | User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether or not the template is still active. | |
FolderId | String | False | No | The id of the folder the template is currently in. | |
Thumbnail | String | True | No | If available, the URL for a thumbnail of the template. | |
ShareUrl | String | True | No | The URL used for template sharing. For more information, see: http://kb.mailchimp.com/templates/basic-and-themes/how-to-share-a-template |