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.

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

Mailchimp supports the following authentication methods:

• APIKey
• OAuth

API Key

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

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

Once you have the value of the API Key:

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

OAuth

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.

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.

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

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.

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

A summary of the comment feedback for a specific campaign.

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.

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

Folders for organizing campaigns

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.

SELECT * FROM CampaignFolders WHERE Id = '1245'

Columns

A summary of the campaigns within an account.

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

A list of an ecommerce cart's lines.

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.

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

A list of an account's ecommerce carts.

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.

SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123'

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

Columns

A list of an account's ecommerce customers.

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.

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

A list of an ecommerce order's lines.

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.

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

A list of an account's ecommerce orders.

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.

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

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.

A list of an account's ecommerce products.

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.

SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123'

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

Columns

A list of an ecommerce product's variants.

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.

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

A listing of all avaialable images and files within an account's gallery.

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

A listing of all avaialable folders within an account's gallery.

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

A listing of this list's interest categories.

Table Specific Information

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

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.
• Type supports the '=' operator.

SELECT * FROM ListInterestCategories WHERE ListId = 'abc' and Type='dropdown'

Insert

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

INSERT INTO ListInterestCategories (Name, Type, ListID) VALUES ('myNewListInterestCategory', 'myType', 'myListID')

Columns

A list of this category's interests

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

Events information for a specific 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.
• MemberId supports the '=' operator.

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

Insert

Name column is required when INSERTing.

Columns

The last 10 notes for a specific list member, based on date created.

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

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.
• 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 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'

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

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.

The merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles.

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.

• MergeId supports the '=' operator.
• ListId supports the '=' operator.
• Type supports the '=' operator.
• Required supports the '=' operator.

SELECT * FROM ListMergeFields WHERE ListId = 'abc'
SELECT * FROM ListMergeFields WHERE Type = 'address'
SELECT * FROM ListMergeFields WHERE Required = true
SELECT * FROM ListMergeFields WHERE ListId = 'abc' and MergeId = '595'

Insert

The Name and ListID are required for INSERTs.

INSERT INTO ListMergeFields (Name, ListID) VALUES ('myNewListMergeField', 'myListID')

Columns

A collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization.

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

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

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

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.

A list of available segments.

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

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.

Webhooks configured for the given list.

Columns

Folders for organizing templates

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.

SELECT * FROM TemplateFolders WHERE Id = '1245'

Columns

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'
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

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.

Get Transactional Allowlists.

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

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.

Get Transactional Tags.

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

Get Transactional Templates.

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

DELETE FROM TransactionalTemplates WHERE Name = 'MyTemplate'

Columns

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.

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

Generate a new account export or download a finished account export.

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 AccountExports;
SELECT * FROM AccountExports where Id=3191;

Columns

A list of applications authorized to access the 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.

SELECT * FROM AuthorizedApps WHERE Id = '1245'

Columns

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.

SELECT * FROM AutomationEmailQueues WHERE Id = '1245'

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

Columns

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.

SELECT * FROM AutomationEmails WHERE WorkflowId = '1245'

Columns

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.

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

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.

SELECT * FROM AutomationsRemovedSubscribers WHERE WorkflowId = '1245'

Columns

Get a summary of batch requests that have been made.

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 BatchOperations;
SELECT * FROM BatchOperations where Id=2;

Columns

Get information about batch webhooks.

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 BatchWebhooks;
SELECT * FROM BatchWebhooks where Id='2';

Columns

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.

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

Columns

A list of members who opened the campaign email.

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

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.

Review the send checklist for a campaign, and resolve any issues before sending.

Columns

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.

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

Columns

Return the Chimp Chatter for this account ordered by most recent.

Table Specific Information

SELECT is supported for ChimpChatterActivity.

Select

 SELECT * FROM ChimpChatterActivity

Columns

Get all connected sites in 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.

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

Columns

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

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

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.

A Product Image represents a specific product image.

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.

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

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.

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

Get information about a store's promo rules

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.

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

Columns

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.

SELECT * FROM EcommerceStores WHERE  Id = '44'

Columns