Getting Started

This page provides a guide to Establishing a Connection to Mailchimp in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Mailchimp

Establishing a Connection shows how to authenticate to Mailchimp and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Mailchimp through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Mailchimp by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Mailchimp Marketing API

Mailchimp Marketing API supports the following authentication methods:

APIKey
OAuth

API Key

The easiest way to connect to Mailchimp Marketing API is to use the API Key. The APIKey grants full access to your Mailchimp account. To obtain the APIKey:

Log into Mailchimp.
Navigate to Account > Extras > API Keys.
Note the value of the API Key.

Once you have the value of the API Key:

Set APIKey to the value of the API Key.
Set AuthScheme to APIKey.

OAuth

Connecting to Mailchimp Transactional API

Mailchimp Transactional API supports TrasactionalAPIToken to authenticate. To obtain the TrasactionalAPIKey you must have Transactional Email enabled on your account, after that follow the following steps:

Log into Mailchimp.
Navigate to Transactional Email > Settings > API Keys.
Click Add API Key and Save the Key.
Note the value of the Trasactional API Key.

Once you have the value of the Transactional API Key:

Set TransactionalAPIKey to the value of the Transactional API Key.
Set Schema to Transactional.

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

Using MailChimp API

See MailChimp Data Model for the available entities in the MailChimp Marketing Data Model.

Using Transactional API

See Transactional Data Model for the available entities in the MailChimp Transactional Model.

MailChimp Data Model

The Data Model has three parts: Tables, Views, and Stored Procedures. The Cloud uses the Mailchimp API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Tables

The CData Cloud models the Mailchimp API in Tables so that it can be easily queried and updated.

The Cloud dynamically retrieves custom fields for the ListMembers tables when you connect; any changes you make to these custom fields, such as adding a new field or changing a custom field's data type, are reflected when you reconnect.

Dynamic tables

Along with the default static tables, the Cloud also allows querying on dynamic tables. These are tables that are created based on the "audiences" (also called "lists") in your Mailchimp account.
For example, suppose you have these 3 audiences in your account: Old Audience, New Audience, VIP Audience. For each of these audiences the Cloud creates 2 new tables: One starting with "ListMembers_" and the other with "ListMergeFields_". So, for the case in hand, these 6 tables will be created:

ListMembers_OldAudience
ListMembers_NewAudience
ListMembers_VIPAudience
ListMergeFields_OldAudience
ListMergeFields_NewAudience
ListMergeFields_VIPAudience

The above 6 tables are created by removing spaces from the audience's name and appending the result to "ListMembers" or "ListMergeFields" with an underscore.

Tables starting with "ListMembers_" display all members for a specific audience along with custom fields' values.
The ones starting with "ListMergeFields_" display all custom fields' names for members in that audience.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Dynamic views

Along with the default static views, the Cloud also allows querying on dynamic views. These are views that are created based on the "audiences" (also called "lists") in your Mailchimp account.
For example, suppose you have these 3 audiences in your account: Old Audience, New Audience, VIP Audience. The Cloud lists 3 views based on them: ListMemberTags_OldAudience, ListMemberTags_NewAudience, ListMemberTags_VIPAudience.
The above 3 views are created by removing spaces from the audience's name and appending the result to "ListMemberTags" with an underscore. They return the tags that are assigned to each member of the audience you've specified.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Tables

The Cloud models the data in Mailchimp as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Mailchimp Tables


Name	Description
CampaignFeedback	Contains feedback comments submitted by recipients regarding a campaign's content or performance.
CampaignFolders	Lists folders used to organize campaigns within the account.
Campaigns	Provides detailed information on campaigns created within the account, including type, status, and send statistics.
EcommerceCartLines	Lists individual items included in an e-commerce cart, including product details and quantities.
EcommerceCarts	Contains data on e-commerce carts associated with the account, including customer and total value information.
EcommerceCustomers	Stores records of e-commerce customers linked to Mailchimp, used for purchase tracking and segmentation.
EcommerceOrderLines	Lists line items included in e-commerce orders, such as product identifiers, quantities, and prices.
EcommerceOrders	Contains details of e-commerce orders tracked through connected stores, including order totals and customer details.
EcommerceProducts	Lists products available through connected e-commerce integrations, including titles, variants, and pricing.
EcommerceProductVariants	Contains information about product variants, such as size or color, linked to e-commerce items.
FileManagerFiles	Provides a catalog of all files and images stored in the account's File Manager, including metadata and size.
FileManagerFolders	Lists folders available in the File Manager for organizing images and files.
ListInterestCategories.rsd	The unique identifier for the interest category, used to reference or manage it within Mailchimp's segmentation and API operations.
ListInterests	Lists individual interests belonging to a specific interest category within a list.
ListMemberEvents	Contains event information related to individual list members, such as sign-ups or profile updates.
ListMemberNotes	Contains notes created for specific list members, showing the most recent entries by date.
ListMembers	Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.
ListMergeFields.rsd	The display name of the merge field as it appears in the Mailchimp list and signup forms.
Lists	Contains all audience lists in the account, including configuration details, subscriber counts, and opt-in settings.
ListSegmentMembers	Lists subscribers that belong to a specific segment, including historical membership data.
ListSegments	Provides information on available audience segments, including criteria and segment type.
ListsWebhooks	Lists webhooks configured for an audience list, used to trigger updates based on subscriber activity.
TemplateFolders	Lists folders used to organize design templates within the account.
Templates	A list an account's available templates.
TransactionalAllowlists	Lists all sender addresses or domains approved to send transactional messages through Mailchimp Transactional.
TransactionalTags	Lists available tags used to categorize transactional emails.
TransactionalTemplates	Contains all transactional email templates stored in the account.

CampaignFeedback

Contains feedback comments submitted by recipients regarding a campaign's content or performance.

Table Specific Information

SELECT, INSERT, UPDATE, and DELTE are supported for CampaignFeedback.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

FeedbackId supports the '=' operator.
CampaignId supports the '=' operator.

For example:

SELECT * FROM CampaignFeedback WHERE FeedbackId = '1245'

SELECT * FROM CampaignFeedback WHERE CampaignId = '1245'

Insert

The CampaignId and Message are required for INSERTs.

INSERT INTO CampaignFeedback (CampaignId, Message) VALUES ('myCampaignId', 'myMessage')

Columns


Name	Type	ReadOnly	Description
FeedbackId [KEY]	Integer	True	The unique identifier of the feedback entry associated with a campaign.
ParentId	Integer	True	If the feedback is a reply, this field stores the identifier of the parent feedback item.
BlockId	Integer	False	The identifier of the editable content block within the campaign that the feedback refers to.
Message	String	False	The text content of the feedback message provided by the user.
IsComplete	Boolean	False	If the value is 'true', the feedback item has been marked as resolved or completed. If the value is 'false', it remains open.
CreatedBy	String	True	The username of the Mailchimp user who submitted the feedback.
CreatedAt	Datetime	True	The date and time when the feedback entry was created.
UpdatedAt	Datetime	True	The date and time when the feedback entry was last modified.
Source	String	True	Indicates the platform or method through which the feedback was submitted, such as email, web, SMS, iOS, Android, or API.
CampaignId [KEY]	String	False	The unique identifier of the campaign to which the feedback relates.

CampaignFolders

Lists folders used to organize campaigns within the account.

Table Specific Information

SELECT, INSERT, UPDATE, and DELTE are supported for CampaignFolders.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM CampaignFolders WHERE Id = '1245'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier of the campaign folder within the Mailchimp account.
Name	String	False	The display name of the campaign folder as shown in the Mailchimp interface.
Count	Integer	True	The total number of campaigns currently stored in this folder.

Campaigns

Provides detailed information on campaigns created within the account, including type, status, and send statistics.

Table Specific Information

SELECT, UPDATE and DELETE are supported for Campaigns.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
Type supports the '=' operator.
CreateTime supports the '=,<,>,<=,>=' operator.
SendTime supports the '=,<,>,<=,>=' operator.
Status supports the '=' operator.
Recipients_ListId supports the '=' operator.
Settings_FolderId supports the '=' operator.

SELECT * FROM Campaigns WHERE Id = '1245'
SELECT * FROM Campaigns WHERE Type = '1245'
SELECT * FROM Campaigns WHERE Status = 'save'
SELECT * FROM Campaigns WHERE Recipients_ListId = '12345'
SELECT * FROM Campaigns WHERE Settings_FolderId = '12345'
SELECT * FROM Campaigns WHERE CreateTime = '2024-02-07 00:00:37.0'
SELECT * FROM Campaigns WHERE CreateTime >= '2024-02-07 00:00:37.0'
SELECT * FROM Campaigns WHERE CreateTime <= '2024-02-07 00:00:37.0'
SELECT * FROM Campaigns WHERE CreateTime > '2024-02-07 00:00:37.0'
SELECT * FROM Campaigns WHERE CreateTime < '2024-02-07 00:00:37.0'

Update

UPDATE Campaigns SET Settings_Title = "Test" WHERE Id = "1234"

UPDATE Campaigns SET Recipients_SegmentOpts = "{"match":"any","saved_segment_id":314699}" WHERE Id = "cfb12c2228" 

UPDATE Campaigns SET Settings_Title = "Test", Recipients_ListId = "1234", RssOpts_FeedUrl = "exampleUrl", Type = "rss", RssOpts_Frequency = "daily" WHERE Id = "1234"

Note: UPDATE operation cannot be performed on already SENT campaigns. Also, the type of a campaign cannot be updated once it is set. Depending on the campaign type, specific options can be updateable only for specific campaign types. For example: If a campaign is of type "rss" then only the Rss Options fields can be updateable for this campaign. Variant and AbSplitOps settings will not be updateable in this case.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier assigned to the campaign within the Mailchimp account.
Type	String	False	Specifies the type of campaign, such as regular, plaintext, absplit, or rss.
CreateTime	Datetime	True	The date and time when the campaign was created.
ArchiveUrl	String	True	The URL of the campaign's archived version, accessible via the campaign archive.
LongArchiveUrl	String	True	The original full-length URL of the campaign archive version.
Status	String	True	Indicates the current state of the campaign, such as save, paused, schedule, sending, or sent.
EmailsSent	Integer	True	The total number of emails successfully sent for this campaign.
SendTime	Datetime	True	The date and time when the campaign was sent to recipients.
ContentType	String	False	Defines how the campaign content is structured, such as template, drag_and_drop, HTML, or URL.
Recipients_ListId	String	False	The unique identifier of the audience list targeted by the campaign.
Recipients_ListName	String	True	The display name of the audience list associated with the campaign.
Recipients_SegmentText	String	False	A formatted HTML string describing the audience segment used for this campaign in plain language.
Recipients_RecipientCount	Integer	True	The total number of recipients included in the campaign's target audience.
Recipients_SegmentOpts	String	False	The segmentation parameters that define which subscribers received this campaign.
Settings_SubjectLine	String	False	The subject line displayed in recipients' inboxes for the campaign email.
Settings_Title	String	False	The internal title of the campaign as shown within the Mailchimp interface.
Settings_FromName	String	False	The sender name displayed in recipients' inboxes for the campaign.
Settings_ReplyTo	String	False	The reply-to email address used for recipient responses to the campaign.
Settings_UseConversation	Boolean	False	If the value is 'true', Mailchimp's Conversations feature is enabled to manage replies within the platform.
Settings_ToName	String	False	The personalized 'To' field value used in the campaign, typically populated with a merge tag like the recipient's first name.
Settings_FolderId	String	False	The identifier of the folder in which this campaign is stored, if applicable.
Settings_Authenticate	Boolean	False	If the value is 'true', Mailchimp authenticated the campaign to improve deliverability. The default value is 'true'.
Settings_AutoFooter	Boolean	False	If the value is 'true', Mailchimp automatically appends the default footer to the campaign content.
Settings_InlineCss	Boolean	False	If the value is 'true', CSS styles are automatically inlined within the campaign's HTML for improved compatibility.
Settings_AutoTweet	Boolean	False	If the value is 'true', Mailchimp automatically posts a tweet linking to the campaign archive when the campaign is sent.
Settings_AutoFbPost	String	False	A list of Facebook page IDs where the campaign is automatically shared when sent.
Settings_FbComments	Boolean	False	If the value is 'true', Facebook comments are enabled on the campaign archive, allowing recipients to leave feedback.
Settings_Timewarp	Boolean	True	If the value is 'true', the campaign uses Mailchimp's Timewarp feature to send emails based on recipients' local time zones.
Settings_TemplateId	Integer	False	The identifier of the email template used to design the campaign.
Settings_DragAndDrop	Boolean	True	If the value is 'true', the campaign was created using Mailchimp's drag-and-drop editor.
VariateSettings_WinningCombinationId	String	True	The identifier of the A/B test combination selected as the winning version.
VariateSettings_WinningCampaignId	String	True	The identifier of the campaign version sent to the remaining recipients after a winner was chosen.
VariateSettings_WinnerCriteria	String	False	Specifies the metric used to determine the winning campaign version, such as opens, clicks, or manual selection.
VariateSettings_WaitTime	Integer	False	The number of minutes Mailchimp waits before selecting the winning campaign variation.
VariateSettings_TestSize	Integer	False	The percentage of the audience used for testing in an A/B split, ranging from 10 to 100.
VariateSettings_SubjectLines	String	False	Lists the subject lines used in different campaign variations for testing.
VariateSettings_SendTimes	String	False	Lists the send times tested across A/B campaign variations.
VariateSettings_FromNames	String	False	Lists the different 'From' names used across the A/B campaign variations.
VariateSettings_ReplyToAddresses	String	False	Lists the reply-to addresses tested across campaign variations.
VariateSettings_Contents	String	True	Describes the content variations used in the A/B test campaigns.
VariateSettings_Combinations	String	True	Lists the specific combinations of variables used to create each campaign variant.
Tracking_Opens	Boolean	False	If the value is 'true', open tracking is enabled for the campaign. The default value is 'true'.
Tracking_HtmlClicks	Boolean	False	If the value is 'true', click tracking is enabled for links in the HTML version of the campaign. The default value is 'true'.
Tracking_TextClicks	Boolean	False	If the value is 'true', click tracking is enabled for links in the plain-text version of the campaign. The default value is 'true'.
Tracking_GoalTracking	Boolean	False	If the value is 'true', Goal tracking is enabled to measure conversions and subscriber activity on linked websites.
Tracking_Ecomm360	Boolean	False	If the value is 'true', eCommerce360 tracking is enabled to associate campaign performance with sales data.
Tracking_GoogleAnalytics	String	False	The custom slug used for Google Analytics tracking, limited to 50 bytes.
Tracking_Clicktale	String	False	The custom slug used for ClickTale Analytics tracking, limited to 50 bytes.
Tracking_Salesforce	String	False	Salesforce tracking options for the campaign, available when using Mailchimp's Salesforce integration.
Tracking_Capsule	String	False	Capsule CRM tracking options for the campaign, available when using Mailchimp's Capsule integration.
RssOpts_FeedUrl	String	False	The RSS feed URL used for generating campaign content in an RSS-to-Email campaign.
RssOpts_Frequency	String	False	The frequency of the RSS campaign, such as daily, weekly, or monthly.
RssOpts_Schedule	String	False	The defined schedule for sending the RSS-to-Email campaign.
RssOpts_LastSent	String	True	The date when the RSS campaign was last sent.
RssOpts_ConstrainRssImg	Boolean	False	If the value is 'true', Mailchimp constrains image widths from RSS feeds within the campaign layout.
AbSplitOpts_SplitTest	String	False	Specifies the type of A/B split used in the campaign, such as subject, from_name, or schedule.
AbSplitOpts_PickWinner	String	False	Defines how the winning version of the A/B test is selected, based on opens, clicks, or manual choice.
AbSplitOpts_WaitUnits	String	False	Specifies the unit of time (hours or days) used to determine when a winner is chosen.
AbSplitOpts_WaitTime	Integer	False	The duration to wait before selecting a winning version after sending test variants.
AbSplitOpts_SplitSize	Integer	False	The percentage of subscribers included in the test groups for A/B campaigns, typically between 1 and 50.
AbSplitOpts_FromNameA	String	False	The 'From' name used for Group A in an A/B test campaign.
AbSplitOpts_FromNameB	String	False	The 'From' name used for Group B in an A/B test campaign.
AbSplitOpts_ReplyEmailA	String	False	The reply-to email address used for Group A in an A/B test.
AbSplitOpts_ReplyEmailB	String	False	The reply-to email address used for Group B in an A/B test.
AbSplitOpts_SubjectA	String	False	The subject line assigned to Group A in an A/B test campaign.
AbSplitOpts_SubjectB	String	False	The subject line assigned to Group B in an A/B test campaign.
AbSplitOpts_SendTimeA	Datetime	False	The date and time when the A/B test campaign for Group A was sent.
AbSplitOpts_SendTimeB	Datetime	False	The date and time when the A/B test campaign for Group B was sent.
AbSplitOpts_SendTimeWinner	Datetime	False	The date and time when the winning version of the campaign was sent to the remaining audience.
SocialCard_ImageUrl	String	False	The URL of the image displayed in social media previews for the campaign.
SocialCard_Description	String	False	A short description of the campaign content shown in social media previews.
SocialCard_Title	String	False	The title displayed in the social preview card, typically matching the campaign's subject line.
ReportSummary	String	False	Summarizes engagement metrics for sent campaigns, including opens, clicks, and unsubscribes.
DeliveryStatus	String	False	Indicates the current delivery progress or any ongoing sending activity for the campaign.
WebId	Integer	True	The internal Mailchimp web application identifier used to access the campaign at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
ParentCampaignId	String	True	If this campaign is part of another, identifies the parent campaign, such as for RSS or automation child campaigns.
NeedsBlockRefresh	Boolean	True	If the value is 'true', indicates that the campaign content needs refreshing in the Mailchimp editor. Deprecated; always returns false.
Resendable	Boolean	True	If the value is 'true', the campaign can be resent to subscribers who did not open the original message.
Recipients_ListIsActive	Boolean	True	If the value is 'true', the audience list used for this campaign is active. If the value is 'false', it has been deleted or disabled.
Settings_PreviewText	String	False	The preview text shown alongside the subject line in recipients' inboxes.
ItemURL	String	False	The full URL reference of the campaign item within the Mailchimp interface.

EcommerceCartLines

Lists individual items included in an e-commerce cart, including product details and quantities.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the ECommerceStores view.

StoreId supports the '=' operator.
CartId supports the '=' operator.
Id supports the '=' operator.

For example:

SELECT * FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44'

SELECT * FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' and Id = '88'

Delete

Note : API will throw error if the cart contains only one line item. You will have to delete the cart to delete all the lines.

 DELETE FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' and Id = '88'

Columns


Name	Type	ReadOnly	Description
StoreId [KEY]	String	False	The unique identifier of the store where the cart line item is recorded. Each store represents an e-commerce integration connected to Mailchimp.
CartId [KEY]	String	False	The unique identifier of the shopping cart that contains this line item. Each cart groups one or more products selected by a customer.
Id [KEY]	String	False	The unique identifier of the specific line item within the cart, used to differentiate it from other items in the same cart.
ProductId	String	False	The unique identifier of the product added to the cart. This links the line item to the product record in the associated store.
ProductTitle	String	True	The display name or title of the product associated with the cart line item.
ProductVariantId	String	False	The unique identifier of the specific product variant included in the cart, such as a size or color variation.
ProductVariantTitle	String	True	The name or description of the product variant, helping identify the specific version of the product being purchased.
Quantity	Long	False	The number of units of this product variant included in the cart line item.
Price	Decimal	False	The unit price of the product variant in the cart, before applying any discounts or taxes.

EcommerceCarts

Contains data on e-commerce carts associated with the account, including customer and total value information.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the ECommerceStores view.

StoreId supports the '=' operator.
Id supports the '=' operator.

For example:

SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123'

SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123' and Id = '44'

Columns


Name	Type	ReadOnly	Description
StoreId	String	False	The unique identifier of the store associated with this cart. Each store represents an e-commerce integration connected to the Mailchimp account.
Id	String	False	The unique identifier assigned to the specific cart. This value distinguishes the cart record within the store.
Customer	String	False	Details about the customer who created the cart. For existing customers, include only the customer ID to link the cart to their profile.
CampaignId	String	False	The unique identifier of the Mailchimp campaign associated with the cart, allowing tracking of marketing influence on purchases.
CheckoutUrl	String	False	The direct URL where the customer can view and complete their checkout process for this cart.
CurrencyCode	String	False	The three-letter International Organization for Standardization (ISO) 4217 currency code that defines the currency used in the cart.
OrderTotal	Decimal	False	The total monetary value of all items in the cart, including taxes and discounts.
TaxTotal	Decimal	False	The total tax amount applied to the cart based on the products and applicable tax rules.
Lines	String	False	A list of individual line items contained within the cart. Line item details can be modified through the EcommerceCartLines table.
CreatedAt	Datetime	True	The date and time when the cart was initially created in the store system.
UpdatedAt	Datetime	True	The date and time when the cart was most recently updated or modified.

EcommerceCustomers

Stores records of e-commerce customers linked to Mailchimp, used for purchase tracking and segmentation.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the ECommerceStores view.

StoreId supports the '=' operator.
Id supports the '=' operator.
EmailAddress supports the '=' operator.

For example:

SELECT * FROM EcommerceCustomers WHERE StoreId = 'Test_Store123'

SELECT * FROM EcommerceCustomers WHERE EmailAddress = '[email protected]'

SELECT * FROM EcommerceCustomers WHERE StoreId = 'Test_Store123' and Id = '44'

Columns


Name	Type	ReadOnly	Description
StoreId [KEY]	String	False	The unique identifier of the store where the customer record resides. Each store represents an e-commerce integration connected to the Mailchimp account.
Id [KEY]	String	False	The unique identifier assigned to the customer within the store. This value links customer records to related orders and carts.
EmailAddress	String	False	The primary email address of the customer, used for communications, segmentation, and marketing automation.
OptInStatus	Boolean	False	If the value is 'true', the customer has opted in to receive marketing emails. This setting never overrides an existing list member's opt-in status but applies to new contacts added via the e-commerce API.
Company	String	False	The company name associated with the customer, if applicable.
FirstName	String	False	The first name of the customer, used for personalization and segmentation.
LastName	String	False	The last name of the customer, used for personalization and segmentation.
OrdersCount	Integer	True	The total number of completed orders associated with the customer across all recorded transactions.
TotalSpent	Decimal	True	The cumulative monetary amount the customer has spent on completed orders.
Address_Address1	String	False	The first line of the customer's billing or shipping address, typically the street address or P.O. box.
Address_Address2	String	False	An additional address line for apartment numbers, suites, or secondary address details.
Address_City	String	False	The city where the customer resides or where their order is billed or shipped.
Address_Province	String	False	The full name of the customer's state or province.
Address_ProvinceCode	String	False	The two-letter code representing the customer's state or province, following regional postal standards.
Address_PostalCode	String	False	The customer's postal or ZIP code for billing or shipping.
Address_Country	String	False	The full name of the customer's country.
Address_CountryCode	String	False	The two-letter ISO 3166-1 code for the customer's country.
CreatedAt	Datetime	True	The date and time when the customer record was first created in the store.
UpdatedAt	Datetime	True	The date and time when the customer's information was last updated.

EcommerceOrderLines

Lists line items included in e-commerce orders, such as product identifiers, quantities, and prices.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the ECommerceStores view.

StoreId supports the '=' operator.
OrderId supports the '=' operator.
Id supports the '=' operator.

For example:

SELECT * FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44'

SELECT * FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' and Id = '88'

Delete

Note : API will throw error if the Order contains only one line item. You will have to delete the order to delete all the lines.

 DELETE FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' and Id = '88'

Columns


Name	Type	ReadOnly	Description
StoreId [KEY]	String	False	The unique identifier of the store where the order line item is recorded. Each store represents an e-commerce integration connected to the Mailchimp account.
OrderId [KEY]	String	False	The unique identifier of the order that contains this specific line item. Each order can include one or more products purchased together.
Id [KEY]	String	False	The unique identifier of the line item within the order, used to distinguish it from other items in the same transaction.
ProductId	String	False	The unique identifier of the product associated with the line item. This links the order record to the product catalog.
ProductTitle	String	True	The display name or title of the product purchased in the order.
ProductVariantId	String	False	The unique identifier of the specific variant of the product included in the order, such as a particular size, color, or model.
ProductVariantTitle	String	True	The name or description of the selected product variant purchased in this order line.
Quantity	Long	False	The number of units of the product variant included in the order line item.
Price	Decimal	False	The unit price of the product variant at the time of purchase, before applying discounts or taxes.
Discount	Decimal	False	The total discount amount applied to this line item, including promotional codes or price adjustments.
ImageUrl	String	True	The URL of the product image associated with the order line item, typically used for display in receipts or analytics dashboards.

EcommerceOrders

Contains details of e-commerce orders tracked through connected stores, including order totals and customer details.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the ECommerceStores view.

StoreId supports the '=' operator.
Id supports the '=' operator.
CampaignId supports the '=' operator.
Outreach_Id supports the '=' operator.
CustomerId supports the '=' operator.
HasOutreach supports the '=' operator.

For example:

SELECT * FROM EcommerceOrders WHERE StoreId = 'Test_Store123'
SELECT * FROM EcommerceOrders WHERE StoreId = 'Test_Store123' and Id = '44'
SELECT * FROM EcommerceOrders WHERE CampaignId = '12144'
SELECT * FROM EcommerceOrders WHERE Outreach_Id = '12144'
SELECT * FROM EcommerceOrders WHERE CustomerId = '12144'
SELECT * FROM EcommerceOrders WHERE HasOutreach = true

Columns


Name	Type	ReadOnly	Description
StoreId [KEY]	String	False	The unique identifier of the store where the order was placed. Each store represents an e-commerce integration connected to the Mailchimp account.
Id [KEY]	String	False	The unique identifier assigned to the order within the store. This value distinguishes the order from other transactions.
Customer	String	False	Details about the customer who placed the order. For existing customers, include only the customer ID to associate the order with their record.
CampaignId	String	False	The unique identifier of the Mailchimp campaign associated with the order, enabling marketing attribution and performance tracking.
FinancialStatus	String	False	The financial state of the order, such as refunded, processing, or cancelled, indicating its payment status.
FulfillmentStatus	String	False	The fulfillment progress of the order, such as partial or fulfilled, showing whether items have been shipped or completed.
CurrencyCode	String	False	The three-letter International Organization for Standardization (ISO) 4217 currency code that defines the currency used in the order.
OrderTotal	Decimal	False	The total monetary amount of the order, including products, taxes, and shipping costs, after discounts are applied.
TaxTotal	Decimal	False	The total tax amount applied to the order based on the products purchased and the buyer's location.
ShippingTotal	Decimal	False	The total shipping charge applied to the order.
TrackingCode	String	False	The Mailchimp tracking code applied to the order. It uses the 'mc_tc' parameter from eCommerce360-enabled tracking URLs to measure marketing impact.
ProcessedAtForeign	Datetime	False	The date and time when the order was processed in the connected store system.
CancelledAtForeign	Datetime	False	The date and time when the order was canceled, if applicable.
UpdatedAtForeign	Datetime	False	The date and time when the order record was last updated in the store.
ShippingAddress_Name	String	False	The full name of the recipient for the order's shipping address.
ShippingAddress_Address1	String	False	The first line of the shipping address, typically the street address or P.O. box.
ShippingAddress_Address2	String	False	An additional field for apartment, suite, or building details in the shipping address.
ShippingAddress_City	String	False	The city where the order is being shipped.
ShippingAddress_Province	String	False	The state or province listed in the shipping address.
ShippingAddress_ProvinceCode	String	False	The two-letter code representing the state or province in the shipping address.
ShippingAddress_PostalCode	String	False	The postal or ZIP code for the shipping address.
ShippingAddress_Country	String	False	The full name of the country where the order is shipped.
ShippingAddress_CountryCode	String	False	The two-letter ISO 3166-1 code for the shipping country.
ShippingAddress_Longitude	Double	False	The longitude coordinate associated with the shipping address location.
ShippingAddress_Latitude	Double	False	The latitude coordinate associated with the shipping address location.
ShippingAddress_Phone	String	False	The phone number associated with the shipping address, if provided.
ShippingAddress_Company	String	False	The company name associated with the shipping address, if applicable.
BillingAddress_Name	String	False	The full name of the person or company on the billing address.
BillingAddress_Address1	String	False	The first line of the billing address, typically the street address or P.O. box.
BillingAddress_Address2	String	False	An additional field for apartment, suite, or building details in the billing address.
BillingAddress_City	String	False	The city where the billing address is located.
BillingAddress_Province	String	False	The state or province listed in the billing address.
BillingAddress_ProvinceCode	String	False	The two-letter code representing the state or province in the billing address.
BillingAddress_PostalCode	String	False	The postal or ZIP code for the billing address.
BillingAddress_Country	String	False	The full name of the country for the billing address.
BillingAddress_CountryCode	String	False	The two-letter ISO 3166-1 code for the billing country.
BillingAddress_Longitude	Double	False	The longitude coordinate for the billing address location.
BillingAddress_Latitude	Double	False	The latitude coordinate for the billing address location.
BillingAddress_Phone	String	False	The phone number associated with the billing address.
BillingAddress_Company	String	False	The company name associated with the billing address, if applicable.
Lines	String	False	A list of the order's line items, each representing a product or variant purchased. Line items can be updated through the EcommerceOrderLines table.
Outreach_Id	String	False	The unique identifier of the marketing outreach associated with the order, such as an email campaign or ad.
Outreach_Name	String	False	The name of the outreach campaign linked to the order.
Outreach_Type	String	False	The type of marketing outreach, such as email, social, or advertisement.
Outreach_PublishedTime	String	False	The date and time when the outreach campaign was published, in ISO 8601 format.
TrackingNumber	String	False	The tracking number provided by the shipping carrier for the order.
TrackingCarrier	String	False	The name of the shipping carrier handling the order, such as UPS, FedEx, or DHL.
TrackingUrl	String	False	The URL provided by the carrier to track the shipment's delivery status.
LandingSite	String	False	The URL of the page where the buyer first arrived before completing the order, useful for analyzing marketing funnels.
Promos	String	False	A list of promotional or discount codes applied to the order. When updating, this field is fully replaced with new values.
OrderUrl	String	False	The URL of the order record within the e-commerce system, used for quick reference or access.
DiscountTotal	Decimal	False	The total value of discounts applied to the order across all items.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	A filter column used to query orders for a specific customer ID. This column is only valid for SELECT operations.
HasOutreach	Boolean	If the value is 'true', restricts results to orders associated with an outreach campaign, such as an email or ad. This column is only valid for SELECT operations.

EcommerceProducts

Lists products available through connected e-commerce integrations, including titles, variants, and pricing.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the ECommerceStores view.

StoreId supports the '=' operator.
Id supports the '=' operator.

For example:

SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123'

SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123' and Id = '44'

Columns


Name	Type	ReadOnly	Description
StoreId [KEY]	String	False	The unique identifier of the store where the product is listed. Each store represents an e-commerce integration connected to the Mailchimp account.
Id [KEY]	String	False	The unique identifier assigned to the product within the store. This value links the product to related images, variants, and orders.
Title	String	False	The display name or title of the product as shown in the store or promotional materials.
Handle	String	False	A unique text string used to identify the product in URLs or API requests, often based on the product title.
Url	String	False	The direct URL to the product page on the store's website.
Description	String	False	A detailed description of the product, including features, specifications, or marketing information.
Type	String	False	The classification or category of the product, such as apparel, electronics, or accessories.
Vendor	String	False	The name of the vendor, brand, or supplier that provides the product.
ImageUrl	String	False	The primary image URL representing the product, typically used as the default thumbnail or featured image.
Variants	String	False	A list of product variants available, such as different sizes, colors, or configurations. Variants can be managed through the EcommerceProductVariants table.
PublishedAtForeign	Datetime	False	The date and time when the product was published or made visible in the store, recorded in ISO 8601 format.
CurrencyCode	String	True	The three-letter International Organization for Standardization (ISO) 4217 code that specifies the currency used for the product's pricing.
Images	String	False	A collection of image URLs associated with the product, showcasing different angles or variations.

EcommerceProductVariants

Contains information about product variants, such as size or color, linked to e-commerce items.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the ECommerceStores view.

StoreId supports the '=' operator.
ProductId supports the '=' operator.
Id supports the '=' operator.

For example:

SELECT * FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44'

SELECT * FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' and Id = '88'

Delete

Note : API will throw error if the Product contains only one variant. You will have to delete the product to delete all the variants.

 DELETE FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' and Id = '88'

Columns


Name	Type	ReadOnly	Description
StoreId [KEY]	String	False	The unique identifier of the store where the product variant is listed. Each store represents an e-commerce integration connected to the Mailchimp account.
ProductId [KEY]	String	False	The unique identifier of the parent product to which this variant belongs. Variants represent specific versions of a single product.
Id [KEY]	String	False	The unique identifier assigned to the product variant within the store system.
Title	String	False	The display name or title of the product variant, often including attributes such as color, size, or material.
Url	String	False	The direct URL to the variant's product page or specific option selection in the store.
Sku	String	False	The Stock Keeping Unit (SKU) used to track and manage the inventory of the product variant.
Price	Decimal	False	The selling price of the product variant, typically displayed in the store's default currency.
InventoryQuantity	Long	False	The total number of units of this product variant currently in stock.
ImageUrl	String	False	The URL of the image representing this specific product variant, used in listings and marketing content.
Backorders	String	False	The backorder policy for the variant, indicating whether additional units can be ordered when stock runs out.
Visibility	String	False	Defines the visibility status of the variant in the store, such as visible, hidden, or archived.
CreatedAt	Datetime	True	The date and time when the product variant was first created in the store system.
UpdatedAt	Datetime	True	The date and time when the product variant record was last updated.

FileManagerFiles

Provides a catalog of all files and images stored in the account's File Manager, including metadata and size.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for FileManagerFiles.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
CreatedAt supports the '=,<,>,<=,>=' operator.
CreatedBy supports the '=' operator.
Type supports the '=' operator.

SELECT * FROM FileManagerFiles WHERE Id = '1245'
SELECT * FROM FileManagerFiles WHERE CreatedAt = '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedAt >= '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedAt <= '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedAt > '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedAt < '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedBy = 'abcd'
SELECT * FROM FileManagerFiles WHERE Type = 'file'

Insert

The Name, FolderId, and FileData are required for INSERTs.

INSERT INTO FileManagerFiles (Name, FolderID, FileData) VALUES ('myNewFolder', 'myFolderID', 'myBase64EncodedFileData')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier assigned to the file in Mailchimp's File Manager, used to reference or manage the file programmatically.
FolderId	Integer	False	The unique identifier of the folder where the file is stored within the File Manager hierarchy, helping organize assets by category or campaign use.
Type	String	True	Specifies the type of file stored in the gallery, such as 'image' or 'file', which determines how the file can be previewed or used in campaigns.
Name	String	False	The human-readable name of the file as displayed in the Mailchimp File Manager or when attaching files to campaigns or templates.
FullSizeUrl	String	True	The direct URL to the full-size version of the file, which can be used for downloading or embedding the file in campaigns or web pages.
ThumbnailUrl	String	True	The URL of a smaller, thumbnail-sized preview image that allows quick visual identification of the file within the Mailchimp interface.
Size	Integer	True	The total file size in bytes, useful for understanding storage usage or for filtering large files when managing assets.
CreatedAt	Datetime	True	The exact date and time when the file was uploaded or added to the File Manager, stored in ISO 8601 format for accurate audit tracking.
CreatedBy	String	True	The username or identifier of the Mailchimp user who uploaded the file, allowing traceability of asset ownership or contribution.
Width	Integer	True	The width of the image file in pixels, available for image-type files to support layout or responsive design adjustments.
Height	Integer	True	The height of the image file in pixels, available for image-type files to support display consistency and optimization.
FileData	String	False	When uploading a new file, this field contains the file's binary data encoded in Base64 format. It is required for INSERT operations and enables programmatic uploads through the API.

FileManagerFolders

Lists folders available in the File Manager for organizing images and files.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for FileManagerFolders.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
CreatedAt supports the '=,<,>,<=,>=' operator.
CreatedBy supports the '=' operator.

SELECT * FROM FileManagerFolders WHERE Id = '1245'
SELECT * FROM FileManagerFolders WHERE CreatedAt = '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedAt >= '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedAt <= '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedAt > '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedAt < '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedBy = 'abcd'

Insert

The Name is required for INSERTs.

INSERT INTO FileManagerFolders (Name) VALUES ('myNewFolder'')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier assigned to the folder within Mailchimp's File Manager, used to organize and manage groups of files programmatically.
Name	String	False	The display name of the folder as it appears in the Mailchimp File Manager, typically used to categorize files by campaign, asset type, or project.
FileCount	Integer	True	The total number of files currently stored in this folder, providing a quick overview of its content volume.
CreatedAt	Datetime	True	The date and time when the folder was created in the File Manager, stored in ISO 8601 format for audit and version tracking.
CreatedBy	String	True	The username or account identifier of the Mailchimp user who created the folder, allowing visibility into content ownership and management activity.

ListInterestCategories.rsd

The unique identifier for the interest category, used to reference or manage it within Mailchimp's segmentation and API operations.

Columns


Name	Type	ReadOnly	Description
ListId [KEY]	String	False	The unique identifier of the Mailchimp audience (list) this interest category belongs to, linking the category to a specific subscriber group.
Title	String	False	The display name or question text for the category, shown on signup forms to help subscribers select their preferences or interests.
DisplayOrder	Integer	False	The numerical order in which this interest category appears on signup forms, with lower numbers shown first to users.
Type	String	False	Defines how the category's interests are visually presented on signup forms, such as checkboxes, radio buttons, or dropdown menus.

ListInterests

Lists individual interests belonging to a specific interest category within a list.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
CategoryId supports the '=' operator.
ListId supports the '=' operator.

SELECT * FROM ListInterests WHERE ListId = 'abc' and Id='221'
SELECT * FROM ListInterests WHERE ListId = 'abc' and CategoryId='456'

Insert

The Title, CategoryId, and ListId are required for INSERTs.

INSERT INTO ListInterests (Name, CategoryId, ListID) VALUES ('myNewListInterest', 'myCategory', 'myListID')

Columns


Name	Type	ReadOnly	Description
CategoryId [KEY]	String	False	The unique identifier of the interest category this interest belongs to, linking the interest to a specific group within a list's segmentation structure.
ListId [KEY]	String	False	The unique identifier of the Mailchimp audience (list) that includes this interest, allowing segmentation and targeted campaign delivery.
Id [KEY]	String	True	The unique identifier for the specific interest, used to reference or modify it via the Mailchimp API.
Name	String	False	The name of the interest, typically shown publicly on signup forms to let subscribers select topics, products, or preferences relevant to them.
SubscriberCount	String	True	The total number of subscribers currently associated with this interest, helping measure engagement or segment size.
DisplayOrder	Integer	False	The numeric position that determines how this interest appears on signup forms, with lower numbers appearing earlier in the list.

ListMemberEvents

Contains event information related to individual list members, such as sign-ups or profile updates.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.
MemberId supports the '=' operator.

SELECT * FROM ListMemberEvents WHERE ListId = '121' and MemberId = '11'

Insert

Name column is required when INSERTing.

Columns


Name	Type	ReadOnly	Description
Name	String	False	The name of the event triggered by the subscriber, such as a purchase, signup, or interaction, used for behavioral segmentation and automation triggers.
OccurredAt	Datetime	False	The exact date and time when the event occurred, formatted in ISO 8601, allowing precise tracking of subscriber engagement over time.
Properties	String	False	A structured JSON object containing additional event details, such as product data, URLs, or metadata associated with the action.
ListId	String	False	The unique identifier of the Mailchimp audience (list) associated with the subscriber and recorded event.
MemberId	String	False	The MD5 hash of the lowercase version of the subscriber's email address, used as a secure, unique identifier to track events for that member.

ListMemberNotes

Contains notes created for specific list members, showing the most recent entries by date.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
ListId supports the '=' operator.
MemberId supports the '=' operator.

SELECT * FROM ListMemberNotes WHERE ListId = '121' and MemberId = '11' and Id='456'

Insert

No fields are are required when INSERTing.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The unique identifier of the note, used to reference or manage specific annotations associated with a subscriber.
CreatedAt	Datetime	True	The date and time when the note was originally created, recorded in ISO 8601 format for accurate tracking.
CreatedBy	String	True	The name or username of the Mailchimp user who authored the note, indicating who added the information to the subscriber's record.
UpdatedAt	Datetime	True	The date and time when the note was last edited or modified, helping maintain an audit trail of updates.
Note	String	False	The full text content of the note, typically used to store additional context, observations, or manual updates about a subscriber.
ListId [KEY]	String	False	The unique identifier of the Mailchimp audience (list) the noted subscriber belongs to.
MemberId [KEY]	String	False	The MD5 hash of the lowercase version of the subscriber's email address, used to securely identify the list member associated with the note.
ContactId	String	True	A universal identifier for the contact within Mailchimp, independent of whether they have an associated email address, enabling tracking across multiple communication channels.
EmailId	String	True	The MD5 hash of the lowercase version of the subscriber's email address, used as an alternate secure identifier for email-based contacts.

ListMembers

Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for ListMembers.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
EmailAddress supports the '=' operator.
UniqueEmailId supports the '=' operator.
FullName supports the 'LIKE' operator.
EmailType supports the '=' operator.
Status supports the '=' operator.
Vip supports the '=' operator.
ListId supports the '=' operator.
InterestCategoryId supports the '=' operator.
InterestMatch supports the '=' operator.
InterestIds supports the '=, IN' operator.
SinceLastCampaign supports the '=' operator.
UnsubscribedSince supports the '=' operator.
TimestampOpt supports the '=,<,>,<=,>=' operator.
LastChanged supports the '=,<,>,<=,>=' operator.

SELECT * FROM ListMembers WHERE ListId = '121' and Id='456'
SELECT * FROM ListMembers WHERE EmailAddress = '[email protected]' and EmailType='html'
SELECT * FROM ListMembers WHERE EmailAddress = '[email protected]' 
SELECT * FROM ListMembers WHERE SinceLastCampaign = true and Status='cleaned'
SELECT * FROM ListMembers WHERE UnsubscribedSince = '2024-02-07 00:00:37.0' and Status='unsubscribed'
SELECT * FROM ListMembers WHERE InterestCategoryId = 'abcd' and InterestIds IN ('123','321') and InterestMatch='any'
SELECT * FROM ListMembers WHERE LastChanged = '2024-02-07 00:00:37.0'
SELECT * FROM ListMembers WHERE LastChanged >= '2024-02-07 00:00:37.0'
SELECT * FROM ListMembers WHERE LastChanged <= '2024-02-07 00:00:37.0'
SELECT * FROM ListMembers WHERE LastChanged > '2024-02-07 00:00:37.0'
SELECT * FROM ListMembers WHERE LastChanged < '2024-02-07 00:00:37.0'

For columns, FullName LIKE operator is supported server side for the following queries:

If the FullName contains ' ' (SPACE) in the value then that query will be processed client side.

SELECT * FROM ListMembers where FullName like 'xyz%'

Insert

The ListId, EmailAddress, and Status are required for INSERTs.

INSERT INTO ListMembers (ListId, EmailAddress, Status) VALUES ('myListId', 'myEmailAddress', 'subscribed')

To insert MergeFields, you will have to provide whole aggregate.

INSERT INTO ListMembers (ListId, EmailAddress, Status, MergeFields) VALUES ('myListId', 'myEmailAddress', 'subscribed', '{\"LName\" : \"asd\"}')

To insert individual MergeField you will have to use List specific ListMembers Table, for example : ListMember_List1, here List1 is the name of the list.

INSERT INTO ListMembers_List1 (ListId, EmailAddress, Status, LName) VALUES ('myListId', 'myEmailAddress', 'subscribed', 'asd')

Here, LName is the mergefield.

Update

The ListId and Id are required for Update.

Update ListMembers set mergefields = '{  "LNAME": "aaaABCD"}' where Id = '45151asd' and ListId='asd151'

To update individual MergeField you will have to use List specific ListMembers Table, for example : ListMember_List1, here List1 is the name of the list.

Update ListMembers_List1 set LName = 'asdawd' where Id = '45151asd'

Here, LName is the mergefield.

Delete

The ListId and Id are required for Delete.

DELETE FROM ListMembers where ListId='ada232' and Id='1511asd'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The MD5 hash of the subscriber's email address, used as a unique identifier for the list member.
EmailAddress	String	False	The subscriber's email address used for receiving campaign communications.
UniqueEmailId [KEY]	String	True	A Mailchimp-wide identifier that distinguishes the email address across all lists and campaigns.
EmailType	String	False	The preferred format of the email that the subscriber has opted to receive, such as 'HTML' or 'text'.
FullName	String	True	The subscriber's full name, typically composed of the first and last name provided during signup.
Status	String	False	The subscriber's current status in the list, which may be 'subscribed', 'unsubscribed', 'cleaned', 'pending', or 'transactional'.
StatusIfNew	String	False	The subscriber's initial status to apply if the email address is not already present on the list when performing a PUT request.
Interests	String	False	A list of interest category IDs that define the subscriber's preferences, allowing targeted segmentation.
Stats_AvgOpenRate	Double	True	The subscriber's average open rate across all received campaigns.
Stats_AvgClickRate	Double	True	The subscriber's average clickthrough rate across all received campaigns.
IpSignup	String	False	The IP address from which the subscriber originally signed up for the list.
TimestampSignup	Datetime	False	The date and time when the subscriber signed up for the list, recorded in ISO 8601 format.
IpOpt	String	False	The IP address from which the subscriber confirmed their opt-in status.
TimestampOpt	Datetime	False	The date and time when the subscriber confirmed their opt-in status, recorded in ISO 8601 format.
MemberRating	Integer	True	The subscriber's engagement score, rated from 1 to 5 stars based on campaign interactions such as opens and clicks.
LastChanged	Datetime	True	The date and time when the subscriber's information was last updated.
Language	String	False	The language preference detected or set for the subscriber, used to send localized content when available.
Vip	Boolean	False	Indicates whether the subscriber is marked as a VIP, typically used for high-value or priority contacts.
EmailClient	String	True	The email client used by the subscriber, such as Outlook or Gmail, determined from campaign interaction data.
Location_Latitude	Double	False	The geographical latitude of the subscriber's location, inferred from IP or profile data.
Location_Longitude	Double	False	The geographical longitude of the subscriber's location, inferred from IP or profile data.
Location_Gmtoff	Integer	True	The time difference in hours between the subscriber's local time and GMT.
Location_Dstoff	Integer	True	The daylight saving time offset for the subscriber's location.
Location_CountryCode	String	True	The two-letter ISO country code representing the subscriber's location.
Location_Timezone	String	True	The subscriber's local timezone, used for scheduling campaigns appropriately.
LastNote_NoteId	Integer	True	The unique identifier of the most recent note added to the subscriber's profile.
LastNote_CreatedAt	String	True	The date and time when the most recent note was created.
LastNote_CreatedBy	String	True	The name or username of the user who created the most recent note on the subscriber's profile.
LastNote_Note	String	True	The text content of the subscriber's most recent note, providing additional context or manual observations.
ListId [KEY]	String	False	The unique identifier of the Mailchimp audience (list) that the subscriber belongs to.
TagsAggregate	String	False	A list of all tags applied to the subscriber, aggregated into a single field for easier querying and reporting.
ContactId	String	True	A universal Mailchimp contact identifier that exists independently of an email address, allowing tracking of contacts across multiple channels.
WebId	Integer	True	The Mailchimp web application ID that enables viewing this subscriber's details directly in the Mailchimp interface.
UnsubscribeReason	String	True	The subscriber's stated reason for unsubscribing from the list, if provided.
ConsentsToOneToOneMessaging	Boolean	True	Indicates whether the subscriber has given consent for one-to-one messaging, such as direct replies or personalized outreach.
Stats_EcommerceData_TotalRevenue	Decimal	True	The total amount of revenue generated by the subscriber's orders, linked through e-commerce integrations.
Stats_EcommerceData_NumberOfOrders	Integer	True	The total number of e-commerce orders placed by the subscriber.
Stats_EcommerceData_CurrencyCode	String	True	The three-letter ISO 4217 currency code associated with the subscriber's e-commerce transactions.
Location_Region	String	True	The geographic region or state associated with the subscriber's location.
MarketingPermissionsAggregate	String	False	A list of the subscriber's marketing permissions, defining what types of communication they have consented to receive.
Source	String	True	The origin from which the subscriber was added to the list, such as a signup form, import, or API integration.
TagsCount	Integer	True	The total number of tags currently applied to the subscriber.
MergeFields	String	False	A key-value collection of merge fields used for personalization, where the keys are merge tags like FNAME or LNAME.
SmsPhoneNumber	String	False	The subscriber's phone number for SMS communications, formatted as a valid U.S. number.
SmsSubscriptionStatus	String	False	The subscriber's current SMS subscription status, such as 'subscribed' or 'unsubscribed'. The allowed values are subscribed, unsubscribed, nonsubscribed, pending.
SmsSubscriptionLastUpdated	Datetime	False	The date and time when the subscriber's SMS subscription status was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
InterestCategoryId	String	The unique identifier for the interest category used for filtering results, valid only for SELECT queries.
InterestMatch	String	Defines how interests are matched when filtering subscribers. Accepts 'any', 'all', or 'none' and must be used with InterestCategoryId and InterestIds.
InterestIds	String	Specifies one or more interest IDs to filter list members by, used in combination with InterestCategoryId and InterestMatch.
SinceLastCampaign	Boolean	Filters subscribers by changes in status (subscribed, unsubscribed, pending, or cleaned) since the last campaign was sent. Valid only for SELECT queries.
UnsubscribedSince	Datetime	Filters subscribers who unsubscribed after a specific date. Only works when the status is set to 'unsubscribed'.

ListMergeFields.rsd

The display name of the merge field as it appears in the Mailchimp list and signup forms.

Columns


Name	Type	ReadOnly	Description
MergeId [KEY]	Integer	True	A persistent identifier for the merge field, which remains the same even if the field's settings are modified.
Tag	String	False	The merge tag used to reference this field in Mailchimp campaigns, templates, and the /members endpoint.
Type	String	False	The data type of the merge field, such as text, number, date, address, or phone.
Required	Boolean	False	Indicates whether the merge field must be filled in by subscribers when joining the list.
DefaultValue	String	False	The default value assigned to the merge field if no value is provided by the subscriber.
Public	Boolean	False	Specifies whether the merge field is visible to subscribers on signup forms.
DisplayOrder	Integer	False	Determines the order in which the merge field appears on signup forms, with lower numbers appearing first.
Options_DefaultCountry	Integer	False	In address fields, defines the default country code to use if the subscriber does not specify one.
Options_PhoneFormat	String	False	In phone number fields, defines the expected format (for example, 'US' or 'International').
Options_DateFormat	String	False	In date or birthday fields, specifies the format used to display and capture dates.
Options_Choices	String	False	For radio buttons or dropdown lists, lists the available options that subscribers can choose from.
Options_Size	Integer	False	In text fields, defines the default length or character limit for the field input.
HelpText	String	False	Optional help text displayed to guide subscribers when filling in the field.
ListId [KEY]	String	False	The unique identifier of the Mailchimp list that this merge field belongs to.

Lists

Contains all audience lists in the account, including configuration details, subscriber counts, and opt-in settings.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for Lists.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
DateCreated supports the '=,<,>,<=,>=' operator.
Stats_CampaignLastSent supports the '=,<,>,<=,>=' operator.

SELECT * FROM Lists WHERE Id = 'abc'
SELECT * FROM Lists WHERE DateCreated = '2024-02-07 00:00:37.0'
SELECT * FROM Lists WHERE DateCreated >= '2024-02-07 00:00:37.0'
SELECT * FROM Lists WHERE DateCreated <= '2024-02-07 00:00:37.0'
SELECT * FROM Lists WHERE DateCreated > '2024-02-07 00:00:37.0'
SELECT * FROM Lists WHERE DateCreated < '2024-02-07 00:00:37.0'

Insert

The Name, PermissionReminder, EmailTypeOption, Contact_Company, Contact_Address1, Contact_City, Contact_State, Contact_Zip, Contact_Country, CampaignDefaults_FromName, CampaignDefaults_FromEmail, CampaignDefaults_Subject, and CampaignDefaults_Language are required for INSERTs.

INSERT INTO Lists (Name, PermissionReminder, EmailTypeOption, Contact_Company, Contact_Address1, Contact_City, Contact_State, Contact_Zip, Contact_Country, CampaignDefaults_FromName, CampaignDefaults_FromEmail, CampaignDefaults_Subject, CampaignDefaults_Language) VALUES ('myName', 'myPermissionReminder', 'true', 'myCompany', 'myAddress', 'myCity', 'myState', 'myZip', 'myCountry', 'myFromName', 'myFromEmail', 'myDefaultSubject', 'myDefaultLanguage')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier of the audience (list) within the Mailchimp account.
Name	String	False	The display name of the audience, used for identifying it in the Mailchimp dashboard.
Contact_Company	String	False	The company name associated with the audience's contact information, typically appearing in campaign footers.
Contact_Address1	String	False	The primary street address associated with the audience contact.
Contact_Address2	String	False	An additional address line for the audience contact.
Contact_City	String	False	The city specified in the audience's contact address.
Contact_State	String	False	The state or province for the audience contact address.
Contact_Zip	String	False	The postal or ZIP code for the audience contact address.
Contact_Country	String	False	The two-letter ISO 3166 country code for the contact's country. If the provided code is not valid, it defaults to 'US'.
Contact_Phone	String	False	The phone number associated with the audience contact.
PermissionReminder	String	False	A short message displayed in email footers reminding subscribers why they are receiving the campaign.
UseArchiveBar	Boolean	False	Indicates whether campaign archives for this audience include the Mailchimp Archive Bar by default.
CampaignDefaults_FromName	String	False	The default 'from' name that appears in campaigns sent to this audience.
CampaignDefaults_FromEmail	String	False	The default 'from' email address used in campaigns sent to this audience. It must be a valid email address.
CampaignDefaults_Subject	String	False	The default subject line applied to campaigns sent to this audience.
CampaignDefaults_Language	String	False	The default language used for the audience's signup forms and notifications.
NotifyOnSubscribe	String	False	An optional email address to receive notifications when a new contact subscribes to the audience.
NotifyOnUnsubscribe	String	False	An optional email address to receive notifications when a contact unsubscribes from the audience.
DateCreated	Datetime	True	The date and time when the audience was originally created.
ListRating	Integer	True	An automatically generated activity score for the audience ranging from 0 to 5.
EmailTypeOption	Boolean	False	Indicates whether the audience supports sending emails in multiple formats (HTML and plain text).
SubscribeUrlShort	String	True	A shortened URL version of the audience's signup form, generated by Mailchimp (eepurl).
SubscribeUrlLong	String	True	The full URL for the audience's signup form, hosted by Mailchimp.
BeamerAddress	String	True	The unique email address used to post directly to the audience via Mailchimp's Email Beamer feature.
Visibility	String	False	Defines whether the audience is public ('pub') or private ('prv') within Mailchimp projects such as Wavelength.
Modules	String	True	Specifies any audience-specific modules or integrations installed for this list.
Stats_MemberCount	Integer	True	The total number of active subscribers in the audience.
Stats_UnsubscribeCount	Integer	True	The total number of contacts who have unsubscribed from the audience.
Stats_CleanedCount	Integer	True	The total number of contacts removed due to invalid or bounced email addresses.
Stats_MemberCountSinceSend	Integer	True	The number of active subscribers added since the last campaign was sent.
Stats_UnsubscribeCountSinceSend	Integer	True	The number of unsubscribes recorded since the last campaign was sent.
Stats_CleanedCountSinceSend	Integer	True	The number of cleaned (bounced) addresses since the last campaign was sent.
Stats_CampaignCount	Integer	True	The total number of campaigns, across all statuses, that have used this audience.
Stats_CampaignLastSent	Datetime	True	The date and time the most recent campaign was sent to this audience.
Stats_MergeFieldCount	Integer	True	The total number of merge fields configured for this audience, excluding the required EMAIL field.
Stats_AvgSubRate	Double	True	The average number of new subscriptions per month for the audience, if calculated.
Stats_AvgUnsubRate	Double	True	The average number of unsubscribes per month for the audience, if calculated.
Stats_TargetSubRate	Double	True	The target number of new subscriptions per month needed to maintain growth, if calculated.
Stats_OpenRate	Double	True	The average open rate (as a percentage) for campaigns sent to this audience.
Stats_ClickRate	Double	True	The average click-through rate (as a percentage) for campaigns sent to this audience.
Stats_LastSubDate	Datetime	True	The date and time when the most recent subscription was added to the audience.
Stats_LastUnsubDate	Datetime	True	The date and time when the most recent unsubscribe occurred.
WebId	Integer	True	The audience ID used in the Mailchimp web interface. You can view it in your account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
DoubleOptin	Boolean	False	Indicates whether the audience requires double opt-in confirmation via email before adding new subscribers.
HasWelcome	Boolean	True	Specifies whether the audience has a connected welcome automation, such as 'welcomeSeries' or 'singleWelcome'.
MarketingPermissions	Boolean	False	Indicates whether marketing permissions like General Data Protection Regulation (GDPR) consent are enabled for this audience.
Stats_TotalContacts	Integer	True	The total number of contacts in the audience, including subscribed, unsubscribed, pending, cleaned, and transactional statuses. It requires the include_total_contacts parameter in queries.

ListSegmentMembers

Lists subscribers that belong to a specific segment, including historical membership data.

Table Specific Information

SELECT, INSERT, and DELETE are supported for ListSegmentMembers.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.
SegmentId supports the '=' operator.
IncludeCleaned supports the '=' operator.
IncludeTransactional supports the '=' operator.
IncludeUnsubscribed supports the '=' operator.

SELECT * FROM ListSegmentMembers WHERE ListId = '5152' AND SegmentId = '2623'
SELECT * FROM ListSegmentMembers WHERE IncludeCleaned = true
SELECT * FROM ListSegmentMembers WHERE IncludeTransactional = true
SELECT * FROM ListSegmentMembers WHERE IncludeUnsubscribed = true

Insert

The Name and ListID are required for INSERTs.

INSERT INTO ListSegmentMembers (EmailAddress,ListId,SegmentId) VALUES ('[email protected]','44a64c46cb','7032720')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The MD5 hash of the list member's email address, used as a unique identifier.
EmailAddress	String	False	The subscriber's email address associated with this list segment.
UniqueEmailId [KEY]	String	True	A unique identifier for the email address across all Mailchimp audiences.
EmailType	String	True	The preferred email format the subscriber has chosen to receive, either 'HTML' or 'text'.
Status	String	True	The subscriber's current status, which can be 'subscribed', 'unsubscribed', 'cleaned', or 'pending'.
StatusIfNew	String	True	The subscriber's status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'), used when adding a new contact to the list via PUT if the email does not already exist.
Interests	String	True	A mapping of the subscriber's interests, where each key represents an interest category ID and its value indicates selection.
Stats_AvgOpenRate	Double	True	The subscriber's average email open rate across campaigns.
Stats_AvgClickRate	Double	True	The subscriber's average click-through rate across campaigns.
IpSignup	String	True	The IP address from which the subscriber originally signed up.
TimestampSignup	Datetime	True	The date and time when the subscriber joined the list.
IpOpt	String	True	The IP address from which the subscriber confirmed their opt-in status.
TimestampOpt	Datetime	True	The date and time when the subscriber confirmed their opt-in.
MemberRating	Integer	True	The subscriber's star rating (1–5) based on engagement and activity history.
LastChanged	Datetime	True	The date and time when the subscriber's profile or preferences were last updated.
Language	String	True	The detected or specified language preference of the subscriber.
Vip	Boolean	True	Indicates whether the subscriber is marked as a VIP contact.
EmailClient	String	True	The email client used by the subscriber, such as Gmail, Outlook, or Apple Mail.
Location_Latitude	Double	True	The geographic latitude of the subscriber's location, if available.
Location_Longitude	Double	True	The geographic longitude of the subscriber's location, if available.
Location_Gmtoff	Integer	True	The offset in hours between the subscriber's local time and Greenwich Mean Time (GMT).
Location_Dstoff	Integer	True	The daylight saving time offset for the subscriber's timezone, in hours.
Location_CountryCode	String	True	The two-letter ISO code for the subscriber's country.
Location_Timezone	String	True	The name of the subscriber's timezone, such as 'America/New_York'.
LastNote_NoteId	Integer	True	The unique identifier of the most recent note added to the subscriber's record.
LastNote_CreatedAt	String	True	The date when the latest note was created for the subscriber.
LastNote_CreatedBy	String	True	The username of the person who created the latest note.
LastNote_Note	String	True	The content or text of the latest note recorded for the subscriber.
ListId [KEY]	String	False	The unique identifier of the Mailchimp list the subscriber belongs to.
SegmentId [KEY]	String	False	The unique identifier of the list segment that this subscriber is part of.
MergeFields	String	True	A JSON dictionary of merge fields, where keys are merge tags and values are corresponding subscriber data fields.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeCleaned	Boolean	If the value is 'true', cleaned (bounced) members are included in the response. It is valid only for SELECT operations.
IncludeTransactional	Boolean	If the value is 'true', transactional contacts are included in the response. It is valid only for SELECT operations.
IncludeUnsubscribed	Boolean	If the value is 'true', unsubscribed contacts are included in the response. It is valid only for SELECT operations.

ListSegments

Provides information on available audience segments, including criteria and segment type.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for ListSegments.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
Type supports the '=' operator.
ListId supports the '=' operator.
IncludeCleaned supports the '=' operator.
IncludeUnsubscribed supports the '=' operator.
IncludeTransactional supports the '=' operator.
CreatedAt supports the '=,<,>,<=,>=' operator.
UpdatedAt supports the '=,<,>,<=,>=' operator.

SELECT * FROM ListSegments WHERE ListId = '5152' and Id = '4458'
SELECT * FROM ListSegments WHERE Type = 'saved'
SELECT * FROM ListSegments WHERE IncludeCleaned = true
SELECT * FROM ListSegments WHERE IncludeTransactional = true
SELECT * FROM ListSegments WHERE IncludeUnsubscribed = true
SELECT * FROM ListSegments WHERE UpdatedAt = '2024-02-07 00:00:37.0'
SELECT * FROM ListSegments WHERE UpdatedAt >= '2024-02-07 00:00:37.0'
SELECT * FROM ListSegments WHERE UpdatedAt <= '2024-02-07 00:00:37.0'
SELECT * FROM ListSegments WHERE UpdatedAt > '2024-02-07 00:00:37.0'
SELECT * FROM ListSegments WHERE UpdatedAt < '2024-02-07 00:00:37.0'

Insert

The Name and ListID are required for INSERTs.

INSERT INTO ListSegments (Name, ListID) VALUES ('myNewListSegment', 'myListID')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier of the segment within the audience.
Name	String	False	The display name assigned to the segment, used for identifying it in the Mailchimp audience dashboard.
MemberCount	Integer	True	The number of active subscribers currently included in this segment.
Type	String	True	The type of segment, which can be 'saved' (predefined), 'static' (manually defined), or 'fuzzy' (rule-based or dynamic).
CreatedAt	Datetime	True	The date and time when the segment was originally created.
UpdatedAt	Datetime	True	The date and time when the segment was last modified.
Options_Match	String	False	Specifies how conditions are matched when building the segment: 'any' to include subscribers meeting at least one condition, or 'all' to include only those meeting every condition.
Options_Conditions	String	False	A JSON array describing the individual conditions that define which subscribers belong to the segment, such as tags, activity, or custom fields.
ListId [KEY]	String	False	The unique identifier of the Mailchimp audience (list) that this segment belongs to.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
EmailList	String	A comma-separated list of subscriber email addresses to include when filtering results for this segment.
IncludeCleaned	Boolean	If the value is 'true', cleaned (bounced) contacts are included in the response. It is valid only for SELECT operations.
IncludeTransactional	Boolean	If the value is 'true', transactional contacts (such as one-time buyers) are included in the response. It is valid only for SELECT operations.
IncludeUnsubscribed	Boolean	If the value is 'true', unsubscribed contacts are included in the response. It is valid only for SELECT operations.

ListsWebhooks

Lists webhooks configured for an audience list, used to trigger updates based on subscriber activity.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier of the webhook within Mailchimp.
Url	String	False	The endpoint URL where webhook event notifications are sent when triggered.
Events_Subscribe	Boolean	False	If the value is 'true', the webhook is triggered when a subscriber joins the list.
Events_Unsubscribe	Boolean	False	If the value is 'true', the webhook is triggered when a subscriber unsubscribes from the list.
Events_Profile	Boolean	False	If the value is 'true', the webhook is triggered when a subscriber's profile information is updated.
Events_Cleaned	Boolean	False	If the value is 'true', the webhook is triggered when a subscriber's email address is cleaned due to repeated bounces.
Events_Upemail	Boolean	False	If the value is 'true', the webhook is triggered when a subscriber's email address is changed.
Events_Campaign	Boolean	False	If the value is 'true', the webhook is triggered when a campaign is sent or activity occurs related to that campaign.
Sources_User	Boolean	False	If the value is 'true', includes webhook events triggered by subscriber actions (such as signing up or unsubscribing).
Sources_Admin	Boolean	False	If the value is 'true', includes webhook events triggered by admin actions within Mailchimp.
Sources_Api	Boolean	False	If the value is 'true', includes webhook events triggered by API calls.
ListId [KEY]	String	False	The unique identifier of the Mailchimp list (audience) associated with the webhook.

TemplateFolders

Lists folders used to organize design templates within the account.

Table Specific Information

SELECT, INSERT, UPDATE, and DELTE are supported for TemplateFolders.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM TemplateFolders WHERE Id = '1245'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier of the template folder, used to reference or manage it within Mailchimp.
Name	String	False	The name assigned to the template folder, helping organize and categorize stored templates.
Count	Integer	True	The total number of templates contained within this folder, useful for tracking and folder management.

Templates

A list an account's available templates.

Table Specific Information

SELECT, INSERT, UPDATE and DELETE are supported for Templates.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
Type supports the '=' operator.
Category supports the '=' operator.
DateCreated supports the '<,>,<=,>=' operator.
CreatedBy supports the '=' operator.
FolderId supports the '=' operator.
ContentType supports the '=' operator.

SELECT * FROM Templates WHERE Id = '1245'
SELECT * FROM Templates WHERE Type = 'base'
SELECT * FROM Templates WHERE Category = 'asdw'
SELECT * FROM Templates WHERE FolderId = '15151'
SELECT * FROM Templates WHERE ContentType = 'template'
SELECT * FROM Templates WHERE CreatedBy = 'abcd'
SELECT * FROM Templates WHERE DateCreated >= '2024-02-07 00:00:37.0'
SELECT * FROM Templates WHERE DateCreated <= '2024-02-07 00:00:37.0'
SELECT * FROM Templates WHERE DateCreated > '2024-02-07 00:00:37.0'
SELECT * FROM Templates WHERE DateCreated < '2024-02-07 00:00:37.0'

Insert

Columns Name and Html are required for Insert.

INSERT INTO Templates(name, html) VALUES ('test_template', '<title></title>')

Update

Column Html is required for Update. As the html column is not returned from the server during SELECT operation, the user will have to provider HTML column in the UPDATE statement.

Update Templates set html='<title></title>', name='abcd' where id=13693

Delete

Delete from Templates where id=13695

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The individual id for the template.
Type	String	True	The type of template (user, base, or gallery).
Name	String	False	The name of the template.
DragAndDrop	Boolean	True	Whether or not the template uses the drag and drop editor.
Responsive	Boolean	True	Whether or not the template contains media queries to make it responsive.
Category	String	True	If available, the category the template is listed in.
DateCreated	Datetime	True	The date and time the template was created.
CreatedBy	String	True	The login name for template's creator.
Active	Boolean	True	User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether or not the template is still active.
FolderId	String	False	The id of the folder the template is currently in.
Thumbnail	String	True	If available, the URL for a thumbnail of the template.
ShareUrl	String	True	The URL used for template sharing. For more information, see: http://kb.mailchimp.com/templates/basic-and-themes/how-to-share-a-template
ContentType	String	True	How the template's content is put together. The allowed values are template, multichannel, html.
DateEdited	Datetime	True	The date and time the template was edited in ISO 8601 format.
EditedBy	String	True	The login name who last edited the template.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Html	String	The raw HTML for the template. We support the Mailchimp Template Language in any HTML code passed via the API. Can be used for INSERT and UPDATE

TransactionalAllowlists

Lists all sender addresses or domains approved to send transactional messages through Mailchimp Transactional.

Table Specific Information

SELECT, INSERT and DELETE is supported for TransactionalAllowlists.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Email supports the '=' operator.

SELECT * FROM TransactionalAllowlists WHERE Email = '[email protected]'

Insert

Email is required for Insert operation.

INSERT INTO TransactionalAllowlists(Email) VALUES ('[email protected]')

Delete

Email is required for Delete operation.

DELETE FROM TransactionalAllowlists WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	Description
Email [KEY]	String	False	The email address that has been added to the allowlist to ensure its messages are not blocked or filtered as spam.
CreatedAt	Datetime	True	The date and time when the email address was added to the allowlist, providing traceability for the change.
Detail	String	True	Additional details or context about the allowlist entry, such as the reason or method by which it was added.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Comment	String	An optional note describing why the email address was added to the allowlist. This field is used only for INSERT operations.

TransactionalTags

Lists available tags used to categorize transactional emails.

Table Specific Information

SELECT and DELETE are supported for TransactionalTags.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Tag supports the '=' operator.

SELECT * FROM TransactionalTags WHERE Tag = 'welcome'

Delete

Tag is required for the DELETE operation.

DELETE FROM TransactionalTags WHERE Tag = 'welcome'

Columns


Name	Type	ReadOnly	Description
Tag [KEY]	String	True	The name of the tag used to categorize or track transactional messages.
Reputation	Integer	True	The tag's current reputation score on a scale from 0 to 100, which reflects its overall deliverability and engagement performance.
Sent	Integer	True	The total number of messages sent with this tag across all campaigns or send operations.
HardBounces	Integer	True	The total number of messages with this tag that resulted in hard bounces, indicating permanent delivery failures.
SoftBounces	Integer	True	The total number of messages with this tag that resulted in soft bounces, indicating temporary delivery issues.
Rejects	Integer	True	The total number of messages with this tag that were rejected before delivery.
Complaints	Integer	True	The total number of spam complaints received for messages sent with this tag.
Unsubs	Integer	True	The total number of unsubscribe requests received for messages sent with this tag.
Opens	Integer	True	The total number of times messages tagged with this label were opened.
Clicks	Integer	True	The total number of times tracked URLs within messages tagged with this label were clicked.
UniqueOpens	Integer	True	The total number of unique recipients who opened at least one message sent with this tag.
UniqueClicks	Integer	True	The total number of unique recipients who clicked at least one tracked URL in messages sent with this tag.
StatsTodaySent	Integer	True	The number of emails sent with this tag so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodayHardBounces	Integer	True	The number of hard-bounced emails with this tag so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodaySoftBounces	Integer	True	The number of soft-bounced emails with this tag so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodayRejects	Integer	True	The number of rejected emails sent with this tag so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodayComplaints	Integer	True	The number of spam complaints received for messages with this tag so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodayUnsubs	Integer	True	The number of unsubscribe requests for messages sent with this tag so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodayOpens	Integer	True	The number of times messages with this tag were opened so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodayClicks	Integer	True	The number of times tracked URLs in messages with this tag were clicked so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodayUniqueOpens	Integer	True	The number of unique recipients who opened messages sent with this tag so far today. This value is populated when an Id is specified in the WHERE clause.
StatsTodayUniqueClicks	Integer	True	The number of unique recipients who clicked URLs in messages with this tag so far today. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysSent	Integer	True	The number of emails sent with this tag in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysHardBounces	Integer	True	The number of hard-bounced emails with this tag in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysSoftBounces	Integer	True	The number of soft-bounced emails with this tag in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysRejects	Integer	True	The number of rejected emails sent with this tag in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysComplaints	Integer	True	The number of spam complaints received for messages with this tag in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysUnsubs	Integer	True	The number of unsubscribe requests for messages with this tag in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysOpens	Integer	True	The number of times messages with this tag were opened in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysClicks	Integer	True	The number of times tracked URLs in messages with this tag were clicked in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysUniqueOpens	Integer	True	The number of unique recipients who opened messages sent with this tag in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast7DaysUniqueClicks	Integer	True	The number of unique recipients who clicked URLs in messages with this tag in the last 7 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysSent	Integer	True	The number of emails sent with this tag in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysHardBounces	Integer	True	The number of hard-bounced emails with this tag in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysSoftBounces	Integer	True	The number of soft-bounced emails with this tag in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysRejects	Integer	True	The number of rejected emails sent with this tag in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysComplaints	Integer	True	The number of spam complaints received for messages with this tag in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysUnsubs	Integer	True	The number of unsubscribe requests for messages with this tag in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysOpens	Integer	True	The number of times messages with this tag were opened in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysClicks	Integer	True	The number of times tracked URLs in messages with this tag were clicked in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysUniqueOpens	Integer	True	The number of unique recipients who opened messages sent with this tag in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast30DaysUniqueClicks	Integer	True	The number of unique recipients who clicked URLs in messages with this tag in the last 30 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysSent	Integer	True	The number of emails sent with this tag in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysHardBounces	Integer	True	The number of hard-bounced emails with this tag in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysSoftBounces	Integer	True	The number of soft-bounced emails with this tag in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysRejects	Integer	True	The number of rejected emails sent with this tag in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysComplaints	Integer	True	The number of spam complaints received for messages with this tag in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysUnsubs	Integer	True	The number of unsubscribe requests for messages with this tag in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysOpens	Integer	True	The number of times messages with this tag were opened in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysClicks	Integer	True	The number of times tracked URLs in messages with this tag were clicked in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysUniqueOpens	Integer	True	The number of unique recipients who opened messages sent with this tag in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast60DaysUniqueClicks	Integer	True	The number of unique recipients who clicked URLs in messages with this tag in the last 60 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysSent	Integer	True	The number of emails sent with this tag in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysHardBounces	Integer	True	The number of hard-bounced emails with this tag in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysSoftBounces	Integer	True	The number of soft-bounced emails with this tag in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysRejects	Integer	True	The number of rejected emails sent with this tag in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysComplaints	Integer	True	The number of spam complaints received for messages with this tag in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysUnsubs	Integer	True	The number of unsubscribe requests for messages with this tag in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysOpens	Integer	True	The number of times messages with this tag were opened in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysClicks	Integer	True	The number of times tracked URLs in messages with this tag were clicked in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysUniqueOpens	Integer	True	The number of unique recipients who opened messages sent with this tag in the last 90 days. This value is populated when an Id is specified in the WHERE clause.
StatsLast90DaysUniqueClicks	Integer	True	The number of unique recipients who clicked URLs in messages with this tag in the last 90 days. This value is populated when an Id is specified in the WHERE clause.

TransactionalTemplates

Contains all transactional email templates stored in the account.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE operations are supported for TransactionalTemplates.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following columns and operator. The rest of the filter is executed client-side within the Cloud.

Name supports the '=' operator.
Label supports the '=' operator.

SELECT * FROM TransactionalTemplates WHERE Name = 'MyTemplate'
SELECT * FROM TransactionalTemplates WHERE Label = 'MyLabel'

Insert

Name is required for the INSERT operation.

INSERT INTO TransactionalTemplates (Name, Subject, FromEmail, FromName, Publish) VALUES ('MyTemplate', 'Hello Subject', '[email protected]', 'Sender Name', true)

Update

Name is required for the UPDATE operation as it acts as the key.

UPDATE TransactionalTemplates SET labels='[\"adw\", \"eww\"]' WHERE name='testname'

Delete

Name

is required for the DELETE operation.

DELETE FROM TransactionalTemplates WHERE Name = 'MyTemplate'

Columns


Name	Type	ReadOnly	Description
Name [KEY]	String	False	The name of the transactional email template.
Slug	String	True	The immutable unique identifier (slug) for the template used to reference it in API calls.
CreatedAt	Datetime	True	The Coordinated Universal Time (UTC) timestamp indicating when the template was created, formatted as YYYY-MM-DD HH:MM:SS.
UpdatedAt	Datetime	True	The UTC timestamp indicating when the template was last modified, formatted as YYYY-MM-DD HH:MM:SS.
Labels	String	False	A list of labels applied to the template for organizational or filtering purposes.
Code	String	False	The full HTML source code of the template, including mc:edit attributes that mark editable regions in the draft version.
Subject	String	False	The subject line defined for the draft version of the template, if specified.
FromEmail	String	False	The default sender email address associated with the draft version of the template.
FromName	String	False	The default sender display name associated with the draft version of the template.
Text	String	False	The default plain-text version of the message associated with the draft version of the template.
PublishName	String	True	The published version's display name for the template. Maintained separately for backward compatibility.
PublishCode	String	True	The full HTML source code of the published version of the template, including mc:edit attributes that mark editable elements.
PublishSubject	String	True	The subject line defined for the published version of the template, if specified.
PublishFromEmail	String	True	The default sender email address associated with the published version of the template.
PublishFromName	String	True	The default sender display name associated with the published version of the template.
PublishText	String	True	The default plain-text version of the message associated with the published version of the template.
PublishedAt	Datetime	True	The UTC timestamp indicating when the template was last published, formatted as YYYY-MM-DD HH:MM:SS. If the value is null, the template has not been published.
IsBrokenTemplate	Boolean	True	Indicates whether the template is malformed or corrupt and cannot be rendered properly.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Label	String	An optional label used to filter templates during SELECT operations.
Publish	Boolean	If the value is set to 'false', adds a draft version of the template without publishing it, applicable for INSERT and UPDATE operations.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Mailchimp Views


Name	Description
AccountExports	Generates or retrieves completed account exports containing data snapshots or backups of Mailchimp account information.
AuthorizedApps	Lists all third-party applications authorized to access the Mailchimp account through OAuth integration.
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.
BatchOperations	Summarizes batch requests submitted to the Mailchimp API, including processing status and results.
BatchWebhooks	Provides information about batch webhooks, which notify external systems of completed batch operations.
CampaignContents	Retrieves the HTML and plain-text content associated with a specific campaign.
CampaignOpenEmailDetails	Displays information about subscribers who opened a campaign email, including timestamps and interaction details.
CampaignSendCheckList	Returns the pre-send checklist for a campaign, highlighting configuration issues that need resolution before sending.
CampaignVariateContents	Get the the HTML and plain-text content for a campaign.
ChimpChatterActivity	Returns recent Chimp Chatter activity for the account, including Mailchimp system updates and campaign notifications.
ConnectedSites	Lists websites connected to the Mailchimp account for tracking and automation purposes.
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.
EcommerceProductImages	Provides image details for products in connected e-commerce stores, including URLs and dimensions.
EcommercePromoCodes	Retrieves the list of promo codes under a promo rule
EcommercePromoRules	Returns details about promotional rules configured for a store, including eligibility and discount types.
EcommerceStores	A list of an account's ecommerce stores.
FacebookAds	Lists Facebook ads configured and managed through Mailchimp's integrated advertising feature.
FileManagerFolderFiles	Lists files organized within specific folders in the Mailchimp File Manager.
LandingPageContents	Retrieves the content and layout details of a specific landing page.
LandingPages	Lists landing pages created in the account, including URLs, design information, and publishing status.
ListAbuse	Contains abuse complaints for a specific audience list, typically submitted when a recipient marks an email as spam.
ListActivity	Displays up to 180 days of daily aggregated activity statistics for a given audience list, excluding automation events.
ListClients	Summarizes the most common email clients used by subscribers, based on user-agent data.
ListFacebookEcommerceReport	List the breakdown of product activity for an outreach in Mailchimp.
ListGrowthHistory	Shows month-by-month subscription growth trends for a specific audience list.
ListLocations	List the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address in Mailchimp.
ListMemberActivity	The last 50 member events for a list.
ListMemberActivityFeeds	Shows a member's engagement activity on a specific list, including email opens, link clicks, and unsubscribes.
ListMemberGoals	Displays goal-tracking events for list members, such as website visits or conversions recorded by Mailchimp.
ListMemberTags	Tags assigned to a certain member/members.
ListSignupForms	Collection of List Signup Forms
ListsTagsSearch	Enables searching for specific tags applied to members within an audience list.
ListSurveys	Returns all survey configurations associated with a specific audience list.
ReportAbuse	Displays records of abuse complaints for a specific list or campaign.
ReportAdvice	Provides campaign performance feedback and optimization tips based on engagement metrics.
ReportClickDetails	A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.
ReportClickDetailsMembers	Displays the subscribers who clicked on specific links within a campaign.
ReportDomainPerformance	Statistics for the top-performing email domains in a campaign.
ReportEepUrls	Provides detailed activity reports for EepURLs (Mailchimp's link-tracking redirects).
ReportEmailActivity	A list of member's subscriber activity in a specific campaign.
ReportingFacebookAds	Lists performance reports for Facebook ad campaigns managed through Mailchimp.
ReportingLandingPages	Provides engagement and conversion metrics for landing pages published through Mailchimp.
ReportingSurveyQuestionAnswers	Lists responses to individual survey questions for analysis.
ReportingSurveyQuestions	Returns summary data and response statistics for survey questions.
ReportLocations	Displays the top geographic locations where campaign emails were opened.
ReportProductActivity	Provides campaign performance data linked to e-commerce product interactions.
Reports	A list of reports containing campaigns marked as Sent.
ReportSentTo	A list of subscribers who were sent a specific campaign.
ReportSubReports	Lists subreports generated for child or related campaigns.
ReportUnsubscribes	Lists members who unsubscribed from a specific campaign, including timestamps and reasons.
SurveyResponses	Displays individual responses submitted for surveys distributed through Mailchimp.
Surveys	Lists surveys available in the account, including titles, questions, and response counts.
TransactionalMessageContent	Get Transactional Message Content.
TransactionalMessages	Get Transactional Messages sent. Simple Select will return the last two months messages.
TransactionalScheduledEmails	Displays scheduled transactional emails awaiting delivery.
TransactionalSenders	Lists authorized senders configured in the Mailchimp Transactional account.
TransactionalUserInfos	Provides account-level information about Mailchimp Transactional users, including usage and limits.
VerifiedDomains	Lists sending domains verified for use with Mailchimp campaigns and transactional emails.

AccountExports

Generates or retrieves completed account exports containing data snapshots or backups of Mailchimp account information.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM AccountExports;
SELECT * FROM AccountExports where Id=3191;

Columns


Name	Type	Description
Id [KEY]	Integer	The unique identifier assigned to the account export task.
Started	Datetime	The date and time when the export process began.
Finished	Datetime	The date and time when the export process was completed. The value is 'null' if the export is still in progress.
SizeInBytes	Integer	The total size of the uncompressed export file, measured in bytes.
DownloadUrl	String	The URL for downloading the completed export file, available only after the export finishes and valid for 90 days.
Links	String	Provides a list of related API links and schema document references associated with the export resource.

AuthorizedApps

Lists all third-party applications authorized to access the Mailchimp account through OAuth integration.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM AuthorizedApps WHERE Id = '1245'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the authorized application integration connected to the Mailchimp account.
Name	String	The display name of the application authorized to access the account.
Description	String	A brief description of the application, outlining its purpose or functionality within the integration.
Users	String	A list of Mailchimp usernames associated with the users who have linked this application to their account.

AutomationEmailQueues

A summary of the queue for an email in an automation workflow.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
WorkflowId supports the '=' operator.
EmailId supports the '=' operator.

For example:

SELECT * FROM AutomationEmailQueues WHERE Id = '1245'

SELECT * FROM AutomationEmailQueues WHERE WorkflowId = '1245' and EmailId = '1245'

Columns


Name	Type	Description
Id [KEY]	String	The MD5 hash of the lowercase version of the list member's email address.
WorkflowId [KEY]	String	A string that uniquely identifies an automation workflow.
EmailId [KEY]	String	A string that uniquely identifies an email in an automation workflow.
ListId	String	A string that uniquely identifies a list.
EmailAddress	String	Email Address
NextSend	String	Next Send

AutomationEmails

A summary of the emails in an automation workflow.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

WorkflowId supports the '=' operator.

For example:

SELECT * FROM AutomationEmails WHERE WorkflowId = '1245'

Columns


Name	Type	Description
Id [KEY]	String	A string that uniquely identifies the automation email.
WorkflowId [KEY]	String	A string that uniquely identifies an automation workflow.
Position	Integer
Delay_Amount	Integer	The delay amount for an automation email.
Delay_Type	String	The type of delay for an automation email.
Delay_Direction	String	Whether the delay settings describe before or after the delay action of an automation email.
Delay_Action	String	The action that triggers the delay of an automation emails.
CreateTime	Datetime	The date and time the campaign was created.
StartTime	Datetime	The date and time the campaign was started.
ArchiveUrl	String	The link to the campaign's archive version.
Status	String	The current status of the campaign ('save', 'paused', 'sending').
EmailsSent	Integer	The total number of emails sent for this campaign.
SendTime	Datetime	The time and date a campaign was sent.
ContentType	String	How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').
Recipients_ListId	String	The id of the list.
Recipients_SegmentOpts	String	Segment options.
Settings_SubjectLine	String	The subject line for the campaign.
Settings_Title	String	The title of the campaign.
Settings_FromName	String	The 'from' name on the campaign (not an email address).
Settings_ReplyTo	String	The reply-to email address for the campaign.
Settings_Authenticate	Boolean	Whether or not the campaign was authenticated by MailChimp. Defaults to 'true'.
Settings_AutoFooter	Boolean	Automatically append MailChimp's default footer to the campaign.
Settings_InlineCss	Boolean	Automatically inline the CSS included with the campaign content.
Settings_AutoTweet	Boolean	Automatically tweet a link to the campaign archive page when the campaign is sent.
Settings_AutoFbPost	String	An array of Facebook page ids (integers) to auto-post to.
Settings_FbComments	Boolean	Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to 'true'.
Settings_TemplateId	Integer	The id for the template used in this campaign.
Settings_DragAndDrop	Boolean	Whether the campaign uses the drag-and-drop editor.
Tracking_Opens	Boolean	Whether to track opens. Defaults to 'true'.
Tracking_HtmlClicks	Boolean	Whether to track clicks in the HTML version of the campaign. Defaults to 'true'.
Tracking_TextClicks	Boolean	Whether to track clicks in the plain-text version of the campaign. Defaults to 'true'.
Tracking_GoalTracking	Boolean	Whether to enable Goal racking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH
Tracking_Ecomm360	Boolean	Whether to enable eCommerce360 tracking.
Tracking_GoogleAnalytics	String	The custom slug for Google Analytics tracking (max of 50 bytes).
Tracking_Clicktale	String	The custom slug for ClickTale Analytics tracking (max of 50 bytes).
Tracking_Salesforce	String	Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration.
Tracking_Capsule	String	Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration.
SocialCard_ImageUrl	String	The url for the header image for the card.
SocialCard_Description	String	A short summary of the campaign to display.
SocialCard_Title	String	The title for the card. Typically the subject line of the campaign.
TriggerSettings_Runtime	String	The advanced scheduling options for an automation email.
ReportSummary	String	For sent campaigns, a summary of opens, clicks, and unsubscribes.
WebId	Integer	The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
TriggerSettings_WorkflowType	String	The type of Automation workflow. The allowed values are abandonedBrowse, abandonedCart, api, bestCustomers, categoryFollowup, dateAdded, emailFollowup, emailSeries, groupAdd, groupRemove, mandrill, productFollowup, purchaseFollowup, recurringEvent, specialEvent, visitUrl, welcomeSeries.
TriggerSettings_WorkflowTitle	String	The title of the workflow type.
TriggerSettings_WorkflowEmailsCount	Integer	The number of emails in the Automation workflow.
Delay_ActionDescription	String	The user-friendly description of the action that triggers an Automation email.
Delay_FullDescription	String	The user-friendly description of the delay and trigger action settings for an Automation email.
NeedsBlockRefresh	Boolean	Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor.
HasLogoMergeTag	Boolean	Determines if the campaign contains the \|BRAND:LOGO\| merge tag
Recipients_ListIsActive	Boolean	The status of the list used, namely if it's deleted or disabled.
Recipients_ListName	String	The name of the list
Recipients_RecipientCount	Integer	Count of the recipients on the associated list. Formatted as an integer.
Recipients_SegmentText	String	A description of the segment used for the campaign. Formatted as a string marked up with HTML.
Settings_PreviewText	String	The preview text for the campaign.

Automations

A summary of the automations within an account.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
CreateTime supports the '=,<,>,<=,>=' operator.
StartTime supports the '=,<,>,<=,>=' operator.
Status supports the '=' operator.

For example:

SELECT * FROM Automations WHERE Id = '1245'
SELECT * FROM Automations WHERE Status = 'save'
SELECT * FROM Automations WHERE CreateTime = '2024-02-07 00:00:37.0'
SELECT * FROM Automations WHERE CreateTime >= '2024-02-07 00:00:37.0'
SELECT * FROM Automations WHERE CreateTime <= '2024-02-07 00:00:37.0'
SELECT * FROM Automations WHERE CreateTime > '2024-02-07 00:00:37.0'
SELECT * FROM Automations WHERE CreateTime < '2024-02-07 00:00:37.0'

Columns


Name	Type	Description
Id [KEY]	String	A string that identifies this automation.
CreateTime	Datetime	The date and time the automation was created.
StartTime	Datetime	The date and time the automation was started.
Status	String	The current status of the automation ('save', 'paused', 'sending').
EmailsSent	Integer	The total number of emails sent for this automation.
Recipients_ListId	String	The id of the list.
Recipients_ListName	String	List Name
Recipients_SegmentOpts	String	Segment options.
Settings_Title	String	The title of the automation.
Settings_FromName	String	The 'from' name on the automation (not an email address).
Settings_ReplyTo	String	The reply-to email address for the automation.
Settings_UseConversation	Boolean	Use MailChimp's Conversations feature to manage out of office replies.
Settings_ToName	String	The automation's custom 'to' name. Typically something like the first name merge var.
Settings_Authenticate	Boolean	Whether or not the automation is authenticated by MailChimp. Defaults to 'true'.
Settings_AutoFooter	Boolean	Automatically append MailChimp's default footer to the automation.
Settings_InlineCss	Boolean	Automatically inline the CSS included with the automation content.
Tracking_Opens	Boolean	Whether to track opens. Defaults to 'true'.
Tracking_HtmlClicks	Boolean	Whether to track clicks in the HTML version of the automation. Defaults to 'true'.
Tracking_TextClicks	Boolean	Whether to track clicks in the plain-text version of the automation. Defaults to 'true'.
Tracking_GoalTracking	Boolean	Whether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH
Tracking_Ecomm360	Boolean	Whether to enable eCommerce360 tracking.
Tracking_GoogleAnalytics	String	The custom slug for Google Analytics tracking (max of 50 bytes).
Tracking_Clicktale	String	The custom slug for ClickTale Analytics tracking (max of 50 bytes).
Tracking_Salesforce	String	Salesforce tracking options for an automation. Must be using MailChimp's built-in Salesforce integration.
Tracking_Capsule	String	Capsule tracking options for an automation. Must be using MailChimp's built-in Capsule integration.
TriggerSettings	String	A summary of an automation workflow's trigger settings.
ReportSummary	String	A summary of open and click activity for an automation workflow.
Recipients_ListIsActive	Boolean	The status of the list used, namely if it's deleted or disabled.
Recipients_StoreId	String	The id of the store.

AutomationsRemovedSubscribers

A summary of the subscribers removed from an automation workflow.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

WorkflowId supports the '=' operator.

For example:

SELECT * FROM AutomationsRemovedSubscribers WHERE WorkflowId = '1245'

Columns


Name	Type	Description
Id [KEY]	String	The MD5 hash of the lowercase version of the list member's email address.
WorkflowId [KEY]	String	A string that uniquely identifies an automation workflow.
ListId	String	A string that uniquely identifies a list.
EmailAddress	String	Email Address

BatchOperations

Summarizes batch requests submitted to the Mailchimp API, including processing status and results.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM BatchOperations;
SELECT * FROM BatchOperations where Id=2;

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier assigned to the batch request.
Status	String	The current processing status of the batch request. The allowed values are pending, preprocessing, started, finalizing, finished.
TotalOperations	Integer	The total number of operations included in the batch request. Each paginated GET request counts as a separate operation.
FinishedOperations	Integer	The number of operations that have been completed, including both successful and failed requests.
ErroredOperations	Integer	The total number of operations within the batch that resulted in errors.
SubmittedAt	Datetime	The date and time when the batch request was received by the Mailchimp server, in ISO 8601 format.
CompletedAt	Datetime	The date and time when all operations in the batch request finished processing, in ISO 8601 format.
ResponseBodyUrl	String	The URL to download the gzipped archive containing the results of all operations in the batch.
Links	String	A list of related API links and schema references associated with the batch request.

BatchWebhooks

Provides information about batch webhooks, which notify external systems of completed batch operations.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM BatchWebhooks;
SELECT * FROM BatchWebhooks where Id='2';

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier assigned to the batch webhook configuration.
Url	String	The destination URL that receives notifications when batch operations complete.
Enabled	Boolean	If the value is 'true', the webhook is active and will send notifications. If the value is 'false', the webhook is disabled.

CampaignContents

Retrieves the HTML and plain-text content associated with a specific campaign.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The CamapignId can be retrieved by selecting the Campaigns table.

CamapaignId supports the '=' operator.

For example:

SELECT * FROM CampaignContents;
SELECT * FROM CampaignContents where CampaignId='381b6f0c90';

Columns


Name	Type	Description
CampaignId	String	The unique identifier of the campaign whose content is being retrieved or updated.
PlainText	String	The plain-text version of the campaign email. If not provided, Mailchimp automatically generates it from the HTML content.
Html	String	The full HTML content of the campaign, including layout, text, and embedded media.
ArchiveHtml	String	The HTML version of the campaign as it appears in the campaign archive view.

CampaignOpenEmailDetails

Displays information about subscribers who opened a campaign email, including timestamps and interaction details.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

CampaignId supports the '=' operator.
Since supports the '=' operator.

For example:

SELECT * FROM CampaignOpenEmailDetails
SELECT * FROM CampaignOpenEmailDetails WHERE CampaignId = '9f218dcf18'
SELECT * FROM CampaignOpenEmailDetails WHERE Since = '2024-02-07 00:00:37.0'

Columns


Name	Type	Description
CampaignId [KEY]	String	The unique identifier of the campaign for which open activity is being retrieved.
ListId [KEY]	String	The unique identifier of the audience list associated with the campaign.
ListIsActive	Boolean	If the value is 'true', the associated audience list is active. If the value is 'false', the list has been deleted or disabled.
ContactStatus	String	The subscription status of the contact, such as subscribed, unsubscribed, or cleaned.
EmailId [KEY]	String	The internal identifier assigned to the contact's email address within the Mailchimp system.
EmailAddress	String	The email address of the subscriber who opened the campaign.
MergeFields	String	A collection of merge field data for the contact, such as first name or company name, used for personalization.
Vip	Boolean	If the value is 'true', the contact is marked as a VIP subscriber. If the value is 'false', they are a standard contact.
OpensCount	Integer	The total number of times the subscriber opened the campaign email.
Opens	String	Details of individual open events, including timestamps and locations where applicable.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Since	Datetime	Restricts the results to campaign open events that occurred after the specified date and time.

CampaignSendCheckList

Returns the pre-send checklist for a campaign, highlighting configuration issues that need resolution before sending.

Columns


Name	Type	Description
CampaignId [KEY]	String	The unique identifier of the campaign whose send checklist is being reviewed.
Id [KEY]	String	The identifier of the specific checklist item being evaluated.
Type	String	The type or category of the checklist item, such as content, recipients, or settings. The allowed values are success, warning, error.
Heading	String	The title or short summary describing the checklist item.
Details	String	Additional information or guidance related to the checklist item, such as required actions or validation feedback.

CampaignVariateContents

Get the the HTML and plain-text content for a campaign.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The CamapignId can be retrieved by selecting the Campaigns table.

CamapaignId supports the '=' operator.

For example:

SELECT * FROM CampaignVariateContents;
SELECT * FROM CampaignVariateContents where CampaignId='381b6f0c90';

Columns


Name	Type	Description
CampaignId	String	The unique id for the campaign.
ContentLabel	String	Label used to identify the content option.
PlainText	String	The plain-text portion of the campaign. If left unspecified, we'll generate this automatically.
Html	String	The raw HTML for the campaign.

ChimpChatterActivity

Returns recent Chimp Chatter activity for the account, including Mailchimp system updates and campaign notifications.

Table Specific Information

SELECT is supported for ChimpChatterActivity.

Select

 SELECT * FROM ChimpChatterActivity

Columns


Name	Type	Description
Title	String	The short title or subject line summarizing the Chimp Chatter activity.
Message	String	The message text describing the activity, such as campaign updates, account notifications, or system alerts.
Type	String	The category or type of Chimp Chatter event, such as campaign_send, subscriber_activity, or account_notice. The allowed values are lists:new-subscriber, lists:unsubscribes, lists:profile-updates, campaigns:facebook-likes, campaigns:forward-to-friend, lists:imports.
ModifiedAt	Datetime	The date and time when the activity record was last updated.
Url	String	A link to view more details about the specific activity within the Mailchimp web interface.
ListId	String	The unique identifier of the list associated with the activity, if applicable.
CamapignId	String	The unique identifier of the campaign related to the activity, if applicable.

ConnectedSites

Lists websites connected to the Mailchimp account for tracking and automation purposes.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM ConnectedSites;
SELECT * FROM ConnectedSites where Id='03008bc4e0f0';

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier assigned to the connected site within the Mailchimp account.
StoreId	String	The unique identifier of the e-commerce store linked to the connected site, if applicable. This value remains constant and cannot be changed.
Platform	String	The platform or content management system used by the connected site, such as Shopify, WordPress, or custom integrations.
Domain	String	The primary domain name of the connected site.
CreatedAt	Datetime	The date and time when the connected site was initially registered with Mailchimp, in ISO 8601 format.
UpdatedAt	Datetime	The date and time when the connected site details were last modified, in ISO 8601 format.
SiteScriptUrl	String	The URL for integration scripts used by platforms that provide built-in Mailchimp connected site support.
SiteScriptFragment	String	A JavaScript snippet that can be manually embedded into a website to establish a connection with Mailchimp.
Links	String	A collection of related API links and references for the connected site resource.

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.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
ConversationId supports the '=' operator.
Read supports the '=' operator.
Timestamp supports the '=,<,>,<=,>=' operator.

Select

 
SELECT * FROM ConversationMessages
SELECT * FROM ConversationMessages WHERE ConversationId = '1245' and Id='1254'
SELECT * FROM ConversationMessages WHERE Read = true
SELECT * FROM ConversationMessages WHERE Timestamp = '2024-02-07 00:00:37.0'
SELECT * FROM ConversationMessages WHERE Timestamp >= '2024-02-07 00:00:37.0'
SELECT * FROM ConversationMessages WHERE Timestamp <= '2024-02-07 00:00:37.0'
SELECT * FROM ConversationMessages WHERE Timestamp > '2024-02-07 00:00:37.0'
SELECT * FROM ConversationMessages WHERE Timestamp < '2024-02-07 00:00:37.0'

Columns


Name	Type	Description
Id [KEY]	String	A string that uniquely identifies this message
ConversationId [KEY]	String	A string that identifies this message's conversation
ListId [KEY]	String	The unique identifier of the list this conversation is associated with
FromLabel	String	A label representing the sender of this message
FromEmail	String	A label representing the email of the sender of this message
Subject	String	The subject of this message
Message	String	The plain-text content of the message
Read	Boolean	Whether or not this message has been marked as read
Timestamp	Datetime	Date the message was either sent or received

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.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
CampaignId supports the '=' operator.
ListId supports the '=' operator.
HasUnreadMessages supports the '=' operator.

Select

 
SELECT * FROM Conversations WHERE Id = '1254'
SELECT * FROM Conversations WHERE CampaignId = '1245'
SELECT * FROM Conversations WHERE ListId = '1245'
SELECT * FROM Conversations WHERE HasUnreadMessages = 'true'

Columns


Name	Type	Description
Id [KEY]	String	A string that uniquely identifies this conversation
MessageCount	Integer	The total number of messages in this conversation
CampaignId [KEY]	String	The unique identifier of the campaign this conversation is associated with
ListId [KEY]	String	The unique identifier of the list this conversation is associated with
UnreadMessages	Integer	The number of unread messages in this conversation
FromLabel	String	A label representing the sender of this message
FromEmail	String	A label representing the email of the sender of this message
Subject	String	The subject of the message
LastMessage_FromLabel	String	A label representing the sender of this message
LastMessage_FromEmail	String	A label representing the email of the sender of this message
LastMessage_Subject	String	The subject of this message
LastMessage_Message	String	The plain-text content of the message
LastMessage_Read	Boolean	Whether or not this message has been marked as read
LastMessage_Timestamp	Datetime	Date the message was either sent or received

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
HasUnreadMessages	String	Filter on unread_messages, only valid for SELECT.

EcommerceProductImages

Provides image details for products in connected e-commerce stores, including URLs and dimensions.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the EcommerceStores view and ProductId can be retrieved by selecting the EcommerceProducts table.

StoreId supports the '=' operator.
ProductId supports the '=' operator.
Id supports the '=' operator.

For example:

SELECT * FROM EcommerceProductImages;
SELECT * FROM EcommerceProductImages where Id='Test_Images';
SELECT * FROM EcommerceProductImages where ProductId='1233' and StoreId='STR002';
SELECT * FROM EcommerceProductImages where Id='Test_Images1' and ProductId='1233' and StoreId='STR002';

Columns


Name	Type	Description
StoreId [KEY]	String	The unique identifier of the store where the product image is stored. Each store represents an e-commerce integration connected to the Mailchimp account.
ProductId [KEY]	String	The unique identifier of the product that the image belongs to. This links the image to a specific product in the store catalog.
Id [KEY]	String	The unique identifier assigned to the product image within the store system.
Url	String	The direct URL of the product image file, used for display in store listings, campaigns, or product recommendations.
VariantIds	String	A list of variant identifiers that this image is associated with, allowing specific product variations (such as color or size) to use distinct visuals.
Links	String	A collection of related API references and schema links for navigating between product image resources.

EcommercePromoCodes

Retrieves the list of promo codes under a promo rule

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the EcommerceStores view and PromoRuleId can be retrieved by selecting the PromoRules view.

StoreId supports the '=' operator.
PromoRuleId supports the '=' operator.
Id supports the '=' operator.

For example:

SELECT * FROM EcommercePromoCodes;
SELECT * FROM EcommercePromoCodes where Id='test_promorule2';
SELECT * FROM EcommercePromoCodes where PromoRuleId='test_promorule2' and storeId='YM_Store';
SELECT * FROM EcommercePromoCodes where PromoRuleId='test_promorule2' and storeId='YM_Store' and Id='test_promorule2';

Columns


Name	Type	Description
StoreId [KEY]	String	The id for store.
PromoRuleId [KEY]	String	The ID of the associated promo rule.
Id [KEY]	String	The unique identifier of the promo code.
Code	String	The actual promotional code.
RedemptionUrl	String	URL used to redeem the promo code.
UsageCount	Integer	Number of times the code has been used.
Enabled	Boolean	Number of times the code has been used.
CreatedAtForeign	Datetime	The date and time the promotion was created in ISO 8601 format.
UpdatedAtForeign	Datetime	The date and time the promotion was updated in ISO 8601 format.
Links	String	A list of link types and descriptions for the API schema documents.

EcommercePromoRules

Returns details about promotional rules configured for a store, including eligibility and discount types.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

The StoreId can be retrieved by selecting the EcommerceStores view.

StoreId supports the '=' operator.
Id supports the '=' operator.

For example:

SELECT * FROM EcommercePromoRules;
SELECT * FROM EcommercePromoRules where where Id='ruleid1'
SELECT * FROM EcommercePromoRules where Id='ruleid1' and storeId='STR002';

Columns


Name	Type	Description
StoreId [KEY]	String	The unique identifier of the store where the promotional rule is defined. Each store represents an e-commerce integration connected to the Mailchimp account.
Id [KEY]	String	The unique identifier assigned to the promotional rule within the store system.
Ttile	String	The display title of the promotion as it appears in campaigns or store interfaces.
Description	String	A brief description of the promotion, limited to 255 UTF-8 characters, summarizing its purpose or eligibility criteria.
StartsAt	Datetime	The date and time when the promotion becomes active, recorded in ISO 8601 format.
EndsAt	Datetime	The date and time when the promotion expires, recorded in ISO 8601 format. This must occur after the start date.
Amount	Decimal	The value of the promotional discount. If the 'Type' is 'fixed', this amount represents a monetary value. If 'Type' is 'percentage', it must be a decimal between 0.0 and 1.0 inclusive.
Type	String	The discount type applied by the promotion, such as 'fixed' for a set monetary discount, 'percentage' for proportional savings, or 'free_shipping' for shipping-related offers. The allowed values are fixed, percentage.
Target	String	The entity or category the discount applies to, such as specific products, collections, or entire orders. The allowed values are per_item, total, shipping.
Enabled	Boolean	If the value is 'true', the promotional rule is active and can be applied to orders. If the value is 'false', it is inactive or expired.
CreatedAtForeign	Datetime	The date and time when the promotional rule was created in the store, recorded in ISO 8601 format.
UpdatedAtForeign	Datetime	The date and time when the promotional rule was last updated in the store, recorded in ISO 8601 format.
Links	String	A list of related API schema references and navigation links associated with the promotional rule resource.

EcommerceStores

A list of an account's ecommerce stores.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM EcommerceStores WHERE  Id = '44'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier for the store.
ListId [KEY]	String	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	The name of the store.
Platform	String	The ecommerce platform of the store.
Domain	String	The store domain.
EmailAddress	String	The email address for the store.
CurrencyCode	String	The three-letter ISO 4217 code for the currency that the store accepts.
MoneyFormat	String	The currency format for the store. For example: `$`, etc.
PrimaryLocale	String	The primary locale for the store. For example: `en`, `de`, etc.
Timezone	String	The timezone for the store.
Phone	String	The store phone number.
Address_Address1	String	The store's mailing address.
Address_Address2	String	An additional field for the store's mailing address.
Address_City	String	The city the store is located in.
Address_Province	String	The store's state name or normalized province.
Address_ProvinceCode	String	The two-letter code for the store's province or state.
Address_PostalCode	String	The store's postal or zip code.
Address_Country	String	The store's country.
Address_CountryCode	String	The two-letter code for to the store's country.
Address_Longitude	Double	The longitude of the store location.
Address_Latitude	Double	The latitude of the store location.
CreatedAt	Datetime	The date and time the store was created.
UpdatedAt	Datetime	The date and time the store was last updated.
IsSyncing	Boolean	Whether to disable automations because the store is currently syncing.
ConnectedSite_SiteForeignId	String	The unique identifier for the connected site.
ConnectedSite_SiteScript_Url	String	The URL used for any integrations that offer built-in support for connected sites.
ConnectedSite_SiteScript_Fragment	String	A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp.
Automations_AbandondedCart_IsSupported	Boolean	Whether this store supports the abandonedCart automation.
Automations_AbandondedCart_Id	String	Unique ID of automation parent campaign.
Automations_AbandondedCart_Status	String	Status of the abandonedCart automation. The allowed values are save, sending, paused.
Automations_AbandondedBrowse_IsSupported	Boolean	Whether this store supports the abandonedBrowse automation.
Automations_AbandondedBrowse_Id	String	Unique ID of automation parent campaign.
Automations_AbandondedBrowse_Status	String	Status of the abandonedBrowse automation. The allowed values are save, sending, paused.
ListIsActive	Boolean	The status of the list connected to the store, namely if it's deleted or disabled.

FacebookAds

Lists Facebook ads configured and managed through Mailchimp's integrated advertising feature.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM FacebookAds;
SELECT * FROM FacebookAds where Id='2';

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier assigned to the Facebook ad within the Mailchimp account.
Name	String	The display name of the Facebook ad as defined in the campaign configuration.
Type	String	The ad format or type, such as image, carousel, or video.
Status	String	The current delivery status of the Facebook ad, for example active, paused, canceled, or completed.
CreateTime	Datetime	The date and time when the Facebook ad was first created in Mailchimp.
UpdatedAt	Datetime	The date and time when the Facebook ad details were last modified.
StartTime	Datetime	The scheduled or actual start time for the ad's delivery.
EndTime	Datetime	The scheduled or actual end time for the ad's delivery.
PausedAt	Datetime	The date and time when the ad was paused manually or automatically.
CanceledAt	Datetime	The date and time when the ad was canceled and stopped running.
PublishedTime	Datetime	The date and time when the ad was published or made live.
WebId	Integer	The unique web identifier for the Facebook ad used within the Mailchimp interface.
HasAudience	Boolean	If the value is 'true', the Facebook ad has an assigned target audience.
HasContent	Boolean	If the value is 'true', the ad contains creative content such as text, links, or images.
HasSegment	Boolean	If the value is 'true', the ad targets a specific segment of an audience.
IsConnected	Boolean	If the value is 'true', the ad is connected to an active Facebook Ad account.
NeedsAttention	Boolean	If the value is 'true', the ad requires review or updates due to configuration or performance issues.
ShowReport	Boolean	If the value is 'true', a performance report is available for this ad.
WasCanceledByFacebook	Boolean	If the value is 'true', the ad was canceled automatically by Facebook due to a policy or technical issue.
Thumbnail	String	The URL of the thumbnail image representing the ad's creative.
EmailSourceName	String	The name of the email source linked to the Facebook ad.
AudienceEmailSourceIsSegment	Boolean	If the value is 'true', the audience email source is based on a Mailchimp segment.
AudienceEmailSourceListName	String	The name of the Mailchimp audience list used as the source for the ad.
AudienceEmailSourceName	String	The display name of the email audience source connected to the ad.
AudienceEmailSourceSegmentType	String	The type of Mailchimp segment used as the source audience for the ad.
AudienceEmailSourceType	String	The data source type used to build the audience, such as list or saved segment.
AudienceIncludeSourceInTarget	Boolean	If the value is 'true', the audience source is included in the targeting configuration.
AudienceLookalikeCountryCode	String	The two-letter ISO 3166 country code specifying the location used for lookalike audience targeting.
AudienceSourceType	String	The origin or method used to create the audience, such as custom audience or lookalike audience.
AudienceTargetingSpecsGender	Integer	The gender value used for audience targeting (for example, 1 for male, 2 for female).
AudienceTargetingSpecsInterests	String	The list of interest categories used for audience targeting.
AudienceTargetingSpecsLocationsCities	String	The cities specified for geographic targeting of the ad.
AudienceTargetingSpecsLocationsCountries	String	The countries specified for geographic targeting of the ad.
AudienceTargetingSpecsLocationsRegions	String	The regions specified for geographic targeting of the ad.
AudienceTargetingSpecsLocationsZips	String	The postal codes or ZIP ranges specified for the audience's geographic targeting.
AudienceTargetingSpecsMaxAge	Integer	The maximum age value used in audience targeting.
AudienceTargetingSpecsMinAge	Integer	The minimum age value used in audience targeting.
AudienceType	String	The overall audience classification, such as custom, lookalike, or saved segment.
BudgetCurrencyCode	String	The three-letter ISO 4217 currency code used for the ad budget.
BudgetDuration	Integer	The duration of the ad's budget, usually defined in days.
BudgetTotalAmount	Integer	The total allocated budget amount for the Facebook ad.
ChannelFbPlacementAudience	Boolean	If the value is 'true', the ad is placed in the Facebook Audience Network.
ChannelFbPlacementFeed	Boolean	If the value is 'true', the ad appears in the Facebook feed.
ChannelIgPlacementFeed	Boolean	If the value is 'true', the ad appears in the Instagram feed.
ContentAttachments	String	A list of attachments included in the ad creative, such as images or videos.
ContentCallToAction	String	The call-to-action text or button displayed in the ad, such as 'Shop Now' or 'Learn More'.
ContentDescription	String	A short description or summary of the ad's content.
ContentImageUrl	String	The URL of the primary image used in the Facebook ad.
ContentLinkUrl	String	The destination URL where users are directed when clicking on the ad.
ContentMessage	String	The main message or caption text used in the ad creative.
ContentTitle	String	The headline or title of the ad as it appears in Facebook placements.
FeedbackAudience	String	Feedback or system notes related to the audience configuration of the ad.
FeedbackBudget	String	Feedback or recommendations regarding the ad's budget configuration.
FeedbackCompliance	String	Feedback related to compliance with Facebook advertising policies.
FeedbackContent	String	Feedback or notes related to the content or creative of the ad.
RecipientsListId	String	The unique identifier of the Mailchimp audience list used to create or target recipients.
RecipientsListIsActive	Boolean	If the value is 'true', the associated audience list is active and available for targeting.
RecipientsListName	String	The name of the Mailchimp audience list associated with the ad.
RecipientsRecipientCount	Integer	The total number of recipients targeted by the ad.
RecipientsSegmentOptsConditions	String	The conditions that define how recipients are segmented for targeting.
RecipientsSegmentOptsMatch	String	The logic operator used to match segment conditions (for example, 'any' or 'all').
RecipientsSegmentOptsPrebuiltSegmentId	String	The unique identifier of a prebuilt Mailchimp segment used for recipient targeting.
RecipientsSegmentOptsSavedSegmentId	Integer	The ID of a saved Mailchimp segment used in the ad configuration.
RecipientsSegmentText	String	A human-readable description of the segment configuration used for the ad.
ReportSummaryClickRate	Integer	The percentage of clicks compared to total impressions, as recorded in the report summary.
ReportSummaryClicks	Integer	The total number of user clicks recorded in the report summary.
ReportSummaryConversionRate	Integer	The conversion rate percentage based on post-click actions.
ReportSummaryEcommerceAverageOrderRevenue	Integer	The average order value attributed to the ad's e-commerce activity.
ReportSummaryEcommerceCurrencyCode	String	The three-letter ISO 4217 currency code used for e-commerce reporting metrics.
ReportSummaryEcommerceTotalRevenue	Integer	The total e-commerce revenue generated from the Facebook ad.
ReportSummaryEngagements	Integer	The number of engagements (likes, shares, comments) recorded for the ad.
ReportSummaryImpressions	Integer	The total number of times the ad was displayed to users.
ReportSummaryOpenRate	Integer	The open rate percentage if the ad is linked to an email-based campaign.
ReportSummaryOpens	Integer	The total number of opens recorded for email-linked ad campaigns.
ReportSummaryProxyExcludedOpenRate	Integer	The open rate excluding proxy opens (for example, those generated by email security filters).
ReportSummaryProxyExcludedOpens	Integer	The total number of opens excluding proxy-generated events.
ReportSummaryProxyExcludedUniqueOpens	Integer	The total number of unique opens excluding proxy activity.
ReportSummaryReach	Integer	The total number of unique users who saw the ad at least once.
ReportSummarySubscriberClicks	Integer	The total number of clicks generated by subscribers targeted through the ad.
ReportSummarySubscribes	Integer	The total number of new subscribers gained as a result of the ad campaign.
ReportSummaryTotalSent	Integer	The total number of ad impressions or deliveries completed.
ReportSummaryUniqueOpens	Integer	The number of unique opens recorded in the report summary.
ReportSummaryUniqueVisits	Integer	The total number of unique visits to linked destinations from the ad.
ReportSummaryVisits	Integer	The total number of visits generated by the ad.
SiteId	Integer	The unique identifier of the connected site linked to this Facebook ad.
SiteName	String	The display name of the connected site associated with the ad.
SiteUrl	String	The URL of the connected site or landing page where ad traffic is directed.

FileManagerFolderFiles

Lists files organized within specific folders in the Mailchimp File Manager.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

FolderId supports the '=' operator.

For example:

SELECT * FROM FileManagerFolderFiles;
SELECT * FROM FileManagerFolderFiles where FolderId=1002;

Columns


Name	Type	Description
Id [KEY]	Integer	The unique identifier assigned to the file within Mailchimp's File Manager, used to locate and manage the file programmatically.
FolderId [KEY]	Integer	The unique identifier of the folder where the file is stored, allowing grouping of assets such as images, documents, and templates for easier organization.
CreatedAt	Datetime	The date and time when the file was uploaded or created in the File Manager, recorded in ISO 8601 format for auditing and version tracking.
CreatedBy	String	The username or identifier of the Mailchimp account user who uploaded or added the file, helping track content ownership and contributions.
FullSizeUrl	String	The direct URL to access or download the full-size version of the file, typically used when embedding assets in campaigns or templates.
Height	Integer	The height of the file in pixels, available for image files to support responsive design and layout control.
Name	String	The display name of the file as it appears in the File Manager interface and when referenced in campaigns or automations.
Size	Integer	The size of the file in bytes, representing the storage space used by this individual file.
ThumbnailUrl	String	The URL for the thumbnail preview of the file, used in the File Manager and editor interfaces to visually identify assets.
Type	String	Specifies the file type, such as 'image', 'document', or 'video', determining how the file can be previewed or embedded in campaigns.
Width	Integer	The width of the file in pixels, available for image files to assist with media placement and optimization.
TotalFileSize	Decimal	The cumulative size of all files stored in the File Manager, expressed in bytes, providing insight into total storage utilization for the account.

LandingPageContents

Retrieves the content and layout details of a specific landing page.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

PageId supports the '=' operator.

For example:

SELECT * FROM LandingPageContents;
SELECT * FROM LandingPageContents where PageId='2';

Columns


Name	Type	Description
PageId [KEY]	String	The unique identifier of the landing page, used to reference and retrieve specific page content or metadata through the Mailchimp API.
Html	String	The raw HTML code that defines the visual layout and design of the landing page, including embedded text, images, and links used in campaigns.
Json	String	The structured JSON representation of the landing page, containing its configuration, design components, and content hierarchy for programmatic access or updates.

LandingPages

Lists landing pages created in the account, including URLs, design information, and publishing status.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM LandingPages;
SELECT * FROM LandingPages where Id='2';

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier for the landing page, used to reference and manage it within Mailchimp's system or through API calls.
Name	String	The internal name of the landing page, helping users identify it within their Mailchimp account or organize multiple campaigns.
Title	String	The public title of the landing page, typically displayed to visitors and used in browser tabs or search engine previews.
Description	String	A short description of the landing page's purpose or content, often used for internal documentation or reporting.
TemplateId	Integer	The identifier of the design template applied to the landing page, determining its layout, structure, and styling.
Status	String	The current publishing state of the landing page. The allowed values are published, unpublished, draft.
ListId	String	The unique identifier of the Mailchimp audience (list) linked to the landing page, defining where signups and collected contacts are stored.
StoreId	String	The unique identifier of the connected eCommerce store associated with the landing page, if applicable.
WebId	Integer	The Mailchimp web application ID used to access and manage the landing page directly from the account interface.
CreatedAt	Datetime	The date and time when the landing page was originally created, stored in ISO 8601 format for tracking and auditing.
UpdatedAt	Datetime	The date and time of the most recent modification to the landing page's content or settings.
PublishedAt	Datetime	The date and time when the landing page was made publicly accessible.
UnpublishedAt	Datetime	The date and time when the landing page was taken offline or reverted to draft status.
CreatedBySource	String	Indicates the origin of the landing page creation, such as through the Mailchimp editor, API, or a third-party integration.
TrackingTrackWithMailchimp	Boolean	If the value is 'true', Mailchimp's tracking is enabled to record link clicks and engagement data for performance analysis.
TrackingEnableRestrictedDataProcessing	Boolean	If the value is 'true', restricted data processing is enabled to comply with data protection regulations.
Url	String	The public-facing URL where the landing page is hosted and accessible to visitors.

ListAbuse

Contains abuse complaints for a specific audience list, typically submitted when a recipient marks an email as spam.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
ListId supports the '=' operator.

SELECT * FROM ListAbuse WHERE ListId = 'abc' and Id='452'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier assigned to the abuse report, used to track and retrieve complaint details for a specific incident.
CampaignId [KEY]	String	The unique identifier of the Mailchimp campaign that generated the abuse report, allowing correlation between campaigns and complaint activity.
ListId [KEY]	String	The unique identifier of the audience (list) from which the complaint originated, helping identify where the affected subscriber belongs.
EmailId [KEY]	String	The MD5 hash of the lowercase version of the subscriber's email address, used for securely referencing the member within the API.
EmailAddress	String	The actual email address of the subscriber who reported the message as spam or abuse.
Date	String	The date and time when the abuse report was logged, typically captured in ISO 8601 format for accurate event tracking.
MergeFields	String	A set of merge field data for the subscriber, represented as key-value pairs where the keys are merge tags (for example, FNAME, LNAME).
VIP	Boolean	If the value is 'true', the subscriber is marked as a VIP within the list. This helps identify high-priority contacts when reviewing abuse reports.

ListActivity

Displays up to 180 days of daily aggregated activity statistics for a given audience list, excluding automation events.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.

SELECT * FROM ListActivity WHERE ListId = 'abc'

Columns


Name	Type	Description
ListId [KEY]	String	The unique identifier of the Mailchimp audience (list) associated with the activity summary, used to group engagement data by list.
Day [KEY]	Date	The specific date the activity metrics apply to, representing one day of engagement and delivery performance.
EmailsSent	Integer	The total number of campaign emails sent to subscribers on the specified date.
UniqueOpens	Integer	The number of distinct subscribers who opened at least one email on that day, excluding multiple opens by the same recipient.
RecipientClicks	Integer	The total number of recipients who clicked at least one link within a campaign email on that day.
HardBounce	Integer	The number of emails that permanently failed to deliver due to invalid addresses or other non-recoverable issues.
SoftBounce	Integer	The number of emails that temporarily failed to deliver, often caused by full inboxes or temporary mail server issues.
Subs	Integer	The total number of new subscribers who joined the list on that date through forms, campaigns, or API integrations.
Unsubs	Integer	The number of subscribers who opted out or unsubscribed from the list on that date.
OtherAdds	Integer	The number of subscribers added to the list through non-standard methods, such as manual imports or API-based additions, outside the typical signup flow.
OtherRemoves	Integer	The number of subscribers removed outside of unsubscribing or abuse reports, such as deletions or administrative removals.

ListClients

Summarizes the most common email clients used by subscribers, based on user-agent data.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.

SELECT * FROM ListClients WHERE ListId = 'abc'

Columns


Name	Type	Description
Client	String	The name of the email client or application (such as Gmail, Outlook, or Apple Mail) used by subscribers to open or read campaign emails.
Members	Integer	The number of active or subscribed members who engaged with campaigns using the specified email client, providing insight into client popularity and compatibility.
ListId [KEY]	String	The unique identifier of the Mailchimp audience (list) these engagement statistics belong to, allowing tracking across different subscriber groups.

ListFacebookEcommerceReport

List the breakdown of product activity for an outreach in Mailchimp.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ReportingFacebookAdId supports the '=' operator.

SELECT * FROM ListFacebookEcommerceReport;
SELECT * FROM ListFacebookEcommerceReport WHERE ReportingFacebookAdId = '12345';

Columns


Name	Type	Description
ReportingFacebookAdId	String	A unique identifier for the Facebook ad report.
Title	String	The title of the product.
Sku	String	The sku of the product.
ImageUrl	String	The image url of the product.
TotalRevenue	Decimal	Total revenue of the product.
TotalPurchased	Decimal	The count of total products purchased.
CurrencyCode	String	The currency code.
RecommendationTotal	Integer	The recommendation total count.
RecommendationPurchased	Integer	The recommendation purchased count.

ListGrowthHistory

Shows month-by-month subscription growth trends for a specific audience list.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.

SELECT * FROM ListGrowthHistory WHERE ListId = 'abc'

Columns


Name	Type	Description
ListId [KEY]	String	The unique identifier of the Mailchimp audience (list) the growth metrics apply to, used for analyzing subscriber trends over time.
Month [KEY]	String	The month the growth activity data represents, typically formatted as YYYY-MM to summarize monthly changes in list size.
Subscribed	Integer	The total number of active subscribers on the list at the end of the specified month, including new signups and reactivated members.
Unsubscribed	Integer	The total number of members who unsubscribed from the list during the specified month.
Reconfirm	Integer	The number of subscribers who reconfirmed their opt-in status during the specified month, often due to double opt-in or General Data Protection Regulation (GDPR) compliance processes.
Cleaned	Integer	The number of addresses automatically cleaned from the list due to hard bounces or invalid email addresses during the specified month.
Pending	Integer	The number of pending subscribers who have not yet confirmed their opt-in at the end of the specified month.
Deleted	Integer	The number of subscribers who were manually deleted or removed by administrators during the specified month.
Transactional	Integer	The number of subscribers who were sent transactional emails (such as order confirmations or receipts) via Mandrill during the specified month.

ListLocations

List the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address in Mailchimp.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.

SELECT * FROM ListLocations;
SELECT * FROM ListLocations WHERE ListId = '12345';

Columns


Name	Type	Description
ListId	String	The unique id for the list.
Country	String	The name of the country.
CC	String	The ISO 3166 2 digit country code.
Percent	Decimal	The percent of subscribers in the country.
Total	Integer	The total number of subscribers in the country.

ListMemberActivity

The last 50 member events for a list.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

MemberId supports the '=' operator.
ListId supports the '=' operator.
Action supports the '=, IN' operator.

SELECT * FROM ListMemberActivity where ListId='121' and Action IN ('open', 'sent') and MemberId = '1211'

Columns


Name	Type	Description
MemberId	String	The MemberId of the member to get events for.
EmailId	String	The EmailId for the table.
ListId	String	The ListId for the table.
Action	String	The type of action recorded for the subscriber.
Timestamp	Datetime	The date and time recorded for the action.
Url	String	For clicks, the URL the subscriber clicked on.
Type	String	The type of campaign that was sent.
CampaignId	String	The web-based ID for the campaign.
Title	String	If set, the campaign's title.
ParentCampaign	String	The ID of the parent campaign.
ContactId	String	The ID of the contact.

ListMemberActivityFeeds

Shows a member's engagement activity on a specific list, including email opens, link clicks, and unsubscribes.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

EmailId supports the '=' operator.
ListId supports the '=' operator.
ActivityType supports the '=, IN' operator.

For example:

SELECT * FROM ListMemberActivityFeeds;
SELECT * FROM ListMemberActivityFeeds where EmailId='2' amd ListId='565';
SELECT * FROM ListMemberActivityFeeds where ActivityType = 'open';
SELECT * FROM ListMemberActivityFeeds where ActivityType IN ('open','sent');

Columns


Name	Type	Description
EmailId	String	The MD5 hash of the lowercase version of the subscriber's email address, used to securely identify the list member.
ListId	String	The unique identifier of the Mailchimp audience (list) associated with the recorded event activity.
ActivityType	String	The specific type of event activity performed by or related to the subscriber, such as an open, click, bounce, or unsubscribe.
CreatedAtTimestamp	Datetime	The date and time when the event occurred, formatted in ISO 8601 for consistent tracking across campaigns.
CampaignId	String	The unique identifier of the campaign associated with the recorded activity, used to link engagement data back to a specific send.
CampaignTitle	String	The title of the campaign where the event occurred, providing context for the associated campaign activity.
LinkClicked	String	The URL that the subscriber clicked, recorded during link-click tracking events to measure engagement and link performance.
BounceType	String	The classification of the email bounce, indicating the nature of the delivery issue. The allowed values are hard, soft.
BounceHasOpenActivity	Boolean	If the value is 'true', indicates that the bounced email also registered an open event for the same campaign.
IsAdminUnsubscribed	Boolean	If the value is 'true', indicates that the subscriber was manually unsubscribed by an account administrator.
UnsubscribeReason	String	The reason the contact was unsubscribed, such as user request, spam complaint, or manual removal.
ThreadId	String	The unique identifier of the conversation thread associated with this event, if applicable.
MessageText	String	The full text content of a message or reply within the conversation thread.
CreatedBy	String	The username of the Mailchimp user who created or triggered the event, such as adding a note or responding to a conversation.
IsUser	Boolean	If the value is 'true', indicates that the message or event was created by a Mailchimp user rather than a subscriber.
HasRead	Boolean	If the value is 'true', indicates that the message has been opened and read by a user.
FromEmail	String	The email address of the contact who sent the message or reply associated with this event.
AvatarUrl	String	The Gravatar or profile image URL associated with the contact who sent the reply.
UpdatedAtTimestamp	Datetime	The date and time when the event or related record was last updated, formatted in ISO 8601.
NoteId	String	The unique identifier of a note associated with the contact or event.
NoteText	String	The full text of the note attached to the contact or event for internal tracking or collaboration.
MarketingPermissonText	String	The text describing the specific marketing permission granted by the subscriber, outlining the purpose of communication consent.
UpdatedBy	String	The name or identifier of the user who last updated the marketing permission record.
MarketingPermissionOptedIn	Boolean	If the value is 'true', indicates that the contact has opted in to receive marketing communications under the described permission.
OutreachId	String	The unique identifier for the outreach action, such as a campaign, ad, or automation that triggered the event.
OutreachType	String	The category or format of the outreach that caused the activity, such as 'email', 'ad', or 'survey'.
OutreachTitle	String	The title of the outreach that generated the event, helping link the engagement data to a specific marketing initiative.
StoreName	String	The name of the store associated with the contact or transaction, if the activity relates to an e-commerce event.
SignupCategory	String	Indicates how the subscriber was added to the list, such as via a signup form, import, or API integration.
OrderId	String	The unique identifier for the order associated with the event, linking marketing engagement to a specific purchase.
OrderTotal	String	The total value of the order formatted as a string, used to measure revenue influenced by campaigns.
OrderItems	String	A structured list of items purchased in the order, providing product-level details for e-commerce tracking.
OrderUrl	String	The URL where the order can be viewed or managed within the connected e-commerce platform.
EventName	String	The name of the recorded event, such as a form submission, link click, or purchase.
EventProperties	String	A structured datastore containing additional details and properties related to the recorded event.
SurveyId	String	The unique identifier of the survey associated with the event, if the activity relates to survey participation.
SurveyTitle	String	The title of the survey that triggered the event, allowing correlation between feedback and campaign performance.

ListMemberGoals

Displays goal-tracking events for list members, such as website visits or conversions recorded by Mailchimp.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.
EmailId supports the '=' operator.

SELECT * FROM ListMemberGoals WHERE ListId = '121' and EmailId = '11'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier for the goal event, used to track and reference specific subscriber actions or milestones.
ListId	String	The unique identifier of the Mailchimp audience (list) associated with the subscriber who triggered the goal event.
EmailId	String	The unique identifier of the email campaign or automation message that led to the goal event, allowing attribution of the action to a specific email.
GoalsId	String	The unique identifier of the goal that was achieved or triggered, such as completing a purchase, visiting a page, or signing up.
GoalsEvent	String	The type of goal-related activity recorded, such as 'visited', 'completed', or 'converted', defining how the subscriber interacted with the tracked objective.
GoalsLastVisitedAt	Datetime	The most recent date and time the subscriber performed the tracked action related to this goal, formatted in ISO 8601.
GoalsData	String	A JSON object containing additional contextual data about the event, such as page URLs, campaign details, or conversion metrics.

ListMemberTags

Tags assigned to a certain member/members.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
ListId supports the '=' operator.
MemberId supports the '=' operator.

SELECT * FROM ListMemberTags WHERE ListId = '12345' and MemberId = '458' and Id = '45';

Columns


Name	Type	Description
Id [KEY]	String	The unique ID of the tag.
Name	String	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	Date and time the tag was added to the member.
ListId [KEY]	String	The ID of the list on which the member of this tag belongs to.
MemberId [KEY]	String	The ID of the member this tag is assigned to.

ListSignupForms

Collection of List Signup Forms

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.

SELECT * FROM ListSignupForms WHERE ListId = 'abc'

Columns


Name	Type	Description
Header_ImageUrl	String	Header Image Url
Header_Text	String	Header Text
Header_ImageWidth	String	Image width
Header_ImageHeight	String	Image height
Header_ImageAlt	String	Image Alt
Header_ImageLink	String	Image Link
Header_ImageAlign	String	Image align
Header_ImageBorderWidth	String	Image border width
Header_ImageBorderStyle	String	Image border style
Header_ImageBorderColor	String	Image border color
Header_ImageTarget	String	Image target
Contents	String	Signup form body contents options
Styles	String	An array of objects, each representing each element of signup forms.
SignupFormUrl	String	Signup form URL
ListId [KEY]	String	A string that identifies this signup forms' list.

ListsTagsSearch

Enables searching for specific tags applied to members within an audience list.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.
Name supports the '=, LIKE' operator.

Note: for LIKE operator only StartsWith operation is supported server side. For example:

SELECT * FROM ListsTagsSearch;
SELECT * FROM ListsTagsSearch where ListId='123';
SELECT * FROM ListsTagsSearch where Name='aaaa';
SELECT * FROM ListsTagsSearch where Name LIKE 'aa%';

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the tag within the Mailchimp audience.
Name	String	The name of the tag. When inserting the tag name, if it does not exist, it is automatically created and assigned to the specified list member.
ListId [KEY]	String	The unique identifier of the Mailchimp list (audience) that the tag belongs to.

ListSurveys

Returns all survey configurations associated with a specific audience list.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

ListId supports the '=' operator.
Id supports the '=' operator.

SELECT * FROM ListSurveys where ListId='545578' and Id='092ec96'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the survey within the Mailchimp account.
ListId	String	The unique identifier of the Mailchimp list (audience) associated with the survey.
Title	String	The title of the survey, as displayed to recipients.
Status	String	The current status of the survey, such as 'draft', 'published', or 'closed'.
CreatedAt	Datetime	The date and time when the survey was initially created.
UpdatedAt	Datetime	The date and time when the survey was last modified.
PublishedAt	Datetime	The date and time when the survey was published and made available to respondents.
HostedUrl	String	The public URL where the survey is hosted and can be accessed by participants.
WebId	String	The unique web identifier used to reference the survey in the Mailchimp web application.
IsPipedToInbox	Boolean	Indicates whether survey responses are automatically delivered to the user's Mailchimp inbox for review.
QuestionCount	Integer	The total number of questions included in the survey.
Questions	String	A structured list or array containing the individual questions that make up the survey.
ResponseCount	Integer	The total number of responses collected for the survey.

ReportAbuse

Displays records of abuse complaints for a specific list or campaign.

Table Specific Information

SELECT is supported for ReportAbuse.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
CampaignId supports the '=' operator.

SELECT * FROM ReportAdvice WHERE CampaignId = 'abc' and Id = '556'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the abuse report within the Mailchimp account.
CampaignId [KEY]	String	The unique identifier of the campaign that received the abuse complaint.
ListId [KEY]	String	The unique identifier of the audience (list) associated with the abuse report.
EmailId [KEY]	String	The list-specific identifier for the subscriber's email address that submitted the complaint.
EmailAddress	String	The email address of the subscriber who reported the message as spam or abuse.
Date	String	The date and time when the abuse complaint was recorded.
MergeFields	String	A set of key-value pairs representing merge fields associated with the subscriber, where keys are merge tags and values contain subscriber data.
VIP	Boolean	If the value is 'true', it indicates that the subscriber has VIP status in the list.
ListIsActive	Boolean	If the value is 'true', it indicates that the associated audience (list) is currently active; if 'false', the list has been deleted or disabled.

ReportAdvice

Provides campaign performance feedback and optimization tips based on engagement metrics.

Table Specific Information

SELECT is supported for ReportAdvice.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

CampaignId supports the '=' operator.

SELECT * FROM ReportAdvice WHERE CampaignId = 'abc'

Columns


Name	Type	Description
CampaignId	String	The unique identifier of the campaign that the advice or feedback is related to.
Type	String	The classification of the advice message, which can be 'negative', 'positive', or 'neutral', indicating the overall sentiment or evaluation.
Message	String	The content of the advice or feedback message, typically generated from campaign performance analysis or deliverability insights.

ReportClickDetails

A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.

Table Specific Information

SELECT is supported for ReportClickDetails.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
CampaignId supports the '=' operator.

SELECT * FROM ReportClickDetails WHERE CampaignId = 'abc' and Id = '5659'

Columns


Name	Type	Description
Id [KEY]	String
Url	String	The URL for the link in the campaign.
TotalClicks	Integer	The number of total clicks for a given link.
ClickPercentage	Double	The percentage of total clicks a given link generated for a campaign.
UniqueClicks	Integer	Number of unique clicks for a given link.
UniqueClickPercentage	Double	The percentage of unique clicks a given link generated for a campaign.
LastClick	Datetime	The date and time for the last recorded click for a given link.
AbSplit_A	String
AbSplit_B	String
CampaignId [KEY]	String	The id for the campaign.

ReportClickDetailsMembers

Displays the subscribers who clicked on specific links within a campaign.

Table Specific Information

SELECT is supported for ReportClickDetailsMembers.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

EmailId supports the '=' operator.
CampaignId supports the '=' operator.
UrlId supports the '=' operator.

SELECT * FROM ReportClickDetailsMembers WHERE EmailId = '12a32' and CampaignId = '123d' and URLId = '3241s'

Columns


Name	Type	Description
EmailId [KEY]	String	The list-specific identifier for the subscriber's email address within the campaign report.
EmailAddress	String	The subscriber's email address associated with the recorded clicks.
Clicks	Integer	The total number of times this subscriber clicked on the specific tracked link in the campaign.
CampaignId [KEY]	String	The unique identifier of the campaign in which the clicks were recorded.
UrlId [KEY]	String	The unique identifier of the tracked URL that the subscriber clicked on.
ListId [KEY]	String	The unique identifier of the audience (list) associated with the campaign.
ListIsActive	Boolean	If the value is 'true', the list is currently active; if 'false', it has been deleted or disabled.
ContactStatus	String	The current status of the subscriber in the list, such as subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or awaiting reconfirmation.
MergeFields	String	A collection of merge fields for the subscriber, where keys represent merge tags and values contain associated data (for example, first name or company).
VIP	Boolean	If the value is 'true', indicates that the subscriber holds VIP status in the list.

ReportDomainPerformance

Statistics for the top-performing email domains in a campaign.

Table Specific Information

SELECT is supported for ReportDomainPerformance.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

CampaignId supports the '=' operator.

SELECT * FROM ReportDomainPerformance WHERE CampaignId = 'abc'

Columns


Name	Type	Description
CampaignId	String	The CampaignId for the table.
Domain	String	The name of the domain (gmail.com, hotmail.com, yahoo.com).
EmailsSent	Integer	The number of emails sent to that specific domain.
Bounces	Integer	The number of bounces at a domain.
Opens	Integer	The number of opens for a domain.
Clicks	Integer	The number of clicks for a domain.
Unsubs	Integer	The total number of unsubscribes for a domain.
Delivered	Integer	The number of successful deliveries for a domain.
EmailsPct	Double	The percentage of total emails that went to this domain.
BouncesPct	Double	The percentage of total bounces that came from this domain.
OpensPct	Double	The percentage of total opens that came from this domain.
ClicksPct	Double	The percentage of total clicks tht came from this domain.
UnsubsPct	Double	The percentage of total unsubscribes that came from this domain.
TotalSent	Integer	The total number of emails sent for the campaign.

ReportEepUrls

Provides detailed activity reports for EepURLs (Mailchimp's link-tracking redirects).

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

CampaignId supports the '=' operator.

For example:

SELECT * FROM ReportEepUrls;
SELECT * FROM ReportEepUrls where CampaignId='1121';

Columns


Name	Type	Description
CampaignId	String	The unique identifier of the campaign associated with this EepURL performance report.
Eepurl	String	The shortened Mailchimp tracking URL (EepURL) used to monitor engagement and sharing activity for the campaign.
ClicksClicks	Integer	The total number of times recipients or visitors clicked on this tracked EepURL.
ClicksFirstClick	Datetime	The date and time when the first recorded click on this EepURL occurred.
ClicksLastClick	Datetime	The date and time when the most recent click on this EepURL occurred.
ClicksLocations	String	An array of geographic locations representing where clicks on this EepURL originated.
Referrers	String	An array of referrer sources, such as websites or social networks, that directed traffic to this EepURL.
TwitterTweets	Integer	The total number of tweets that included this EepURL.
TwitterRetweets	Integer	The total number of retweets involving this EepURL.
TwitterStatuses	String	An array of tweet statuses that mention or include this EepURL.
TwitterFirstTweet	String	The text or identifier of the first tweet that contained this EepURL.
TwitterLastTweet	String	The text or identifier of the most recent tweet that contained this EepURL.

ReportEmailActivity

A list of member's subscriber activity in a specific campaign.

Table Specific Information

SELECT is supported for ReportEmailActivity.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

CampaignId supports the '=' operator.

SELECT * FROM ReportEmailActivity where CampaignId = '45a'

Columns


Name	Type	Description
CampaignId [KEY]	String	The unique id for the campaign.
ListId [KEY]	String	The unique id for the list.
EmailId [KEY]	String	The list-specific ID for the given email address.
EmailAddress	String	Email address for a subscriber
Activity	String	An array of objects, each showing an interaction with the email.
ListIsActive	Boolean	The status of the list used, namely if it's deleted or disabled.

ReportingFacebookAds

Lists performance reports for Facebook ad campaigns managed through Mailchimp.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM ReportingFacebookAds;
SELECT * FROM ReportingFacebookAds where Id='2';

Columns


Name	Type	Description
Id [KEY]	String	A unique identifier for the Facebook ad report.
AudienceEmailSourceIsSegment	Boolean	A value of 'true' indicates that the audience email source is based on a segment.
AudienceEmailSourceListName	String	The name of the mailing list used as the audience source for the Facebook ad report.
AudienceEmailSourceName	String	The name assigned to the audience email source that defines the target group.
AudienceEmailSourceSegmentType	String	The segment type used for the audience email source, such as static or dynamic.
AudienceEmailSourceType	String	The type of audience email source, for example, a Mailchimp list or custom segment.
AudienceIncludeSourceInTarget	Boolean	If the value is 'true', the original source in the target audience for the campaign is included.
AudienceLookalikeCountryCode	String	The country code representing where lookalike audiences are targeted.
AudienceSourceType	String	The classification of the audience source used to generate the ad report.
AudienceTargetingSpecsGender	Integer	Specifies gender-based targeting criteria for the audience, if applicable.
AudienceTargetingSpecsInterests	String	Defines the audience's targeting interests, such as hobbies or categories of engagement.
AudienceTargetingSpecsLocationsCities	String	Lists the cities included in the location-based audience targeting.
AudienceTargetingSpecsLocationsCountries	String	Lists the countries targeted by the Facebook ad campaign.
AudienceTargetingSpecsLocationsRegions	String	Lists the regions targeted by the Facebook ad campaign.
AudienceTargetingSpecsLocationsZips	String	Specifies the zip codes targeted by the Facebook ad campaign.
AudienceTargetingSpecsMaxAge	Integer	The maximum age range defined in the audience targeting criteria.
AudienceTargetingSpecsMinAge	Integer	The minimum age range defined in the audience targeting criteria.
AudienceType	String	The type of audience, such as custom, lookalike, or saved.
AudienceActivityClicks	String	The total number of clicks generated by audience activity.
AudienceActivityImpressions	String	The total number of impressions recorded from audience activity.
AudienceActivityRevenue	String	The total revenue attributed to audience interactions with the ad.
BudgetCurrencyCode	String	The currency code used for the campaign's allocated budget.
BudgetDuration	Integer	The total duration of the campaign's budget period, typically measured in days.
BudgetTotalAmount	Integer	The total monetary amount allocated as the campaign's budget.
CanceledAt	Datetime	The date and time when the Facebook ad campaign was canceled.
ChannelFbPlacementAudience	Boolean	A value of 'true' indicates that the ad is placed in the Facebook Audience Network.
ChannelFbPlacementFeed	Boolean	A value of 'true' indicates that the ad appears in the Facebook feed.
ChannelIgPlacementFeed	Boolean	A value of 'true' indicates that the ad is displayed in the Instagram feed.
CreateTime	Datetime	The date and time when the Facebook ad report was created.
EmailSourceName	String	The name of the email source associated with the campaign.
EndTime	Datetime	The date and time when the Facebook ad campaign ended.
HasSegment	Boolean	A value of 'true' indicates that the ad report includes a defined audience segment.
Name	String	The name assigned to the Facebook ad report.
NeedsAttention	Boolean	A value of 'true' indicates that the Facebook ad report requires attention due to issues or alerts.
PausedAt	Datetime	The date and time when the Facebook ad campaign was paused.
PublishedTime	Datetime	The date and time when the Facebook ad campaign was published.
RecipientsListId	String	The unique identifier of the recipient list used for the Facebook ad report.
RecipientsListIsActive	Boolean	A value of 'true' indicates that the recipient list is active; 'false' if deleted or disabled.
RecipientsListName	String	The name of the recipient list associated with the Facebook ad report.
RecipientsRecipientCount	Integer	The total number of recipients included in the Facebook ad report.
RecipientsSegmentOptsConditions	String	The logical conditions that define the segment options for the recipients.
RecipientsSegmentOptsMatch	String	Specifies how segment conditions are matched, such as 'any' or 'all'.
RecipientsSegmentOptsPrebuiltSegmentId	String	The identifier for a prebuilt segment used in the recipient configuration.
RecipientsSegmentOptsSavedSegmentId	Integer	The identifier for a saved segment associated with the recipient list.
RecipientsSegmentText	String	A textual representation of the segment definition used for recipient selection.
ReportSummaryAverageDailyBudgetAmount	Integer	The average daily budget amount allocated to the Facebook ad campaign.
ReportSummaryAverageDailyBudgetCurrencyCode	String	The currency code associated with the average daily budget amount.
ReportSummaryAverageOrderAmountAmount	Integer	The average order value generated from ad-driven conversions.
ReportSummaryAverageOrderAmountCurrencyCode	String	The currency code associated with the average order value.
ReportSummaryClickRate	Integer	The overall click rate, expressed as a percentage of total impressions.
ReportSummaryClicks	Integer	The total number of clicks recorded in the Facebook ad report.
ReportSummaryComments	Integer	The number of comments generated through engagement with the ad.
ReportSummaryConversionRate	Integer	The rate at which ad viewers completed desired actions, such as purchases or sign-ups.
ReportSummaryCostPerClickAmount	Integer	The average cost incurred for each click on the ad.
ReportSummaryCostPerClickCurrencyCode	String	The currency code used for the cost per click calculation.
ReportSummaryEcommerceAverageOrderRevenue	Integer	The average revenue generated per e-commerce order associated with the ad.
ReportSummaryEcommerceCurrencyCode	String	The currency code for e-commerce-related revenue metrics.
ReportSummaryEcommerceTotalRevenue	Integer	The total e-commerce revenue attributed to the Facebook ad campaign.
ReportSummaryEngagements	Integer	The total number of engagements, including clicks, likes, comments, and shares.
ReportSummaryExtendedAtDatetime	String	The timestamp indicating when the campaign's duration was extended.
ReportSummaryExtendedAtTimezone	String	The timezone used for the 'extended at' timestamp.
ReportSummaryFirstTimeBuyers	Integer	The number of first-time customers acquired through the Facebook ad campaign.
ReportSummaryHasExtendedAdDuration	Boolean	A value of 'true' indicates that the ad's duration was extended beyond its initial schedule.
ReportSummaryImpressions	Integer	The total number of impressions recorded during the campaign.
ReportSummaryLikes	Integer	The total number of likes the ad received on Facebook or Instagram.
ReportSummaryOpenRate	Integer	The percentage of ad viewers or email recipients who opened the content.
ReportSummaryOpens	Integer	The total number of opens recorded for the Facebook ad.
ReportSummaryProxyExcludedOpenRate	Integer	The open rate excluding proxy-related traffic, for more accurate reporting.
ReportSummaryProxyExcludedOpens	Integer	The total number of opens after excluding proxy-related activity.
ReportSummaryProxyExcludedUniqueOpens	Integer	The count of unique opens excluding proxy-related traffic.
ReportSummaryReach	Integer	The number of unique users who saw the Facebook ad at least once.
ReportSummaryReturnOnInvestment	Integer	The overall return on investment (ROI) for the Facebook ad campaign.
ReportSummaryShares	Integer	The number of times the ad was shared by viewers.
ReportSummarySubscriberClicks	Integer	The total number of clicks generated by subscribers in the audience.
ReportSummarySubscribes	Integer	The total number of new subscriptions generated through the ad.
ReportSummaryTotalOrders	Integer	The total number of orders attributed to the ad campaign.
ReportSummaryTotalProductsSold	Integer	The total number of products sold as a result of the campaign.
ReportSummaryTotalSent	Integer	The total number of ad deliveries or sends during the campaign.
ReportSummaryUniqueClicks	Integer	The number of unique users who clicked on the ad.
ReportSummaryUniqueOpens	Integer	The number of unique users who opened the ad content.
ReportSummaryUniqueVisits	Integer	The number of unique site visits generated by the campaign.
ReportSummaryVisits	Integer	The total number of visits resulting from the campaign.
ShowReport	Boolean	A value of 'true' indicates that the report is visible or enabled for display.
StartTime	Datetime	The date and time when the Facebook ad campaign started running.
Status	String	The current operational status of the Facebook ad report, such as active, paused, or completed.
Thumbnail	String	The thumbnail image associated with the Facebook ad report for identification or preview.
Type	String	The classification or type of Facebook ad report, such as conversion or engagement.
UpdatedAt	Datetime	The date and time when the Facebook ad report was last updated.
WasCanceledByFacebook	Boolean	A value of 'true' indicates that the ad campaign was canceled automatically by Facebook.
WebId	Integer	The internal web identifier used for tracking the Facebook ad report within Mailchimp.

ReportingLandingPages

Provides engagement and conversion metrics for landing pages published through Mailchimp.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

For example:

SELECT * FROM ReportingLandingPages;
SELECT * FROM ReportingLandingPages where Id='2';

Columns


Name	Type	Description
Id	String	The unique identifier assigned to the landing page within Mailchimp.
Clicks	Integer	The total number of clicks recorded on the landing page, including all link interactions.
ConversionRate	Decimal	The percentage of visitors who completed a desired action, such as subscribing or purchasing, on the landing page.
ListId	String	The unique identifier of the audience (list) associated with the landing page.
ListName	String	The name of the audience (list) that collects subscriber information from the landing page.
Name	String	The name assigned to the landing page for identification within Mailchimp.
PublishedAt	Datetime	The date and time when the landing page was published and became publicly accessible.
SignupTags	String	Tags automatically applied to subscribers who sign up through the landing page, useful for segmentation or automation.
Status	String	The current publication status of the landing page, such as 'draft', 'published', or 'unpublished'.
Subscribes	Integer	The total number of new subscriptions generated through the landing page.
TimeseriesDailyStatsClicks	String	A time series dataset showing the number of clicks per day for the landing page.
TimeseriesDailyStatsUniqueVisits	String	A time series dataset showing the number of unique daily visitors to the landing page.
TimeseriesDailyStatsVisits	String	A time series dataset showing the total number of daily visits, including repeat visits, to the landing page.
TimeseriesWeeklyStatsClicks	String	A time series dataset showing the number of clicks per week for the landing page.
TimeseriesWeeklyStatsUniqueVisits	String	A time series dataset showing the number of unique weekly visitors to the landing page.
TimeseriesWeeklyStatsVisits	String	A time series dataset showing the total number of weekly visits, including repeat visits, to the landing page.
Title	String	The title of the landing page as displayed to visitors in the browser or on the page header.
UniqueVisits	Integer	The number of distinct visitors who accessed the landing page, excluding repeat visits.
UnpublishedAt	Datetime	The date and time when the landing page was unpublished and removed from public access.
Url	String	The direct web address (URL) where the landing page is hosted.
Visits	Integer	The total number of visits to the landing page, including multiple visits by the same user.
WebId	Integer	The internal web identifier used by Mailchimp to reference the landing page.
EcommerceAverageOrderRevenue	Decimal	The average revenue per e-commerce order generated through the landing page.
EcommerceCurrencyCode	String	The three-letter ISO 4217 currency code used for e-commerce transactions related to the landing page.
EcommerceTotalOrders	Integer	The total number of e-commerce orders placed through or attributed to the landing page.
EcommerceTotalRevenue	Decimal	The total revenue generated from e-commerce transactions linked to the landing page.

ReportingSurveyQuestionAnswers

Lists responses to individual survey questions for analysis.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

SurveyId supports the '=' operator.
QuestionId supports the '=' operator.

For example:

SELECT * FROM ReportingSurveyQuestionAnswers;
SELECT * FROM ReportingSurveyQuestionAnswers where SurveyId='07328' and QuestionId='123';

Columns


Name	Type	Description
Id [KEY]	String	A unique identifier for the specific answer recorded in the survey results. Each answer is tied to one question within a single response.
SurveyId [KEY]	String	The unique identifier of the survey that the answer belongs to. This value links the response data to its parent survey record.
QuestionId [KEY]	String	The unique identifier of the specific question that this answer corresponds to within the survey.
ResponseId	String	The unique identifier for the full survey response submission that includes this answer. Multiple answers can belong to the same response.
SubmittedAt	Datetime	The exact date and time when the respondent submitted this answer to the survey.
Value	String	The value entered or selected by the respondent for this question. This can be a free-text answer, multiple-choice selection, or numeric rating, depending on the question type.
IsNewContact	Boolean	If the value is 'true', the answer was submitted by a newly added contact; if 'false', the respondent was an existing contact in the list.
ContactAvatarUrl	String	The URL of the contact's avatar image or profile picture, typically used to visually identify the respondent in reports.
ContactConsentsToOneToOneMessaging	Boolean	If the value is 'true', indicates that the respondent has explicitly consented to receive one-to-one messages or direct communications.
ContactContactId	String	The unique Mailchimp contact identifier associated with the respondent who submitted this survey answer. Unlike the email-based ID, this identifier can exist for non-email contacts as well.
ContactEmail	String	The email address of the respondent associated with this survey submission. Used to link the response to an existing or new subscriber.
ContactEmailId	String	The internal Mailchimp-generated identifier corresponding to the contact's email address. Useful for deduplication and cross-referencing within reports.
ContactFullName	String	The full name of the contact who provided the survey answer, if available from the respondent's profile or submission.
ContactPhone	String	The phone number associated with the contact who submitted the response, if provided in the contact record.
ContactStatus	String	The current subscription status of the contact who submitted the response. The allowed values are Subscribed, Unsubscribed, Non-Subscribed, Cleaned, Archived.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RespondentFamiliarityIs	String	A filter used to segment survey responses based on how familiar respondents are with the brand or sender. Possible values are 'new' (first-time contacts), 'known' (existing contacts), or 'unknown' (no familiarity data available).

ReportingSurveyQuestions

Returns summary data and response statistics for survey questions.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
SurveyId supports the '=' operator.

For example:

SELECT * FROM SurveyQuestions;
SELECT * FROM SurveyQuestions where Id='2' and SurveyId='1121';

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier assigned to the specific question within the survey, used to distinguish this question from others in reporting and analytics.
SurveyId [KEY]	String	The unique identifier of the survey that this question belongs to. This field links each question to its parent survey record.
Query	String	The text of the survey question as it appears to respondents (for example, 'How satisfied are you with our service?')
Type	String	The question format or response type, such as 'multiple choice', 'rating', 'text', or 'boolean'. It determines how responses are collected and stored.
Options	String	A list of predefined response options available for the question, typically represented in JSON or array format for multiple-choice questions.
HasOther	Boolean	If the value is 'true', the question includes an 'Other' option that allows respondents to provide a custom answer; if 'false', only predefined options are available.
OtherLabel	String	The label displayed for the 'Other' option when respondents are allowed to enter a custom response.
IsRequired	Boolean	If the value is 'true', the question must be answered before the respondent can submit the survey; if 'false', it is optional.
ContactCountsUnknown	Integer	The total number of responses received from contacts whose familiarity with the brand or sender is unknown.
ContactCountsKnown	Integer	The number of responses submitted by existing or previously identified contacts in the Mailchimp database.
ContactCountsNew	Integer	The number of responses from new contacts who were not previously part of the audience.
TotalResponses	Integer	The total number of responses collected for this question, including all respondents and answer types.
AverageRating	Decimal	The average rating value for this question, applicable only for rating-type questions such as satisfaction or likelihood scores.
MergeFieldId	Integer	The unique identifier of the merge field linked to this question, allowing integration of responses into audience data.
MergeFieldLabel	String	The display label associated with the merge field that maps to this survey question.
MergeFieldType	String	The data type of the merge field linked to this question, such as 'text', 'number', or 'date'. The allowed values are text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip.
PlaceholderLabel	String	The placeholder text displayed within the question field before the respondent enters an answer, often used to guide responses.
RangeHighLabel	String	The label shown at the high end of a range question, such as 'Very satisfied' or 'Excellent'.
RangeLowLabel	String	The label shown at the low end of a range question, such as 'Very dissatisfied' or 'Poor'.
SubscribeCheckboxEnabled	Boolean	If the value is 'true', a subscription checkbox is displayed to allow respondents to opt in to future communications when completing the survey.
SubscribeCheckboxLabel	String	The text label displayed next to the subscription checkbox, typically explaining what the respondent is subscribing to.

ReportLocations

Displays the top geographic locations where campaign emails were opened.

Table Specific Information

SELECT is supported for ReportLocations.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

CampaignId supports the '=' operator.

SELECT * FROM ReportLocations where CampaignId = '45a'

Columns


Name	Type	Description
CampaignId [KEY]	String	The unique identifier of the campaign associated with this location report. Each record represents campaign performance metrics for a specific region or country.
Region [KEY]	String	A specific geographical area, such as a city, state, or province, where campaign engagement activity occurred.
Opens	Integer	The total number of unique email opens recorded for this campaign within the specified region. Each recipient is counted once per region.
CountryCode	String	The two-letter ISO 3166 country code representing the country where the campaign engagement occurred.
RegionName	String	The display name of the region associated with the record. If the region value is blank, 'Rest of Country' is used to represent all remaining areas within the country.
ProxyExcludedOpens	Integer	The number of unique opens for the campaign in this region after excluding opens triggered by email clients that mask user activity through proxy services.

ReportProductActivity

Provides campaign performance data linked to e-commerce product interactions.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

CampaignId supports the '=' operator.

For example:

SELECT * FROM ReportProductActivity;
SELECT * FROM ReportProductActivity where CampaignId='1121';

Columns


Name	Type	Description
CampaignId	String	The unique identifier of the campaign associated with this product activity report. It is used to link product performance metrics back to the originating email campaign.
CurrencyCode	String	The three-letter ISO 4217 code representing the currency in which product revenue and totals are reported.
ImageUrl	String	The URL of the product image used in the campaign or report. This helps visually identify the promoted item.
RecommendationPurchased	Integer	The number of times this product was purchased as a result of a campaign recommendation. It reflects the product's success within personalized recommendations.
RecommendationTotal	Integer	The total number of times this product was recommended across all campaign recipients.
Sku	String	The stock keeping unit (SKU) that uniquely identifies the product in the store or catalog system.
Title	String	The name or title of the product as it appears in the campaign or catalog.
TotalPurchased	Integer	The total number of units of this product purchased by recipients who interacted with the campaign.
TotalRevenue	Integer	The total revenue generated from purchases of this product that can be attributed to the campaign.

Reports

A list of reports containing campaigns marked as Sent.

Table Specific Information

SELECT is supported for Reports.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
Type supports the '=' operator.
SendTime supports the '=,<,>,<=,>=' operator.

SELECT * FROM Reports where Id = '45a'
SELECT * FROM Reports where Type = 'regular'
SELECT * FROM Reports WHERE SendTime = '2024-02-07 00:00:37.0'
SELECT * FROM Reports WHERE SendTime >= '2024-02-07 00:00:37.0'
SELECT * FROM Reports WHERE SendTime <= '2024-02-07 00:00:37.0'
SELECT * FROM Reports WHERE SendTime > '2024-02-07 00:00:37.0'
SELECT * FROM Reports WHERE SendTime < '2024-02-07 00:00:37.0'

Columns


Name	Type	Description
Id [KEY]	String	A string that uniquely identifies this campaign.
CampaignTitle	String	The title of the campaign.
Type	String	The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto).
EmailsSent	Integer	The total number of emails sent for this campaign.
AbuseReports	Integer	The number of abuse reports generated for this campaign.
Unsubscribed	Integer	The total number of unsubscribed members for this campaign.
SendTime	Datetime	The time and date a campaign was sent.
Bounces_HardBounces	Integer	The total number of hard bounced email addresses.
Bounces_SoftBounces	Integer	The total number of soft bounced email addresses.
Bounces_SyntaxErrors	Integer	The total number of addresses that were syntax-related bounces.
Forwards_ForwardsCount	Integer
Forwards_ForwardsOpens	Integer
Opens_OpensTotal	Integer	The total number of opens for a campaign.
Opens_UniqueOpens	Integer	The total number of unique subscribers who opened a campaign.
Opens_OpenRate	Double	The number of unique subscribers who opened divided by the total number of successful deliveries.
Opens_LastOpen	Datetime	The date and time of the last recorded open.
Clicks_ClicksTotal	Integer	The total number of clicks for the campaign.
Clicks_UniqueClicks	Integer	The total number of unique clicks for links across a campaign.
Clicks_UniqueSubscriberClicks	Integer	The total number of subscribers who clicked on a campaign.
Clicks_ClickRate	Double	The number of unique subscribers who clicked divided by the total number of successful deliveries.
Clicks_LastClick	Datetime	The date and time of the last recorded click for the campaign.
FacebookLikes_RecipientLikes	Integer
FacebookLikes_UniqueLikes	Integer
FacebookLikes_FacebookLikes	Integer
IndustryStats_Type	String
IndustryStats_OpenRate	Double
IndustryStats_ClickRate	Double
IndustryStats_BounceRate	Double
IndustryStats_UnopenRate	Double
IndustryStats_UnsubRate	Double
IndustryStats_AbuseRate	Double
ListStats_SubRate	Double	The average number of subscriptions per month for the list.
ListStats_UnsubRate	Double	The average number of unsubscriptions per month for the list.
ListStats_OpenRate	Double	The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list.
ListStats_ClickRate	Double	The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list.
AbSplit_A	String
AbSplit_B	String
Timewarp	String	An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp.
Timeseries	String	An hourly breakdown of the performance of the campaign over the first 24 hours.
ShareReport_ShareUrl	String	The URL for the VIP report.
ShareReport_SharePassword	String	If password protected, the password for the VIP report.
DeliveryStatus	String	Updates on campaigns in the process of sending.
ListId	String	The unique list id.
ListIsActive	Boolean	The status of the list used, namely if it's deleted or disabled.
ListName	String	The name of the list.
SubjectLine	String	The subject line for the campaign.
PreviewText	String	The preview text for the campaign.
RssLastSend	String	For RSS campaigns, the date and time of the last send in ISO 8601 format.
Ecommerce	String	E-Commerce stats for a campaign.
Opens_ProxyExcludedOpens	Integer	The total number of opens for a campaign, excluding opens from email clients that use proxies.
Opens_ProxyExcludedUniqueOpens	Integer	The total number of unique opens for a campaign, excluding opens from email clients that use proxies.
Opens_ProxyExcludedOpenRate	Double	The average unique open rate for a campaign, excluding opens from email clients that use proxies.
ListStats_ProxyExcludedOpenRate	Double	The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list, excluding opens from email clients that use proxies.

ReportSentTo

A list of subscribers who were sent a specific campaign.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

EmailId supports the '=' operator.
CampaignId supports the '=' operator.

SELECT * FROM ReportSentTo where EmailId = '45a' and CampaignId = '458'

Columns


Name	Type	Description
EmailId [KEY]	String	The list-specific ID for the given email address.
EmailAddress	String	Email address for a subscriber.
Status	String	The status of the member ('sent', 'hard' for hard bounce, or 'soft' for soft bounce).
OpenCount	Integer	The number of times a campaign was opened by this member.
LastOpen	String	The date and time of the last open for this member.
AbsplitGroup	String	For A/B Split Campaigns, the group the member was apart of ('a', 'b', or 'winner').
GmtOffset	Integer	For campaigns sent with timewarp, the time zone group the member is apart of.
CampaignId [KEY]	String	The id for the campaign.
ListId [KEY]	String	The id for the list.
ListIsActive	Boolean	The status of the list used, namely if it's deleted or disabled.
MergeFields	String	A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
VIP	Boolean	VIP status for subscriber.

ReportSubReports

Lists subreports generated for child or related campaigns.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

CampaignId supports the '=' operator.

For example:

SELECT * FROM ReportSubReports;
SELECT * FROM ReportSubReports where CampaignId='1121';

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the campaign report, used to link subreport data to the parent campaign.
CampaignId [KEY]	String	The identifier of the child campaign within the overall campaign report.
AbSplitAAbuseReports	Integer	The number of abuse reports submitted by recipients of variant A in an A/B test campaign.
AbSplitABounces	Integer	The number of bounced emails for variant A, including both hard and soft bounces.
AbSplitAForwards	Integer	The total number of times variant A was forwarded by recipients.
AbSplitAForwardsOpens	Integer	The number of opens generated from forwarded messages of variant A.
AbSplitALastOpen	String	The timestamp of the most recent open event recorded for variant A.
AbSplitAOpens	Integer	The total number of opens recorded for variant A, including multiple opens by the same recipient.
AbSplitARecipientClicks	Integer	The number of recipient clicks for variant A across all tracked links.
AbSplitAUniqueOpens	Integer	The total number of unique opens recorded for variant A.
AbSplitAUnsubs	Integer	The number of recipients who unsubscribed after receiving variant A.
AbSplitBAbuseReports	Integer	The number of abuse reports submitted by recipients of variant B in an A/B test campaign.
AbSplitBBounces	Integer	The number of bounced emails for variant B, including both hard and soft bounces.
AbSplitBForwards	Integer	The total number of times variant B was forwarded by recipients.
AbSplitBForwardsOpens	Integer	The number of opens generated from forwarded messages of variant B.
AbSplitBLastOpen	String	The timestamp of the most recent open event recorded for variant B.
AbSplitBOpens	Integer	The total number of opens recorded for variant B, including multiple opens by the same recipient.
AbSplitBRecipientClicks	Integer	The number of recipient clicks for variant B across all tracked links.
AbSplitBUniqueOpens	Integer	The total number of unique opens recorded for variant B.
AbSplitBUnsubs	Integer	The number of recipients who unsubscribed after receiving variant B.
CampaignTitle	String	The title of the child campaign as displayed in Mailchimp.
EmailsSent	Integer	The total number of email messages sent for this campaign.
AbuseReports	Integer	The total number of abuse reports filed by recipients of this campaign.
Unsubscribed	Integer	The number of recipients who unsubscribed after receiving the campaign.
BouncesHardBounces	Integer	The number of hard bounces for the campaign, indicating permanent delivery failures.
BouncesSoftBounces	Integer	The number of soft bounces for the campaign, typically due to temporary delivery issues.
BouncesSyntaxErrors	Integer	The number of bounces caused by syntax errors in recipient email addresses.
OpensOpensTotal	Integer	The total number of email opens for this campaign, counting multiple opens per recipient.
OpensUniqueOpens	Integer	The total number of unique recipients who opened the campaign at least once.
OpensOpenRate	Decimal	The open rate, calculated as the ratio of unique opens to successful deliveries.
OpensLastOpen	Datetime	The date and time when the most recent open event occurred.
OpensProxyExcludedOpens	Integer	The total number of opens excluding those generated by proxy servers, providing more accurate engagement data.
OpensProxyExcludedUniqueOpens	Integer	The total number of unique opens excluding those from proxy servers.
OpensProxyExcludedOpenRate	Decimal	The open rate after excluding opens from email clients that use proxies.
ClicksClicksTotal	Integer	The total number of link clicks recorded for the campaign, including multiple clicks per recipient.
ClicksUniqueClicks	Integer	The number of unique clicks by distinct recipients within the campaign.
ClicksUniqueSubscriberClicks	Integer	The number of unique subscribers who clicked at least one link in the campaign.
ClicksClickRate	Decimal	The click rate, calculated as the ratio of unique clicks to successful deliveries.
ClicksLastClick	Datetime	The date and time of the most recent click recorded in the campaign.
ForwardsForwardsCount	Integer	The number of times recipients forwarded the campaign to others.
ForwardsForwardsOpens	Integer	The total number of opens generated from forwarded campaign messages.
ListId	String	The unique identifier of the mailing list associated with this campaign.
ListName	String	The name of the mailing list to which this campaign was sent.
ListIsActive	Boolean	Indicates whether the associated list is active ('true') or has been deleted or disabled ('false').
ListStatsSubRate	Decimal	The average monthly subscription rate for this mailing list.
ListStatsUnsubRate	Decimal	The average monthly unsubscribe rate for this mailing list.
ListStatsOpenRate	Decimal	The average open rate for all campaigns sent to this list.
ListStatsClickRate	Decimal	The average click rate for all campaigns sent to this list.
ListStatsProxyExcludedOpenRate	Decimal	The average open rate excluding proxy-generated opens across campaigns for this list.
DeliveryStatusEnabled	Boolean	Indicates whether delivery status tracking is enabled for this campaign.
DeliveryStatusCanCancel	Boolean	Indicates whether this campaign's delivery process can be canceled after initiation.
DeliveryStatusEmailsSent	Integer	The number of emails successfully sent as part of this campaign's delivery status.
DeliveryStatusEmailsCanceled	Integer	The number of emails canceled or stopped before being sent.
DeliveryStatusStatus	String	The current delivery status of the campaign, such as 'sending', 'sent', or 'canceled'.
FacebookLikesFacebookLikes	Integer	The total number of Facebook likes the campaign received.
FacebookLikesRecipientLikes	Integer	The number of likes generated by campaign recipients on Facebook.
FacebookLikesUniqueLikes	Integer	The total number of unique Facebook users who liked the campaign.
EcommerceCurrencyCode	String	The three-letter ISO 4217 code representing the currency used for e-commerce tracking in this campaign.
EcommerceTotalOrders	Integer	The total number of e-commerce orders attributed to this campaign.
EcommerceTotalRevenue	Decimal	The total revenue generated from e-commerce orders linked to this campaign.
EcommerceTotalSpent	Decimal	The total amount spent by customers on e-commerce orders resulting from this campaign.
IndustryStatsType	String	The industry category associated with this campaign, used for performance comparison.
IndustryStatsOpenRate	Decimal	The average open rate across similar campaigns in the same industry.
IndustryStatsClickRate	Decimal	The average click rate across similar campaigns in the same industry.
IndustryStatsBounceRate	Decimal	The average bounce rate for campaigns in the same industry.
IndustryStatsAbuseRate	Decimal	The average abuse report rate for campaigns in the same industry.
IndustryStatsUnsubRate	Decimal	The average unsubscribe rate for campaigns in the same industry.
IndustryStatsUnopenRate	Decimal	The average percentage of emails not opened in campaigns within the same industry.
PreviewText	String	The preview text shown to recipients in their inbox before opening the email.
SendTime	Datetime	The date and time when this campaign was sent to recipients.
SubjectLine	String	The subject line used for this campaign's email.
Timeseries	String	A breakdown of campaign performance metrics over time, showing trends in opens, clicks, and other interactions.
Type	String	The campaign type, such as 'regular', 'automation', or 'rss', indicating how it was created and delivered.
RssLastSend	Datetime	For RSS campaigns, the date and time of the most recent RSS-triggered send.
ShareReportShareUrl	String	The public URL used to share the campaign report with others.
ShareReportSharePassword	String	The password required to access the shared campaign report, if password protection is enabled.
Timewarp	String	The Timewarp configuration details, used for scheduling campaign sends according to recipient time zones.

ReportUnsubscribes

Lists members who unsubscribed from a specific campaign, including timestamps and reasons.

Table Specific Information

SELECT is supported for ReportUnsubscribes.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

EmailId supports the '=' operator.
CampaignId supports the '=' operator.

SELECT * FROM ReportUnsubscribes where EmailId = '45a' and CampaignId = '458'

Columns


Name	Type	Description
EmailId [KEY]	String	The unique list-specific identifier for the subscriber's email address. It is used to link the unsubscribe event to the member within the mailing list.
EmailAddress	String	The email address of the subscriber who opted out of receiving further campaign messages.
Timestamp	Datetime	The exact date and time when the subscriber unsubscribed from the campaign.
Reason	String	If provided, the subscriber's stated reason for unsubscribing. This can help identify common causes of opt-outs and improve future campaigns.
CampaignId [KEY]	String	The unique identifier of the campaign associated with the unsubscribe event.
ListId [KEY]	String	The unique identifier of the mailing list from which the subscriber unsubscribed.
ListIsActive	Boolean	Indicates whether the associated mailing list is currently active ('true') or has been deleted or disabled ('false').
MergeFields	String	A set of dynamic data fields containing personalized subscriber information. Each key represents a merge tag used in the campaign, such as name or location.
VIP	Boolean	Indicates whether the subscriber was marked as a VIP member of the list prior to unsubscribing.

SurveyResponses

Displays individual responses submitted for surveys distributed through Mailchimp.

Table Specific Information

SELECT is supported for SurveyResponses.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.
SurveyId supports the '=' operator.
AnsweredQuestion supports the '=' operator.
ChoseAnswer supports the '=' operator.
RespondentFamiliarityIs supports the '=' operator.

SELECT * FROM SurveyResponses WHERE SurveyId = '4548' and Id = '5995'
SELECT * FROM SurveyResponses WHERE SurveyId = '4548' and AnsweredQuestion = '81215a'
SELECT * FROM SurveyResponses WHERE SurveyId = '4548' and ChoseAnswer = '81215a'
SELECT * FROM SurveyResponses WHERE SurveyId = '4548' and RespondentFamiliarityIs = 'new'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the survey response. It is used to track individual submissions.
SubmittedAt	Datetime	The exact date and time when the survey response was submitted by the participant.
ContactEmailId	String	The MD5 hash of the lowercase version of the contact's email address. It is used as a unique and consistent identifier within Mailchimp.
ContactId	String	The unique identifier assigned to the contact in Mailchimp's database.
ContactStatus	String	The contact's current status in the Mailchimp audience, such as 'subscribed', 'unsubscribed', or 'cleaned'.
ContactEmail	String	The contact's email address associated with the survey response.
ContactFullName	String	The full name of the contact who submitted the survey response.
ContactConsentsToOneToOneMessaging	Boolean	Indicates whether the contact has given consent for one-to-one direct messaging through Mailchimp.
ContactAvatarUrl	String	The URL for the contact's avatar or profile image, if available.
IsNewContact	Boolean	Indicates whether the contact was newly added to the Mailchimp audience as a result of this survey submission.
SurveyId [KEY]	String	The unique identifier of the survey to which this response belongs.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
AnsweredQuestion	Integer	The identifier of the question that was answered. It is used for filtering responses by specific questions.
ChoseAnswer	String	The identifier of the answer option chosen by the respondent. It is used for filtering and analysis of selected choices.
RespondentFamiliarityIs	String	A filter option used to categorize survey responses based on the respondent's familiarity. Possible values are 'new', 'known', or 'unknown'.

Surveys

Lists surveys available in the account, including titles, questions, and response counts.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Id supports the '=' operator.

SELECT * FROM Surveys WHERE Id = '1245'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the survey, used to reference it across Mailchimp data and API operations.
WebId	Integer	The internal identifier of the survey within the Mailchimp web application interface.
ListId	String	The unique identifier of the mailing list connected to this survey, indicating which audience the survey targets.
ListName	String	The name of the mailing list associated with this survey, providing context about the audience segment surveyed.
Title	String	The title of the survey as displayed to respondents, summarizing its purpose or topic.
Url	String	The public or shareable URL where respondents can access the survey online.
Status	String	The current publication status of the survey. Possible values include 'published' for live surveys and 'unpublished' for drafts or archived ones.
PublishedAt	Datetime	The date and time when the survey was published and made available to respondents.
CreatedAt	Datetime	The date and time when the survey was initially created within Mailchimp.
UpdatedAt	Datetime	The date and time when the survey's configuration or content was last modified.
TotalResponses	Integer	The total number of responses collected for this survey, providing an overall measure of engagement.

TransactionalMessageContent

Get Transactional Message Content.

Columns


Name	Type	Description
Id [KEY]	String	The message's unique id.
FromEMail	String	The email address of the sender.
FromName	String	The alias of the sender, if any.
ToEMail	String	The email address of the recipient.
ToName	String	The alias of the recipient, if any.
Subject	String	The message's subject line.
HtmlContent	String	The HTML part of the message, if any.
TextContent	String	The text part of the message, if any.
Tags	String	List of tags on this message.
Attachments	String	An array of any attachments that can be found in the message.
Ts	String	The Unix timestamp from when this message was sent.

TransactionalMessages

Get Transactional Messages sent. Simple Select will return the last two months messages.

Columns


Name	Type	Description
Id [KEY]	String
Email	String
Sender	String
Subject	String
State	String
Template	String
SubAccount	String
ElasticsearchIndex	String
Version	String
DocumentId	String
Diag	String
RejectReason	String
RejectLastEventAt	String
Tags	String
BgtoolsCode	String
SMTPEvents	String
TimeStamp	Datetime
Resends	String
Ts	String
BounceDescription	String
OpensDetail	String
ClicksDetail	String
Opens	Integer
Clicks	Integer

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DateFrom	Date
DateTo	Date

TransactionalScheduledEmails

Displays scheduled transactional emails awaiting delivery.

Table Specific Information

Only SELECT is supported for TransactionalScheduledEmails.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

To supports the '=' operator.

SELECT * FROM TransactionalScheduledEmails WHERE To = '[email protected]'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the scheduled transactional email message.
CreatedAt	Datetime	The Coordinated Universal Time (UTC) timestamp indicating when the message was created, formatted as YYYY-MM-DD HH:MM:SS.
SendAt	Datetime	The Coordinated Universal Time (UTC) timestamp specifying when the message is scheduled to be sent, formatted as YYYY-MM-DD HH:MM:SS.
FromEmail	String	The sender's email address from which the transactional message originates.
To	String	The recipient's email address to which the transactional message will be delivered.
Subject	String	The subject line of the scheduled transactional email message.

TransactionalSenders

Lists authorized senders configured in the Mailchimp Transactional account.

Table Specific Information

Only SELECT is supported for TransactionalSenders.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Address supports the '=' operator.

SELECT * FROM TransactionalSenders WHERE Address = '[email protected]'

Columns


Name	Type	Description
Address	String	The email address of the sender associated with the transactional messages.
CreatedAt	Datetime	The Coordinated Universal Time (UTC) timestamp indicating when this sender was first detected by Mandrill, formatted as YYYY-MM-DD HH:MM:SS.
Sent	Integer	The total number of transactional messages that have been sent by this sender.
HardBounces	Integer	The total number of messages from this sender that resulted in hard bounces, indicating permanent delivery failures.
SoftBounces	Integer	The total number of messages from this sender that resulted in soft bounces, indicating temporary delivery issues.
Rejects	Integer	The total number of messages from this sender that were rejected by the system or receiving servers.
Complaints	Integer	The total number of spam complaints received for messages sent by this sender.
Unsubs	Integer	The total number of unsubscribe requests triggered by messages from this sender.
Opens	Integer	The total number of times messages sent by this sender have been opened.
Clicks	Integer	The total number of times tracked URLs within messages from this sender have been clicked.
UniqueOpens	Integer	The number of unique recipients who have opened at least one email sent by this sender.
UniqueClicks	Integer	The number of unique recipients who have clicked on at least one tracked URL in emails sent by this sender.

TransactionalUserInfos

Provides account-level information about Mailchimp Transactional users, including usage and limits.

Table Specific Information

Only SELECT is supported for TransactionalUserInfos.

Select

There are filters supported server side for this view. This view will provide the details of current user.

SELECT * FROM TransactionalUserInfos

Columns


Name	Type	Description
UserName	String	The username associated with the Mandrill account, used for Simple Mail Transfer Protocol (SMTP) authentication.
CreatedAt	Datetime	The Coordinated Universal Time (UTC) timestamp indicating when the user's Mandrill account was created, formatted as YYYY-MM-DD HH:MM:SS.
PublicId	String	A permanent and unique identifier for the user's Mandrill account.
Reputation	Integer	The user's current reputation score on a scale from 0 to 100, reflecting deliverability and engagement performance.
HourlyQuota	Integer	The maximum number of emails Mandrill will deliver for this user within one hour.
Backlog	Integer	The number of emails currently queued for delivery because the user's hourly or monthly quotas have been exceeded.
StatsTodaySent	Integer	The total number of emails sent by the user so far today.
StatsTodayHardBounces	Integer	The number of emails sent today that resulted in hard bounces, indicating permanent delivery failures.
StatsTodaySoftBounces	Integer	The number of emails sent today that resulted in soft bounces, indicating temporary delivery issues.
StatsTodayRejects	Integer	The number of emails rejected for sending so far today.
StatsTodayComplaints	Integer	The number of spam complaints received for emails sent so far today.
StatsTodayUnsubs	Integer	The number of unsubscribe requests received for emails sent so far today.
StatsTodayOpens	Integer	The total number of times emails sent today have been opened.
StatsTodayClicks	Integer	The total number of times tracked URLs in emails sent today have been clicked.
StatsTodayUniqueOpens	Integer	The number of unique recipients who opened emails sent today.
StatsTodayUniqueClicks	Integer	The number of unique recipients who clicked links in emails sent today.
StatsLast7DaysSent	Integer	The total number of emails sent by the user in the last 7 days.
StatsLast7DaysHardBounces	Integer	The number of hard-bounced emails in the last 7 days.
StatsLast7DaysSoftBounces	Integer	The number of soft-bounced emails in the last 7 days.
StatsLast7DaysRejects	Integer	The number of rejected emails in the last 7 days.
StatsLast7DaysComplaints	Integer	The number of spam complaints received in the last 7 days.
StatsLast7DaysUnsubs	Integer	The number of unsubscribe requests received in the last 7 days.
StatsLast7DaysOpens	Integer	The number of times emails have been opened in the last 7 days.
StatsLast7DaysClicks	Integer	The number of times tracked URLs have been clicked in the last 7 days.
StatsLast7DaysUniqueOpens	Integer	The number of unique recipients who opened emails in the last 7 days.
StatsLast7DaysUniqueClicks	Integer	The number of unique recipients who clicked tracked URLs in the last 7 days.
StatsLast30DaysSent	Integer	The total number of emails sent by the user in the last 30 days.
StatsLast30DaysHardBounces	Integer	The number of hard-bounced emails in the last 30 days.
StatsLast30DaysSoftBounces	Integer	The number of soft-bounced emails in the last 30 days.
StatsLast30DaysRejects	Integer	The number of rejected emails in the last 30 days.
StatsLast30DaysComplaints	Integer	The number of spam complaints received in the last 30 days.
StatsLast30DaysUnsubs	Integer	The number of unsubscribe requests received in the last 30 days.
StatsLast30DaysOpens	Integer	The number of times emails have been opened in the last 30 days.
StatsLast30DaysClicks	Integer	The number of times tracked URLs have been clicked in the last 30 days.
StatsLast30DaysUniqueOpens	Integer	The number of unique recipients who opened emails in the last 30 days.
StatsLast30DaysUniqueClicks	Integer	The number of unique recipients who clicked tracked URLs in the last 30 days.
StatsLast60DaysSent	Integer	The total number of emails sent by the user in the last 60 days.
StatsLast60DaysHardBounces	Integer	The number of hard-bounced emails in the last 60 days.
StatsLast60DaysSoftBounces	Integer	The number of soft-bounced emails in the last 60 days.
StatsLast60DaysRejects	Integer	The number of rejected emails in the last 60 days.
StatsLast60DaysComplaints	Integer	The number of spam complaints received in the last 60 days.
StatsLast60DaysUnsubs	Integer	The number of unsubscribe requests received in the last 60 days.
StatsLast60DaysOpens	Integer	The number of times emails have been opened in the last 60 days.
StatsLast60DaysClicks	Integer	The number of times tracked URLs have been clicked in the last 60 days.
StatsLast60DaysUniqueOpens	Integer	The number of unique recipients who opened emails in the last 60 days.
StatsLast60DaysUniqueClicks	Integer	The number of unique recipients who clicked tracked URLs in the last 60 days.
StatsLast90DaysSent	Integer	The total number of emails sent by the user in the last 90 days.
StatsLast90DaysHardBounces	Integer	The number of hard-bounced emails in the last 90 days.
StatsLast90DaysSoftBounces	Integer	The number of soft-bounced emails in the last 90 days.
StatsLast90DaysRejects	Integer	The number of rejected emails in the last 90 days.
StatsLast90DaysComplaints	Integer	The number of spam complaints received in the last 90 days.
StatsLast90DaysUnsubs	Integer	The number of unsubscribe requests received in the last 90 days.
StatsLast90DaysOpens	Integer	The number of times emails have been opened in the last 90 days.
StatsLast90DaysClicks	Integer	The number of times tracked URLs have been clicked in the last 90 days.
StatsLast90DaysUniqueOpens	Integer	The number of unique recipients who opened emails in the last 90 days.
StatsLast90DaysUniqueClicks	Integer	The number of unique recipients who clicked tracked URLs in the last 90 days.
StatsLastAllTimeDaysSent	Integer	The total number of emails ever sent through the user's Mandrill account.
StatsLastAllTimeDaysHardBounces	Integer	The total number of hard-bounced emails recorded for the account since its creation.
StatsLastAllTimeDaysSoftBounces	Integer	The total number of soft-bounced emails recorded for the account since its creation.
StatsLastAllTimeDaysRejects	Integer	The total number of rejected emails for the account since its creation.
StatsLastAllTimeDaysComplaints	Integer	The total number of spam complaints received across all campaigns and periods.
StatsLastAllTimeDaysUnsubs	Integer	The total number of unsubscribe requests received across all campaigns and periods.
StatsLastAllTimeDaysOpens	Integer	The total number of times emails have been opened for the entire account history.
StatsLastAllTimeDaysClicks	Integer	The total number of times tracked URLs have been clicked for the entire account history.
StatsLastAllTimeDaysUniqueOpens	Integer	The total number of unique recipients who have opened emails across the entire account history.
StatsLastAllTimeDaysUniqueClicks	Integer	The total number of unique recipients who have clicked tracked URLs across the entire account history.

VerifiedDomains

Lists sending domains verified for use with Mailchimp campaigns and transactional emails.

Table Specific Information

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Domain supports the '=' operator.

For example:

SELECT * FROM VerifiedDomains;
SELECT * FROM VerifiedDomains where Domain='abc.com';

Columns


Name	Type	Description
Domain [KEY]	String	The fully qualified domain name (for example, example.com) that is connected to the account for sending or tracking email.
Authenticated	Boolean	Indicates whether the domain has been authenticated for outbound email sending, meaning the required DomainKeys Identified Mail (DKIM) and Sender Policy Framework (SPF) records are correctly configured.
IsFreeEmailProvider	Boolean	Indicates whether the domain belongs to a free email service provider such as Gmail, Yahoo, or Outlook. Domains from free providers typically cannot be authenticated for custom sending.
Status	String	Displays the current configuration status of the domain, such as pending verification, verified, or authentication failed. The allowed values are VERIFICATION_IN_PROGRESS, VERIFIED, EXPIRED, ERROR, AUTHENTICATION_IN_PROGRESS, AUTHENTICATION_ERROR, AUTHENTICATED.
VerificationEmail	String	Shows the email address used to verify ownership of the domain. This address typically receives the verification message containing the confirmation link or token.
VerificationSent	Datetime	Specifies the date and time when the verification email was sent to the domain owner or administrator, allowing tracking of the verification process.
Verified	Boolean	Indicates whether the domain verification process has been successfully completed and confirmed, enabling it to be used for authenticated email sending.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Mailchimp.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Mailchimp, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Mailchimp Stored Procedures


Name	Description
AddOrRemoveMemberTags	Adds or removes tags from one or more list members. If a tag does not exist and is marked as 'active', Mailchimp automatically creates it.
AddSubscriberToWorkflowEmail	Manually adds a subscriber to an automation workflow, bypassing trigger-based entry conditions.
CampaignCancel	Cancels a scheduled regular or plain-text campaign that has not yet been sent.
CampaignPause	Pauses an active Mailchimp RSS campaign, temporarily stopping further sends.
CampaignResume	Resumes a previously paused Mailchimp RSS campaign.
CampaignSchedule	Schedules a campaign for delivery using either Timewarp or batch scheduling options (not both).
CampaignSend	Immediately sends a Mailchimp campaign to its intended audience.
CampaignTest	Sends a test email version of a campaign to verify design and content before sending.
CampaignUnschedule	Unschedules a previously scheduled campaign, preventing it from being sent.
DeleteECommerceCarts	Deletes an e-commerce cart record from the connected store.
RemoveSubscriberFromWorkflow	Removes a subscriber from a classic automation workflow at any stage, regardless of sent emails. Once removed, the subscriber cannot be re-added to the same workflow.
TransactionalCancelScheduledEmail	Cancels a transactional email that is scheduled for future delivery.
TransactionalRescheduledEmail	Reschedules a transactional email to be sent at a different time.
TransactionalSendMessage	Send a new transactional message through the Transactional API.
TransactionalSendTemplate	Send a new transactional message through the Transactional API using a template.
UpdateECommerceCarts	Updates an existing e-commerce cart record. To modify individual line items, use the ECommerceCartLines table.
ViewTemplatesDefaultContent	Retrieves editable sections and default content for a specific email template.

AddOrRemoveMemberTags

Adds or removes tags from one or more list members. If a tag does not exist and is marked as 'active', Mailchimp automatically creates it.

Stored Procedure Specific Information

Tags can be provided either as a directly specified array or via a TEMP table.

Using TEMP table

Insert into TagsAggregate#TEMP(Name, Status) Values('TestName11', 'inactive');
Insert into TagsAggregate#TEMP(Name, Status) Values('TestName7', 'active');
exec AddOrRemoveMemberTags TagsAggregate = 'TagsAggregate#TEMP', listid = '123', MemberId = 'test';

Directly providing the array

exec AddOrRemoveMemberTags TagsAggregate = '[{"name": "TestName11","status": "inactive"},{"name": "TestName7","status": "active"}]', listid = '123', MemberId = 'test';

Input


Name	Type	Required	Description
ListId	String	True	The unique identifier of the audience list where the member is subscribed.
MemberId	String	True	The MD5 hash of the lowercase version of the member's email address, used to identify the subscriber within the list.
TagsAggregate	String	True	A comma-separated list of tags to be added or removed from the specified list member.
IsSyncing	String	False	If the value is 'true', automations triggered by tag changes will not run during the synchronization process. Use this to prevent automation triggers when updating tags in bulk.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the tag update operation completed successfully. If the value is 'false', the operation failed.

AddSubscriberToWorkflowEmail

Manually adds a subscriber to an automation workflow, bypassing trigger-based entry conditions.

Input


Name	Type	Required	Description
WorkflowId	String	True	The unique identifier of the automation workflow to which the subscriber is added.
EmailId	String	True	The identifier of the specific email within the automation workflow that the subscriber should receive.
EmailAddress	String	True	The email address of the subscriber to be added to the workflow, bypassing standard trigger conditions.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the subscriber was successfully added to the automation workflow. If the value is 'false', the operation failed.

CampaignCancel

Cancels a scheduled regular or plain-text campaign that has not yet been sent.

Input


Name	Type	Required	Description
CampaignID	String	True	The unique identifier of the Mailchimp campaign to be canceled before it is sent.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the campaign was successfully canceled. If the value is 'false', the cancellation failed.

CampaignPause

Pauses an active Mailchimp RSS campaign, temporarily stopping further sends.

Input


Name	Type	Required	Description
CampaignID	String	True	The unique identifier of the Mailchimp campaign to be paused. The operation applies only to active RSS or recurring campaigns.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the campaign was successfully paused. If the value is 'false', the operation failed.

CampaignResume

Resumes a previously paused Mailchimp RSS campaign.

Input


Name	Type	Required	Description
CampaignID	String	True	The unique identifier of the Mailchimp campaign to be resumed after being paused. The operation applies to paused RSS or recurring campaigns.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the campaign was successfully resumed. If the value is 'false', the operation failed.

CampaignSchedule

Schedules a campaign for delivery using either Timewarp or batch scheduling options (not both).

Input


Name	Type	Required	Description
CampaignID	String	True	The unique identifier of the Mailchimp campaign to be scheduled for delivery.
ScheduleTime	String	True	The local date and time when the campaign is scheduled to send. Campaigns can only be scheduled on the quarter-hour (:00, :15, :30, or :45).
Timewarp	String	False	If the value is 'true', the campaign uses Mailchimp's Timewarp feature to send emails based on recipients' local time zones. The default value is false.
BatchCount	String	False	Specifies the number of batches in which the campaign should be sent to manage delivery volume.
BatchDelay	String	False	The delay between each batch in minutes when using batch sending.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the campaign was successfully scheduled. If the value is 'false', the operation failed.

CampaignSend

Immediately sends a Mailchimp campaign to its intended audience.

Input


Name	Type	Required	Description
CampaignID	String	True	The unique identifier of the Mailchimp campaign to be sent to its target audience.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the campaign was successfully sent. If the value is 'false', the operation failed.

CampaignTest

Sends a test email version of a campaign to verify design and content before sending.

Input


Name	Type	Required	Description
CampaignID	String	True	The unique identifier of the Mailchimp campaign to send as a test.
TestEmails	String	True	A comma-separated list of recipient email addresses to which the test campaign will be sent.
SendType	String	True	Specifies the format of the test email to send. The allowed values are html, plaintext. The default value is html.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the test email was sent successfully. If the value is 'false', the operation failed.

CampaignUnschedule

Unschedules a previously scheduled campaign, preventing it from being sent.

Input


Name	Type	Required	Description
CampaignID	String	True	The unique identifier of the Mailchimp campaign that is scheduled to be unsent or removed from the send queue.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the campaign was successfully unscheduled. If the value is 'false', the operation failed.

DeleteECommerceCarts

Deletes an e-commerce cart record from the connected store.

Input


Name	Type	Required	Description
StoreId	String	True	The unique identifier of the store containing the e-commerce cart to be deleted. Each store represents a connected e-commerce integration within the Mailchimp account.
Id	String	True	The unique identifier of the specific shopping cart to delete from the selected store. This value corresponds to the cart record previously created or retrieved through the API.

Result Set Columns


Name	Type	Description
Success	String	If the value is 'true', the cart was successfully deleted from the store. If the value is 'false', the operation failed or the specified cart could not be found.

RemoveSubscriberFromWorkflow

Removes a subscriber from a classic automation workflow at any stage, regardless of sent emails. Once removed, the subscriber cannot be re-added to the same workflow.

Input


Name	Type	Required	Description
WorkflowId	String	True	The unique identifier of the automation workflow from which the subscriber should be removed.
EmailAddress	String	True	The email address of the subscriber to remove from the specified automation workflow.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether the operation to remove the subscriber from the workflow was successful.

TransactionalCancelScheduledEmail

Cancels a transactional email that is scheduled for future delivery.

Stored Procedure Specific Information

Id input is required. For example:

exec TransactionalCancelScheduledEmail Id = '515abc'

Input


Name	Type	Required	Description
Id	String	True	The unique identifier of the scheduled email to be canceled, as returned by any TransactionalSendMessage stored procedure or TransactionalScheduledEmails view.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether the cancelation operation was successful.
Id	String	The unique identifier of the message that was canceled.
CreatedAt	Datetime	The Coordinated Universal Time (UTC) timestamp indicating when the message was originally created.
SendAt	Datetime	The Coordinated Universal Time (UTC) timestamp showing when the message was scheduled to be sent.
FromEmail	String	The sender's email address associated with the scheduled message.
To	String	The recipient's email address for the scheduled message.
Subject	String	The subject line of the scheduled email message.

TransactionalRescheduledEmail

Reschedules a transactional email to be sent at a different time.

Stored Procedure Specific Information

Id and SendAt inputs are required. For example:

exec TransactionalRescheduledEmail Id = '515abc', SendAt = '2025-08-01T10:10:10.23'

Input


Name	Type	Required	Description
Id	String	True	The unique identifier of the scheduled email to be rescheduled, as returned by any messages/send call or messages/list-scheduled view.
SendAt	Datetime	True	The new Coordinated Universal Time (UTC) timestamp specifying when the message should be sent.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether the rescheduling operation was successful.
Id	String	The unique identifier of the rescheduled message.
CreatedAt	Datetime	The Coordinated Universal Time (UTC) timestamp indicating when the message was originally created.
SendAt	Datetime	The Coordinated Universal Time (UTC) timestamp showing when the message is now scheduled to be sent after rescheduling.
FromEmail	String	The sender's email address associated with the rescheduled message.
To	String	The recipient's email address for the rescheduled message.
Subject	String	The subject line of the rescheduled email message.

TransactionalSendMessage

Send a new transactional message through the Transactional API.

Stored Procedure Specific Information

This stored procedure requires a premium membership to Mailchimp.

The To input is required. For example:

exec TransactionalSendMessage To = '[{ \"email\" : \"[email protected]\" , \"name\" : \"ABC\", \"type\" : \"to\"}]';

Alternatively, you can provide ToEmails, CcEmails or BccEmails to create a message:

exec TransactionalSendMessage ToEmails='[email protected],[email protected],[email protected]', ToNames='XYZ,,ABC', CcEmails='[email protected],[email protected]'

Input


Name	Type	Required	Description
Html	String	False	The full HTML content to be sent.
Text	String	False	Optional full text content to be sent.
Subject	String	False	The message subject.
FromEmail	String	False	The sender email address.
FromName	String	False	Optional from name to be used.
To	String	False	An array of recipient information.
ToEmails	String	False	Comma separated list of emails for type 'to'.
ToNames	String	False	Comma separated list of names for type 'to'.
CcEmails	String	False	Comma separated list of emails for type 'cc'.
CcNames	String	False	Comma separated list of names for type 'cc'.
BccEmails	String	False	Comma separated list of emails for type 'bcc'.
BccNames	String	False	Comma separated list of names for type 'bcc'.
Headers	String	False	Optional extra headers to add to the message.
Important	Boolean	False	Whether or not this message is important, and should be delivered ahead of non-important messages.
TrackOpens	Boolean	False	Whether or not to turn on open tracking for the message.
TrackClicks	Boolean	False	Whether or not to turn on click tracking for the message.
AutoText	Boolean	False	Whether or not to automatically generate a text part for messages that are not given text.
AutoHtml	Boolean	False	Whether or not to automatically generate an HTML part for messages that are not given HTML.
InlineCss	Boolean	False	Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size.
UrlStripQs	Boolean	False	Whether or not to strip the query string from URLs when aggregating tracked URL data.
PreserveRecipients	Boolean	False	Whether or not to expose all recipients in to 'To' header for each email.
ViewContentLink	Boolean	False	Set to false to remove content logging for sensitive emails.
BccAddress	String	False	An optional address to receive an exact copy of each recipient's email.
TrackingDomain	String	False	A custom domain to use for tracking opens and clicks instead of mandrillapp.com.
SigningDomain	String	False	A custom domain to use for SPF/DKIM signing instead of mandrill.
ReturnPathDomain	String	False	A custom domain to use for the messages's return-path.
Merge	Boolean	False	Whether to evaluate merge tags in the message.
MergeLanguage	String	False	The merge tag language to use when evaluating merge tags, either mailchimp or handlebars. The allowed values are mailchimp, handlebars.
GlobalMergeVars	String	False	Global merge variables to use for all recipients.
MergeVars	String	False	Per-recipient merge variables, which override global merge variables with the same name.
Tags	String	False	An array of string to tag the message with.
Subaccount	String	False	The unique id of a subaccount for this message - must already exist or will fail with an error.
GoogleAnalyticsDomains	String	False	An array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
GoogleAnalyticsCampaign	String	False	Optional string indicating the value to set for the utm_campaign tracking parameter.
Metadata	String	False	Metadata an associative array of user metadata.
RecipientMetadata	String	False	Per-recipient metadata that will override the global values specified in the metadata parameter.
Attachments	String	False	An array of supported attachments to add to the message.
AttachmentLocations	String	False	Comma separated values of file location of attachments.
AttachmentName	String	False	Name of the attachment for which the content is sent in AttachmentContent.
Images	String	False	An array of embedded images to add to the message.
ImageLocations	String	False	Comma separated values of file location of images.
ImageName	String	False	Name of the image for which the content is sent in ImageContent.
Async	Boolean	False	Enable a background sending mode that is optimized for bulk sending.
IpPool	String	False	The name of the dedicated ip pool that should be used to send the message.
SendAt	Datetime	False	When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format.

Result Set Columns


Name	Type	Description
Success	String	Whether the operation was successful.
Id	String	the message's unique id.
Email	String	The email address of the recipient.
Status	String	The sending status of the recipient.
RejectReason	String	the reason for the rejection if the recipient status is 'rejected'.
QueuedReason	String	A string that uniquely identifies the campaign associated with a cart

TransactionalSendTemplate

Send a new transactional message through the Transactional API using a template.

Stored Procedure Specific Information

The TemplateName, TemplateContent, and To inputs are required. For example:

exec TransactionalSendTemplate TemplateContent = '[{\"name\" : \"aaaa\" , \"content\" : \"nakdkasdmk\"}]', TemplateName = 'abcd', To = '[{ \"email\" : \"[email protected]\" , \"name\" : \"XYZ\", \"type\" : \"to\"}]';

Alternatively, you can provide ToEmails, CcEmails, or BccEmails along with TemplateName and TemplateContent to create a template:

exec TransactionalSendTemplate TemplateContent = '[{\"name\" : \"aaaa\" , \"content\" : \"nakdkasdmk\"}]', TemplateName = 'abcd', ToEmails='[email protected],[email protected],[email protected]', ToNames='XYZ,,ABC', CcEmails='[email protected],[email protected]'

Input


Name	Type	Required	Description
TemplateName	String	True	The immutable slug of a template that exists in the user's account.
TemplateContent	String	True	An array of template content to send.
Html	String	False	The full HTML content to be sent.
Text	String	False	Optional full text content to be sent.
Subject	String	False	The message subject.
FromEmail	String	False	The sender email address.
FromName	String	False	Optional from name to be used.
To	String	False	An array of recipient information.
ToEmails	String	False	Comma separated list of emails for type 'to'.
ToNames	String	False	Comma separated list of names for type 'to'.
CcEmails	String	False	Comma separated list of emails for type 'cc'.
CcNames	String	False	Comma separated list of names for type 'cc'.
BccEmails	String	False	Comma separated list of emails for type 'bcc'.
BccNames	String	False	Comma separated list of names for type 'bcc'.
Headers	String	False	Optional extra headers to add to the message.
Important	Boolean	False	Whether or not this message is important, and should be delivered ahead of non-important messages.
TrackOpens	Boolean	False	Whether or not to turn on open tracking for the message.
TrackClicks	Boolean	False	Whether or not to turn on click tracking for the message.
AutoText	Boolean	False	Whether or not to automatically generate a text part for messages that are not given text.
AutoHtml	Boolean	False	Whether or not to automatically generate an HTML part for messages that are not given HTML.
InlineCss	Boolean	False	Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size.
UrlStripQs	Boolean	False	Whether or not to strip the query string from URLs when aggregating tracked URL data.
PreserveRecipients	Boolean	False	Whether or not to expose all recipients in to 'To' header for each email.
ViewContentLink	Boolean	False	Set to false to remove content logging for sensitive emails.
BccAddress	String	False	An optional address to receive an exact copy of each recipient's email.
TrackingDomain	String	False	A custom domain to use for tracking opens and clicks instead of mandrillapp.com.
SigningDomain	String	False	A custom domain to use for SPF/DKIM signing instead of mandrill.
ReturnPathDomain	String	False	A custom domain to use for the messages's return-path.
Merge	Boolean	False	Whether to evaluate merge tags in the message.
MergeLanguage	String	False	The merge tag language to use when evaluating merge tags, either mailchimp or handlebars. The allowed values are mailchimp, handlebars.
GlobalMergeVars	String	False	Global merge variables to use for all recipients.
MergeVars	String	False	Per-recipient merge variables, which override global merge variables with the same name.
Tags	String	False	An array of string to tag the message with.
Subaccount	String	False	The unique id of a subaccount for this message - must already exist or will fail with an error.
GoogleAnalyticsDomains	String	False	An array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
GoogleAnalyticsCampaign	String	False	Optional string indicating the value to set for the utm_campaign tracking parameter.
Metadata	String	False	Metadata an associative array of user metadata.
RecipientMetadata	String	False	Per-recipient metadata that will override the global values specified in the metadata parameter.
Attachments	String	False	An array of supported attachments to add to the message.
AttachmentLocations	String	False	Comma separated values of file location of attachments.
AttachmentName	String	False	Name of the attachment for which the content is sent in AttachmentContent.
Images	String	False	An array of embedded images to add to the message.
ImageLocations	String	False	Comma separated values of file location of images.
ImageName	String	False	Name of the image for which the content is sent in ImageContent.
Async	Boolean	False	Enable a background sending mode that is optimized for bulk sending.
IpPool	String	False	The name of the dedicated ip pool that should be used to send the message.
SendAt	Datetime	False	When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format.

Result Set Columns


Name	Type	Description
Success	String	Whether the operation was successful.
Id	String	the message's unique id.
Email	String	The email address of the recipient.
Status	String	The sending status of the recipient.
RejectReason	String	the reason for the rejection if the recipient status is 'rejected'.
QueuedReason	String	A string that uniquely identifies the campaign associated with a cart

UpdateECommerceCarts

Updates an existing e-commerce cart record. To modify individual line items, use the ECommerceCartLines table.

Input


Name	Type	Required	Description
StoreId	String	True	Specifies the unique identifier of the e-commerce store where the cart exists. This value links the cart to a specific storefront within the connected platform.
Id	String	True	Defines the unique identifier of the shopping cart to be updated. This value ensures that the update operation targets the correct cart record within the specified store.
Customer	String	False	Provides detailed information about the customer associated with the cart, such as contact or profile data. For existing customers, only the customer identifier should be included in the request body to prevent duplication.
CampaignId	String	False	Identifies the marketing campaign related to the cart. This allows businesses to attribute the cart activity or order to a specific promotional or email campaign.
CheckoutUrl	String	False	Contains the direct web address that customers can use to access and complete the checkout process for this cart. Useful for tracking abandoned cart recovery or direct checkout links.
CurrencyCode	String	False	Specifies the three-letter ISO 4217 currency code used for all financial amounts in the cart, ensuring consistent pricing and reporting across international transactions.
OrderTotal	Decimal	False	Indicates the total monetary value of the cart, excluding taxes and discounts. This value represents the sum of all items added by the customer before tax calculation.
TaxTotal	Decimal	False	Specifies the total amount of tax applied to the cart based on the store's tax rules and the customer's location.

Result Set Columns


Name	Type	Description
Success	String	Returns a value indicating whether the cart update request was successfully processed by the API.
Id	String	Returns the unique identifier of the updated cart, confirming which cart record was modified during the operation.
StoreId	String	Returns the unique identifier of the store associated with the updated cart, verifying the scope of the update.
Customer	String	Returns the details of the customer linked to the updated cart, such as the customer's identifier and other relevant information.
CampaignId	String	Returns the identifier of the marketing campaign tied to the updated cart, confirming that the campaign relationship has been maintained.
CheckoutUrl	String	Returns the current checkout URL for the updated cart, which can be used to review or finalize the purchase.
CurrencyCode	String	Returns the currency used for the cart's financial values, formatted as a three-letter ISO 4217 code.
OrderTotal	Decimal	Returns the recalculated total monetary value of the cart after the update operation, representing all line items before taxes.
TaxTotal	Decimal	Returns the total tax applied to the cart after the update, ensuring accurate accounting and financial reporting.

ViewTemplatesDefaultContent

Retrieves editable sections and default content for a specific email template.

Input


Name	Type	Required	Description
TemplateId	String	True	Specifies the unique identifier of the email template to retrieve. This value determines which template's default content will be returned.

Result Set Columns


Name	Type	Description
*	String	Returns all available fields related to the default content of the specified template, including text, HTML sections, and editable regions defined in the template structure.

Transactional Data Model

The Cloud models the Mailchimp Transactional API as relational Views.

Tables

The CData Cloud models the Mailchimp Transactional API in Tables so that it can be easily queried and updated.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Tables

The Cloud models the data in Mailchimp as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Mailchimp Tables


Name	Description
Allowlists	Get Allowlists.
Tags	Get Tags.
Templates	Get Templates.

Allowlists

Get Allowlists.

Table Specific Information

SELECT, INSERT and DELETE is supported for Allowlists.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Email supports the '=' operator.

SELECT * FROM Allowlists WHERE Email = '[email protected]'

Insert

Email is required for Insert operation.

INSERT INTO Allowlists(Email) VALUES ('[email protected]')

Delete

Email is required for Delete operation.

DELETE FROM Allowlists WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	Description
Email [KEY]	String	False	An email address to add to the allowlist.
CreatedAt	Datetime	True	A description of why the email was allowlisted.
Detail	String	True	When the email was added to the allowlist.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Comment	String	An optional description of why the email was added to the allowlist. Only used for INSERT.

Templates

Get Templates.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE operations are supported for Templates.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following columns and operator. The rest of the filter is executed client-side within the Cloud.

Name supports the '=' operator.
Label supports the '=' operator.

SELECT * FROM Templates WHERE Name = 'MyTemplate'
SELECT * FROM Templates WHERE Label = 'MyLabel'

Insert

Name is required for the INSERT operation.

INSERT INTO Templates (Name, Subject, FromEmail, FromName, Publish) VALUES ('MyTemplate', 'Hello Subject', '[email protected]', 'Sender Name', true)

Update

Name is required for the UPDATE operation as it acts as the key.

UPDATE Templates SET labels='[\"adw\", \"eww\"]' WHERE name='testname'

Delete

Name

is required for the DELETE operation.

DELETE FROM Templates WHERE Name = 'MyTemplate'

Columns


Name	Type	ReadOnly	Description
Name [KEY]	String	False	The name of the template.
Slug	String	True	The immutable unique code name of the template.
CreatedAt	Datetime	True	The UTC timestamp when the template was created, in YYYY-MM-DD HH:MM:SS format.
UpdatedAt	Datetime	True	The date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format.
Labels#	String	False	The list of labels applied to the template.
Code	String	False	The full HTML code of the template, with mc:edit attributes marking the editable elements - draft version.
Subject	String	False	The subject line of the template, if provided - draft version.
FromEmail	String	False	The default sender address for the template, if provided - draft version.
FromName	String	False	The default sender from name for the template, if provided - draft version.
Text	String	False	The default text part of messages sent with the template, if provided - draft version.
PublishName	String	True	The same as the template name - kept as a separate field for backwards compatibility.
PublishCode	String	True	The full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published.
PublishSubject	String	True	The subject line of the template, if provided.
PublishFromEmail	String	True	The default sender address for the template, if provided.
PublishFromName	String	True	The default sender from name for the template, if provided.
PublishText	String	True	The default text part of messages sent with the template, if provided.
PublishedAt	Datetime	True	The date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published.
IsBrokenTemplate	Boolean	True	Indicates if the template is malformed or corrupt.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Label	String	An optional label to filter the templates. Only used for SELECT.
Publish	Boolean	Set to false to add a draft template without publishing. Only used for INSERT and UPDATE.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Mailchimp Views


Name	Description
MessageContent	Get Message Content.
Messages	Get Messages sent. Simple Select will return the last two months messages.
ScheduledEmails	Get Scheduled Emails.
Senders	Get Senders.
UserInfos	Get user info.

MessageContent

Get Message Content.

Columns


Name	Type	Description
Id [KEY]	String	The message's unique id.
FromEMail	String	The email address of the sender.
FromName	String	The alias of the sender, if any.
ToEMail	String	The email address of the recipient.
ToName	String	The alias of the recipient, if any.
Subject	String	The message's subject line.
HtmlContent	String	The HTML part of the message, if any.
TextContent	String	The text part of the message, if any.
Tags#	String	List of tags on this message.
Attachments#	String	An array of any attachments that can be found in the message.
Ts	String	The Unix timestamp from when this message was sent.

Messages

Get Messages sent. Simple Select will return the last two months messages.

Columns


Name	Type	Description
Id [KEY]	String
Email	String
Sender	String
Subject	String
State	String
Template	String
SubAccount	String
ElasticsearchIndex	String
Version	String
DocumentId	String
Diag	String
RejectReason	String
RejectLastEventAt	String
Tags#	String
BgtoolsCode	String
SMTPEvents	String
TimeStamp	Datetime
Resends	String
Ts	String
BounceDescription	String
OpensDetail#	String
ClicksDetail#	String
Opens	Integer
Clicks	Integer

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DateFrom	Date
DateTo	Date

ScheduledEmails

Get Scheduled Emails.

Table Specific Information

Only SELECT is supported for ScheduleEmails.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

To supports the '=' operator.

SELECT * FROM ScheduleEmails WHERE To = '[email protected]'

Columns


Name	Type	Description
Id [KEY]	String	The scheduled message id.
CreatedAt	Datetime	The UTC timestamp when the message was created, in YYYY-MM-DD HH:MM:SS format.
SendAt	Datetime	The UTC timestamp when the message will be sent, in YYYY-MM-DD HH:MM:SS format.
FromEmail	String	The email's sender address.
To	String	The email's recipient.
Subject	String	The email's subject.

Senders

Get Senders.

Table Specific Information

Only SELECT is supported for Senders.

Select

The Cloud will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

Address supports the '=' operator.

SELECT * FROM Senders WHERE Address = '[email protected]'

Columns


Name	Type	Description
Address	String	The sender's email address.
CreatedAt	Datetime	The date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
Sent	Integer	The total number of messages sent by this sender.
HardBounces	Integer	The total number of hard bounces by messages by this sender.
SoftBounces	Integer	The total number of soft bounces by messages by this sender.
Rejects	Integer	The total number of rejected messages by this sender.
Complaints	Integer	The total number of spam complaints received for messages by this sender.
Unsubs	Integer	The total number of unsubscribe requests received for messages by this sender.
Opens	Integer	The total number of times messages by this sender have been opened.
Clicks	Integer	The total number of times tracked URLs in messages by this sender have been clicked.
UniqueOpens	Integer	The number of unique opens for emails sent for this sender.
UniqueClicks	Integer	The number of unique clicks for emails sent for this sender.

UserInfos

Get user info.

Table Specific Information

Only SELECT is supported for UserInfos.

Select

There are filters supported server side for this view. This view will provide the details of current user.

SELECT * FROM UserInfos

Columns


Name	Type	Description
UserName	String	The username of the user (used for SMTP authentication).
CreatedAt	Datetime	The date and time that the user's Mandrill account was created as a UTC string in YYYY-MM-DD HH:MM:SS format.
PublicId	String	A unique, permanent identifier for this user.
Reputation	Integer	The reputation of the user on a scale from 0 to 100.
HourlyQuota	Integer	The maximum number of emails Mandrill will deliver for this user each hour.
Backlog	Integer	The number of emails that are queued for delivery due to exceeding your monthly or hourly quotas.
StatsTodaySent	Integer	The number of emails sent so far today.
StatsTodayHardBounces	Integer	The number of emails that hard bounced so far today.
StatsTodaySoftBounces	Integer	The number of emails that soft bounced so far today.
StatsTodayRejects	Integer	The number of emails rejected for sending so far today.
StatsTodayComplaints	Integer	The number of spam complaints received so far today.
StatsTodayUnsubs	Integer	The number of unsubscribes received so far today.
StatsTodayOpens	Integer	The number of times emails have been opened so far today.
StatsTodayClicks	Integer	The number of URLs that have been clicked so far today.
StatsTodayUniqueOpens	Integer	The number of unique opens so far today.
StatsTodayUniqueClicks	Integer	The number of unique clicks so far today.
StatsLast7DaysSent	Integer	The number of emails sent in the last 7 days.
StatsLast7DaysHardBounces	Integer	The number of hard bounces in the last 7 days.
StatsLast7DaysSoftBounces	Integer	The number of soft bounces in the last 7 days.
StatsLast7DaysRejects	Integer	The number of rejected emails in the last 7 days.
StatsLast7DaysComplaints	Integer	The number of spam complaints in the last 7 days.
StatsLast7DaysUnsubs	Integer	The number of unsubscribes in the last 7 days.
StatsLast7DaysOpens	Integer	The number of opens in the last 7 days.
StatsLast7DaysClicks	Integer	The number of clicks in the last 7 days.
StatsLast7DaysUniqueOpens	Integer	The number of unique opens in the last 7 days.
StatsLast7DaysUniqueClicks	Integer	The number of unique clicks in the last 7 days.
StatsLast30DaysSent	Integer	The number of emails sent in the last 30 days.
StatsLast30DaysHardBounces	Integer	The number of hard bounces in the last 30 days.
StatsLast30DaysSoftBounces	Integer	The number of soft bounces in the last 30 days.
StatsLast30DaysRejects	Integer	The number of rejected emails in the last 30 days.
StatsLast30DaysComplaints	Integer	The number of spam complaints in the last 30 days.
StatsLast30DaysUnsubs	Integer	The number of unsubscribes in the last 30 days.
StatsLast30DaysOpens	Integer	The number of times emails have been opened in the last 30 days.
StatsLast30DaysClicks	Integer	The number of URLs that have been clicked in the last 30 days.
StatsLast30DaysUniqueOpens	Integer	The number of unique opens in the last 30 days.
StatsLast30DaysUniqueClicks	Integer	The number of unique clicks in the last 30 days.
StatsLast60DaysSent	Integer	The number of emails sent in the last 60 days.
StatsLast60DaysHardBounces	Integer	The number of hard bounces in the last 60 days.
StatsLast60DaysSoftBounces	Integer	The number of soft bounces in the last 60 days.
StatsLast60DaysRejects	Integer	The number of rejected emails in the last 60 days.
StatsLast60DaysComplaints	Integer	The number of spam complaints in the last 60 days.
StatsLast60DaysUnsubs	Integer	The number of unsubscribes in the last 60 days.
StatsLast60DaysOpens	Integer	The number of times emails have been opened in the last 60 days.
StatsLast60DaysClicks	Integer	The number of URLs that have been clicked in the last 60 days.
StatsLast60DaysUniqueOpens	Integer	The number of unique opens in the last 60 days.
StatsLast60DaysUniqueClicks	Integer	The number of unique clicks in the last 60 days.
StatsLast90DaysSent	Integer	The number of emails sent in the last 90 days.
StatsLast90DaysHardBounces	Integer	The number of hard bounces in the last 90 days.
StatsLast90DaysSoftBounces	Integer	The number of soft bounces in the last 90 days.
StatsLast90DaysRejects	Integer	The number of rejected emails in the last 90 days.
StatsLast90DaysComplaints	Integer	The number of spam complaints in the last 90 days.
StatsLast90DaysUnsubs	Integer	The number of unsubscribes in the last 90 days.
StatsLast90DaysOpens	Integer	The number of times emails have been opened in the last 90 days.
StatsLast90DaysClicks	Integer	The number of URLs that have been clicked in the last 90 days.
StatsLast90DaysUniqueOpens	Integer	The number of unique opens in the last 90 days.
StatsLast90DaysUniqueClicks	Integer	The number of unique clicks in the last 90 days.
StatsLastAllTimeDaysSent	Integer	The total number of emails sent through the account.
StatsLastAllTimeDaysHardBounces	Integer	The total number of hard bounces for the account.
StatsLastAllTimeDaysSoftBounces	Integer	The total number of soft bounces for the account.
StatsLastAllTimeDaysRejects	Integer	The total number of rejected emails for the account.
StatsLastAllTimeDaysComplaints	Integer	The total number of spam complaints for the account.
StatsLastAllTimeDaysUnsubs	Integer	The total number of unsubscribes for the account.
StatsLastAllTimeDaysOpens	Integer	The total number of times emails have been opened for the account.
StatsLastAllTimeDaysClicks	Integer	The total number of URLs that have been clicked for the account.
StatsLastAllTimeDaysUniqueOpens	Integer	The total number of unique opens for the account.
StatsLastAllTimeDaysUniqueClicks	Integer	The total number of unique clicks for the account.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Mailchimp.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Mailchimp, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Mailchimp Stored Procedures


Name	Description
CancelScheduledEmail	Cancels a scheduled email.
RescheduledEmail	Reschedules a scheduled email.
SendMessage	Send a new message through the Transactional API.
SendTemplate	Send a new transactional message through the Transactional API using a template.

CancelScheduledEmail

Cancels a scheduled email.

Stored Procedure Specific Information

Id input is required. For example:

exec CancelScheduledEmail Id = '515abc'

Input


Name	Type	Required	Description
Id	String	True	A scheduled email id, as returned by any of the SendMessage Stored Procedure or ScheduledEmails views.

Result Set Columns


Name	Type	Description
Success	String	Whether the operation was successful.
Id	String	the message's unique id.
CreatedAt	Datetime	the UTC timestamp when the message was created.
SendAt	Datetime	the UTC timestamp when the message will be sent.
FromEmail	String	The sending status of the recipient.
To	String	The email's sender address.
Subject	String	the email's subject

RescheduledEmail

Reschedules a scheduled email.

Stored Procedure Specific Information

Id and SendAt inputs are required. For example:

exec RescheduledEmail Id = '515abc', SendAt = '2025-08-01T10:10:10.23'

Input


Name	Type	Required	Description
Id	String	True	A scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled.
SendAt	Datetime	True	The new UTC timestamp when the message should sent.

Result Set Columns


Name	Type	Description
Success	String	Whether the operation was successful.
Id	String	the message's unique id.
CreatedAt	Datetime	the UTC timestamp when the message was created.
SendAt	Datetime	the UTC timestamp when the message will be sent.
FromEmail	String	The sending status of the recipient.
To	String	The email's sender address.
Subject	String	the email's subject

SendMessage

Send a new message through the Transactional API.

Stored Procedure Specific Information

This stored procedure requires a premium membership to Mailchimp.

The To input is required. For example:

exec SendMessage To = '[{ \"email\" : \"[email protected]\" , \"name\" : \"ABC\", \"type\" : \"to\"}]';

Alternatively, you can provide ToEmails, CcEmails or BccEmails to create a message:

exec SendMessage ToEmails='[email protected],[email protected],[email protected]', ToNames='XYZ,,ABC', CcEmails='[email protected],[email protected]'

Input


Name	Type	Required	Description
Html	String	False	The full HTML content to be sent.
Text	String	False	Optional full text content to be sent.
Subject	String	False	The message subject.
FromEmail	String	False	The sender email address.
FromName	String	False	Optional from name to be used.
To	String	False	An array of recipient information.
ToEmails	String	False	Comma separated list of emails for type 'to'.
ToNames	String	False	Comma separated list of names for type 'to'.
CcEmails	String	False	Comma separated list of emails for type 'cc'.
CcNames	String	False	Comma separated list of names for type 'cc'.
BccEmails	String	False	Comma separated list of emails for type 'bcc'.
BccNames	String	False	Comma separated list of names for type 'bcc'.
Headers	String	False	Optional extra headers to add to the message.
Important	Boolean	False	Whether or not this message is important, and should be delivered ahead of non-important messages.
TrackOpens	Boolean	False	Whether or not to turn on open tracking for the message.
TrackClicks	Boolean	False	Whether or not to turn on click tracking for the message.
AutoText	Boolean	False	Whether or not to automatically generate a text part for messages that are not given text.
AutoHtml	Boolean	False	Whether or not to automatically generate an HTML part for messages that are not given HTML.
InlineCss	Boolean	False	Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size.
UrlStripQs	Boolean	False	Whether or not to strip the query string from URLs when aggregating tracked URL data.
PreserveRecipients	Boolean	False	Whether or not to expose all recipients in to 'To' header for each email.
ViewContentLink	Boolean	False	Set to false to remove content logging for sensitive emails.
BccAddress	String	False	An optional address to receive an exact copy of each recipient's email.
TrackingDomain	String	False	A custom domain to use for tracking opens and clicks instead of mandrillapp.com.
SigningDomain	String	False	A custom domain to use for SPF/DKIM signing instead of mandrill.
ReturnPathDomain	String	False	A custom domain to use for the messages's return-path.
Merge	Boolean	False	Whether to evaluate merge tags in the message.
MergeLanguage	String	False	The merge tag language to use when evaluating merge tags, either mailchimp or handlebars. The allowed values are mailchimp, handlebars.
GlobalMergeVars	String	False	Global merge variables to use for all recipients.
MergeVars	String	False	Per-recipient merge variables, which override global merge variables with the same name.
Tags	String	False	An array of string to tag the message with.
Subaccount	String	False	The unique id of a subaccount for this message - must already exist or will fail with an error.
GoogleAnalyticsDomains	String	False	An array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
GoogleAnalyticsCampaign	String	False	Optional string indicating the value to set for the utm_campaign tracking parameter.
Metadata	String	False	Metadata an associative array of user metadata.
RecipientMetadata	String	False	Per-recipient metadata that will override the global values specified in the metadata parameter.
Attachments	String	False	An array of supported attachments to add to the message.
AttachmentLocations	String	False	Comma separated values of file location of attachments.
AttachmentName	String	False	Name of the attachment for which the content is sent in AttachmentContent.
Images	String	False	An array of embedded images to add to the message.
ImageLocations	String	False	Comma separated values of file location of images.
ImageName	String	False	Name of the image for which the content is sent in ImageContent.
Async	Boolean	False	Enable a background sending mode that is optimized for bulk sending.
IpPool	String	False	The name of the dedicated ip pool that should be used to send the message.
SendAt	Datetime	False	When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format.

Result Set Columns


Name	Type	Description
Success	String	Whether the operation was successful.
Id	String	the message's unique id.
Email	String	The email address of the recipient.
Status	String	The sending status of the recipient.
RejectReason	String	the reason for the rejection if the recipient status is 'rejected'.
QueuedReason	String	A string that uniquely identifies the campaign associated with a cart

SendTemplate

Send a new transactional message through the Transactional API using a template.

Stored Procedure Specific Information

The TemplateName, TemplateContent, and To inputs are required. For example:

exec SendTemplate TemplateContent = '[{\"name\" : \"aaaa\" , \"content\" : \"nakdkasdmk\"}]', TemplateName = 'abcd', To = '[{ \"email\" : \"[email protected]\" , \"name\" : \"XYZ\", \"type\" : \"to\"}]';

Alternatively, you can provide ToEmails, CcEmails, or BccEmails along with TemplateName and TemplateContent to create a template:

exec SendTemplate TemplateContent = '[{\"name\" : \"aaaa\" , \"content\" : \"nakdkasdmk\"}]', TemplateName = 'abcd', ToEmails='[email protected],[email protected],[email protected]', ToNames='XYZ,,ABC', CcEmails='[email protected],[email protected]'

Input


Name	Type	Required	Description
TemplateName	String	True	The immutable slug of a template that exists in the user's account.
TemplateContent	String	True	An array of template content to send.
Html	String	False	The full HTML content to be sent.
Text	String	False	Optional full text content to be sent.
Subject	String	False	The message subject.
FromEmail	String	False	The sender email address.
FromName	String	False	Optional from name to be used.
To	String	False	An array of recipient information.
ToEmails	String	False	Comma separated list of emails for type 'to'.
ToNames	String	False	Comma separated list of names for type 'to'.
CcEmails	String	False	Comma separated list of emails for type 'cc'.
CcNames	String	False	Comma separated list of names for type 'cc'.
BccEmails	String	False	Comma separated list of emails for type 'bcc'.
BccNames	String	False	Comma separated list of names for type 'bcc'.
Headers	String	False	Optional extra headers to add to the message.
Important	Boolean	False	Whether or not this message is important, and should be delivered ahead of non-important messages.
TrackOpens	Boolean	False	Whether or not to turn on open tracking for the message.
TrackClicks	Boolean	False	Whether or not to turn on click tracking for the message.
AutoText	Boolean	False	Whether or not to automatically generate a text part for messages that are not given text.
AutoHtml	Boolean	False	Whether or not to automatically generate an HTML part for messages that are not given HTML.
InlineCss	Boolean	False	Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size.
UrlStripQs	Boolean	False	Whether or not to strip the query string from URLs when aggregating tracked URL data.
PreserveRecipients	Boolean	False	Whether or not to expose all recipients in to 'To' header for each email.
ViewContentLink	Boolean	False	Set to false to remove content logging for sensitive emails.
BccAddress	String	False	An optional address to receive an exact copy of each recipient's email.
TrackingDomain	String	False	A custom domain to use for tracking opens and clicks instead of mandrillapp.com.
SigningDomain	String	False	A custom domain to use for SPF/DKIM signing instead of mandrill.
ReturnPathDomain	String	False	A custom domain to use for the messages's return-path.
Merge	Boolean	False	Whether to evaluate merge tags in the message.
MergeLanguage	String	False	The merge tag language to use when evaluating merge tags, either mailchimp or handlebars. The allowed values are mailchimp, handlebars.
GlobalMergeVars	String	False	Global merge variables to use for all recipients.
MergeVars	String	False	Per-recipient merge variables, which override global merge variables with the same name.
Tags	String	False	An array of string to tag the message with.
Subaccount	String	False	The unique id of a subaccount for this message - must already exist or will fail with an error.
GoogleAnalyticsDomains	String	False	An array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
GoogleAnalyticsCampaign	String	False	Optional string indicating the value to set for the utm_campaign tracking parameter.
Metadata	String	False	Metadata an associative array of user metadata.
RecipientMetadata	String	False	Per-recipient metadata that will override the global values specified in the metadata parameter.
Attachments	String	False	An array of supported attachments to add to the message.
AttachmentLocations	String	False	Comma separated values of file location of attachments.
AttachmentName	String	False	Name of the attachment for which the content is sent in AttachmentContent.
Images	String	False	An array of embedded images to add to the message.
ImageLocations	String	False	Comma separated values of file location of images.
ImageName	String	False	Name of the image for which the content is sent in ImageContent.
Async	Boolean	False	Enable a background sending mode that is optimized for bulk sending.
IpPool	String	False	The name of the dedicated ip pool that should be used to send the message.
SendAt	Datetime	False	When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format.

Result Set Columns


Name	Type	Description
Success	String	Whether the operation was successful.
Id	String	the message's unique id.
Email	String	The email address of the recipient.
Status	String	The sending status of the recipient.
RejectReason	String	the reason for the rejection if the recipient status is 'rejected'.
QueuedReason	String	A string that uniquely identifies the campaign associated with a cart

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Mailchimp:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Lists table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Lists'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Mailchimp procedure.

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Lists table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Lists'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
Schema	Specify the Mailchimp API to use.
AuthScheme	Whether to use APIKey Authentication or OAuth Authentication when connecting to MailChimp.
APIKey	The API key used for accessing your MailChimp account.
TransactionalAPIKey	Set this to retrieve results from Transactional API.

Connection

Property	Description
IncludeCustomFields	Set whether to include custom fields that are added to the ListMembers view. This defaults to true.

OAuth

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Mailchimp.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
Schema	Specify the Mailchimp API to use.
AuthScheme	Whether to use APIKey Authentication or OAuth Authentication when connecting to MailChimp.
APIKey	The API key used for accessing your MailChimp account.
TransactionalAPIKey	Set this to retrieve results from Transactional API.

Schema

Specify the Mailchimp API to use.

Possible Values

MailChimp, Transactional

Data Type

string

Default Value

"MailChimp"

Remarks

Select from the following to specify which API of Mailchimp to use:

MailChimp for MailChimp Marketing API.
Transactional for MailChimp Transactional API.

AuthScheme

Whether to use APIKey Authentication or OAuth Authentication when connecting to MailChimp.

Possible Values

APIKey

Data Type

string

Default Value

"APIKey"

Remarks

OAuth: Set this to perform OAuth authentication.
APIKey: Set this to perform APIKey authentication.

APIKey

The API key used for accessing your MailChimp account.

Data Type

string

Default Value

""

Remarks

The API key used for accessing your MailChimp account. The API key can be found in MailChimp by going to Account -> Extras -> API Keys.

TransactionalAPIKey

Set this to retrieve results from Transactional API.

Data Type

string

Default Value

""

Remarks

Set this to retrieve results from Transactional API.

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Property	Description
IncludeCustomFields	Set whether to include custom fields that are added to the ListMembers view. This defaults to true.

IncludeCustomFields

Set whether to include custom fields that are added to the ListMembers view. This defaults to true.

Data Type

bool

Default Value

true

Remarks

Set whether to include custom fields that are added to the ListMembers view. This defaults to true.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Mailchimp.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from Mailchimp.

Data Type

int

Default Value

1000

Remarks

When processing a query, instead of requesting all of the queried data at once from Mailchimp, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Cloud

Mailchimp - CData Cloud

Overview

Key Features

Getting Started

Connecting to Mailchimp

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to Mailchimp Marketing API

API Key

OAuth

Connecting to Mailchimp Transactional API

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Using MailChimp API

Using Transactional API

MailChimp Data Model

Tables

Dynamic tables

Views

Dynamic views

Stored Procedures

Tables

CData Cloud - Mailchimp Tables

CampaignFeedback

Table Specific Information

Select

Insert

Columns

CampaignFolders

Table Specific Information

Select

Columns

Campaigns

Table Specific Information

Select

Update

Columns

EcommerceCartLines

Table Specific Information

Select

Delete

Columns

EcommerceCarts

Table Specific Information

Select

Columns

EcommerceCustomers

Table Specific Information

Select

Columns

EcommerceOrderLines

Table Specific Information

Select

Delete

Columns

EcommerceOrders

Table Specific Information

Select

Columns

Pseudo-Columns

EcommerceProducts

Table Specific Information

Select

Columns

EcommerceProductVariants

Table Specific Information

Select

Delete

Columns

FileManagerFiles

Table Specific Information

Select

Insert

Columns