CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるMailchimp へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してMailchimp に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Mailchimp への接続を標準化し、構成することができます。
このページでは、CData Cloud でのMailchimp への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのMailchimp への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してMailchimp からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Mailchimp に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
Mailchimp は、次の認証メソッドをサポートしています:
Mailchimp に接続する最も簡単な方法は、API キーを使用する方法です。APIKey はMailchimp アカウントへのフルアクセスを許可します。APIKey を取得するには:
API キーの値が取得できたら:
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
データモデルは3つのパートに分かれています。テーブル、ビュー、およびストアドプロシージャです。 Cloud は、Mailchimp API を使用してサポートされているフィルタを処理します。その他のフィルタは、Cloud 内でクライアント側で処理されます。。
CData Cloud は、Mailchimp API をテーブル にモデル化し、標準SQL でのクエリおよび更新を容易にします。
Cloud は接続時にListMembers テーブルのカスタムフィールドを動的に取得します。新しいカスタムフィールドの追加や、カスタムフィールドのデータ型の変更など、カスタムフィールドへのあらゆる変更は、再接続時に自動的に反映されます。
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:
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.
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
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.
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
Cloud はMailchimp のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| CampaignFeedback | A summary of the comment feedback for a specific campaign. |
| CampaignFolders | Folders for organizing campaigns |
| Campaigns | A summary of the campaigns within an account. |
| EcommerceCartLines | A list of an ecommerce cart's lines. |
| EcommerceCarts | A list of an account's ecommerce carts. |
| EcommerceCustomers | A list of an account's ecommerce customers. |
| EcommerceOrderLines | A list of an ecommerce order's lines. |
| EcommerceOrders | A list of an account's ecommerce orders. |
| EcommerceProducts | A list of an account's ecommerce products. |
| EcommerceProductVariants | A list of an ecommerce product's variants. |
| FileManagerFiles | A listing of all avaialable images and files within an account's gallery. |
| FileManagerFolders | A listing of all avaialable folders within an account's gallery. |
| ListInterestCategories | A listing of this list's interest categories. |
| ListInterests | A list of this category's interests |
| ListMemberEvents | Events information for a specific list. |
| ListMemberNotes | The last 10 notes for a specific list member, based on date created. |
| ListMembers | Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. |
| ListMergeFields | The merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles. |
| Lists | A collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization. |
| ListSegmentMembers | Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed. |
| ListSegments | A list of available segments. |
| ListsWebhooks | Webhooks configured for the given list. |
| TemplateFolders | Folders for organizing templates |
| Templates | A list an account's available templates. |
| TransactionalAllowlists | Get Transactional Allowlists. |
| TransactionalTags | Get Transactional Tags. |
| TransactionalTemplates | Get Transactional Templates. |
A summary of the comment feedback for a specific campaign.
SELECT, INSERT, UPDATE, and DELTE are supported for CampaignFeedback.
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.
SELECT * FROM CampaignFeedback WHERE FeedbackId = '1245' SELECT * FROM CampaignFeedback WHERE CampaignId = '1245'
The CampaignId and Message are required for INSERTs.
INSERT INTO CampaignFeedback (CampaignId, Message) VALUES ('myCampaignId', 'myMessage')
| Name | Type | ReadOnly | Description |
| FeedbackId [KEY] | Integer | True |
The individual id for the feedback item. |
| ParentId | Integer | True |
If a reply, the id of the parent feedback item. |
| BlockId | Integer | False |
The block id for the editable block that the feedback addresses. |
| Message | String | False |
The content of the feedback. |
| IsComplete | Boolean | False |
The status of feedback. |
| CreatedBy | String | True |
The login name of the user who created the feedback. |
| CreatedAt | Datetime | True |
The date and time the feedback item was created. |
| UpdatedAt | Datetime | True |
The date and time the feedback was last updated. |
| Source | String | True |
The source of the feedback ('email', 'sms', 'web', 'ios', 'android', or 'api'). |
| CampaignId [KEY] | String | False |
The unique id for the campaign. |
Folders for organizing campaigns
SELECT, INSERT, UPDATE, and DELTE are supported for CampaignFolders.
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.
SELECT * FROM CampaignFolders WHERE Id = '1245'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A string that uniquely identifieds this campaign folder |
| Name | String | False |
The name of the folder |
| Count | Integer | True |
The number of campaigns in the folder |
A summary of the campaigns within an account.
SELECT, UPDATE and DELETE are supported for Campaigns.
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.
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 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.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A string that uniquely identifies this campaign. |
| Type | String | False |
The type of campaign (regular, plaintext, absplit, or rss). |
| CreateTime | Datetime | True |
The date and time the campaign was created. |
| ArchiveUrl | String | True |
The link to the campaign's archive version. |
| LongArchiveUrl | String | True |
The original link to the campaign's archive version. |
| Status | String | True |
The current status of the campaign ('save', 'paused', 'schedule', 'sending', 'sent'). |
| EmailsSent | Integer | True |
The total number of emails sent for this campaign. |
| SendTime | Datetime | True |
The time and date a campaign was sent. |
| ContentType | String | False |
How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). |
| Recipients_ListId | String | False |
The id of the list. |
| Recipients_ListName | String | True |
The name of the list. |
| Recipients_SegmentText | String | False |
A string marked-up with HTML explaining the segment used for the campaign in plain English. |
| Recipients_RecipientCount | Integer | True |
Count of the recipients on the associated list. Formatted as an integer |
| Recipients_SegmentOpts | String | False |
Segment options. |
| Settings_SubjectLine | String | False |
The subject line for the campaign. |
| Settings_Title | String | False |
The title of the campaign. |
| Settings_FromName | String | False |
The 'from' name on the campaign (not an email address). |
| Settings_ReplyTo | String | False |
The reply-to email address for the campaign. |
| Settings_UseConversation | Boolean | False |
Use MailChimp Conversation feature to manage out of office replies. |
| Settings_ToName | String | False |
The campaign's custom 'to' name. Typically something like the first name merge var. |
| Settings_FolderId | String | False |
If the campaign is listed in a folder, the id for that folder. |
| Settings_Authenticate | Boolean | False |
Whether or not the campaign was authenticated by MailChimp. Defaults to 'true'. |
| Settings_AutoFooter | Boolean | False |
Automatically append MailChimp's default footer to the campaign. |
| Settings_InlineCss | Boolean | False |
Automatically inline the CSS included with the campaign content. |
| Settings_AutoTweet | Boolean | False |
Automatically tweet a link to the campaign archive page when the campaign is sent. |
| Settings_AutoFbPost | String | False |
An array of Facebook page ids to auto-post to. |
| Settings_FbComments | Boolean | False |
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to 'true'. |
| Settings_Timewarp | Boolean | True |
Send this campaign using 'timewarp.' For more info, see the Knowledge Base article: http://eepurl.com/iAgs |
| Settings_TemplateId | Integer | False |
The id for the template used in this campaign. |
| Settings_DragAndDrop | Boolean | True |
Whether the campaign uses the drag-and-drop editor. |
| VariateSettings_WinningCombinationId | String | True |
ID of the combination that was chosen as the winner |
| VariateSettings_WinningCampaignId | String | True |
ID of the campaign that was sent to the remaining recipients based on the winning combination |
| VariateSettings_WinnerCriteria | String | False |
How the winning campaign will be chosen |
| VariateSettings_WaitTime | Integer | False |
The number of minutes to wait before the winning campaign is picked |
| VariateSettings_TestSize | Integer | False |
The percentage of subscribers to send the test combinations to, from 10 to 100 |
| VariateSettings_SubjectLines | String | False |
Possible subject lines |
| VariateSettings_SendTimes | String | False |
Possible send times |
| VariateSettings_FromNames | String | False |
Possible from names |
| VariateSettings_ReplyToAddresses | String | False |
Possible reply To addresses |
| VariateSettings_Contents | String | True |
Descriptions of possible email contents |
| VariateSettings_Combinations | String | True |
Combinations of possible variables that were used to build emails |
| Tracking_Opens | Boolean | False |
Whether to track opens. Defaults to 'true'. |
| Tracking_HtmlClicks | Boolean | False |
Whether to track clicks in the HTML version of the campaign. Defaults to 'true'. |
| Tracking_TextClicks | Boolean | False |
Whether to track clicks in the plain-text version of the campaign. Defaults to 'true'. |
| Tracking_GoalTracking | Boolean | False |
Whether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH |
| Tracking_Ecomm360 | Boolean | False |
Whether to enable eCommerce360 tracking. |
| Tracking_GoogleAnalytics | String | False |
The custom slug for Google Analytics tracking (max of 50 bytes). |
| Tracking_Clicktale | String | False |
The custom slug for ClickTale Analytics tracking (max of 50 bytes). |
| Tracking_Salesforce | String | False |
Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration. |
| Tracking_Capsule | String | False |
Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration. |
| RssOpts_FeedUrl | String | False |
The URL for the RSS feed. |
| RssOpts_Frequency | String | False |
The frequency of the RSS-to-Email campaign ('daily', 'weekly', 'monthly'). |
| RssOpts_Schedule | String | False |
The schedule for sending the RSS campaign. |
| RssOpts_LastSent | String | True |
The date the campaign was last sent. |
| RssOpts_ConstrainRssImg | Boolean | False |
If true we will add css to images in the rss feed to constrain their width in the campaign content. |
| AbSplitOpts_SplitTest | String | False |
The type of AB split to run ('subject', 'from_name', or 'schedule'). |
| AbSplitOpts_PickWinner | String | False |
How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. |
| AbSplitOpts_WaitUnits | String | False |
How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. |
| AbSplitOpts_WaitTime | Integer | False |
The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. |
| AbSplitOpts_SplitSize | Integer | False |
The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. Ex. A 10% split would result in two groups of 10% of the subscribers plus a winner sending to the remaining 80%. |
| AbSplitOpts_FromNameA | String | False |
For campaigns split on 'From Name', the name for Group A. |
| AbSplitOpts_FromNameB | String | False |
For campaigns split on 'From Name', the name for Group B. |
| AbSplitOpts_ReplyEmailA | String | False |
For campaigns split on 'From Name', the reply-to address for Group A. |
| AbSplitOpts_ReplyEmailB | String | False |
For campaigns split on 'From Name', the reply-to address for Group B. |
| AbSplitOpts_SubjectA | String | False |
For campaings split on 'Subject Line', the subject line for Group A. |
| AbSplitOpts_SubjectB | String | False |
For campaings split on 'Subject Line', the subject line for Group B. |
| AbSplitOpts_SendTimeA | Datetime | False |
The send time for Group A. |
| AbSplitOpts_SendTimeB | Datetime | False |
The send time for Group B. |
| AbSplitOpts_SendTimeWinner | Datetime | False |
The send time for the winning version. |
| SocialCard_ImageUrl | String | False |
The url for the header image for the card. |
| SocialCard_Description | String | False |
A short summary of the campaign to display. |
| SocialCard_Title | String | False |
The title for the card. Typically the subject line of the campaign. |
| ReportSummary | String | False |
For sent campaigns, a summary of opens, clicks, and unsubscribes. |
| DeliveryStatus | String | False |
Updates on campaigns in the process of sending. |
| WebId | Integer | True |
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}. |
| ParentCampaignId | String | True |
If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. |
| NeedsBlockRefresh | Boolean | True |
Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. |
| Resendable | Boolean | True |
Determines if the campaign qualifies to be resent to non-openers. |
| Recipients_ListIsActive | Boolean | True |
The status of the list used, namely if it's deleted or disabled. |
| Settings_PreviewText | String | False |
The preview text for the campaign. |
| ItemURL | String | False |
The item url of campaigns. |
A list of an ecommerce cart's lines.
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.
SELECT * FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' SELECT * FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' and Id = '88'
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'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| CartId [KEY] | String | False |
The CartId for the table. |
| Id [KEY] | String | False |
A unique identifier for the cart line item. |
| ProductId | String | False |
A unique identifier for the product associated with the cart line item. |
| ProductTitle | String | True |
The name of the product for the cart line item. |
| ProductVariantId | String | False |
A unique identifier for the product variant associated with the cart line item. |
| ProductVariantTitle | String | True |
The name of the product variant for the cart line item. |
| Quantity | Integer | False |
The quantity of a cart line item. |
| Price | Decimal | False |
The price of a cart line item. |
A list of an account's ecommerce carts.
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.
SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123' SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123' and Id = '44'
| Name | Type | ReadOnly | Description |
| StoreId | String | False |
The StoreId for the table. |
| Id | String | False |
A unique identifier for the cart. |
| Customer | String | False |
Information about a specific customer. Carts for existing customers should include only the id parameter in the customer object body. |
| CampaignId | String | False |
A string that uniquely identifies the campaign associated with a cart. |
| CheckoutUrl | String | False |
The URL for the cart. |
| CurrencyCode | String | False |
The three-letter ISO 4217 code for the currency that the cart uses. |
| OrderTotal | Decimal | False |
The order total for the cart. |
| TaxTotal | Decimal | False |
The total tax for the cart. |
| Lines | String | False |
An array of the cart's line items. The column will not work for Update. Lines can be updated using EcommerceCartLines table. |
| CreatedAt | Datetime | True |
The date and time when the cart was created. |
| UpdatedAt | Datetime | True |
The date and time when the cart was last updated. |
A list of an account's ecommerce customers.
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.
SELECT * FROM EcommerceCustomers WHERE StoreId = 'Test_Store123' SELECT * FROM EcommerceCustomers WHERE EmailAddress = '[email protected]' SELECT * FROM EcommerceCustomers WHERE StoreId = 'Test_Store123' and Id = '44'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| Id [KEY] | String | False |
A unique identifier for the customer. |
| EmailAddress | String | False |
The customer's email address. |
| OptInStatus | Boolean | False |
The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing MailChimp list member, but will apply to list members that are added through the e-commerce API endpoints. |
| Company | String | False |
The customer's company. |
| FirstName | String | False |
The customer's first name. |
| LastName | String | False |
The customer's last name. |
| OrdersCount | Integer | True |
The customer's total order count. |
| TotalSpent | Decimal | True |
The total amount the customer has spent. |
| Address_Address1 | String | False |
The mailing address of the customer. |
| Address_Address2 | String | False |
An additional field for the customer's mailing address. |
| Address_City | String | False |
The city the customer is located in. |
| Address_Province | String | False |
The customer's state name or normalized province. |
| Address_ProvinceCode | String | False |
The two-letter code for the customer's province or state. |
| Address_PostalCode | String | False |
The customer's postal or zip code. |
| Address_Country | String | False |
The customer's country. |
| Address_CountryCode | String | False |
The two-letter code for the customer's country. |
| CreatedAt | Datetime | True |
The date and time the customer was created. |
| UpdatedAt | Datetime | True |
The date and time the customer was last updated. |
A list of an ecommerce order's lines.
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.
SELECT * FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' SELECT * FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' and Id = '88'
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'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| OrderId [KEY] | String | False |
The OrderId for the table. |
| Id [KEY] | String | False |
A unique identifier for the order line item. |
| ProductId | String | False |
A unique identifier for the product associated with the order line item. |
| ProductTitle | String | True |
The name of the product for the order line item. |
| ProductVariantId | String | False |
A unique identifier for the product variant associated with the order line item. |
| ProductVariantTitle | String | True |
The name of the product variant for the order line item. |
| Quantity | Integer | False |
The quantity of an order line item. |
| Price | Decimal | False |
The price of an ecommerce order line item. |
| Discount | Decimal | False |
The total discount amount applied to a line item. |
| ImageUrl | String | True |
The image URL for a product. |
A list of an account's ecommerce orders.
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.
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
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| Id [KEY] | String | False |
A unique identifier for the order. |
| Customer | String | False |
Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body. |
| CampaignId | String | False |
A string that uniquely identifies the campaign associated with an order. |
| FinancialStatus | String | False |
The order status. For example: `refunded`, `processing`, `cancelled`, etc. |
| FulfillmentStatus | String | False |
The fulfillment status for the order. For example: `partial`, `fulfilled`, etc. |
| CurrencyCode | String | False |
The three-letter ISO 4217 code for the currency that the store accepts. |
| OrderTotal | Decimal | False |
The order total for the order. |
| TaxTotal | Decimal | False |
The tax total for the order. |
| ShippingTotal | Decimal | False |
The shipping total for the order. |
| TrackingCode | String | False |
The MailChimp tracking code for the order. Uses the 'mc_tc' parameter in eCommerce360-enabled tracking urls. |
| ProcessedAtForeign | Datetime | False |
The date and time the order was processed. |
| CancelledAtForeign | Datetime | False |
The date and time the order was cancelled. |
| UpdatedAtForeign | Datetime | False |
The date and time the order was updated. |
| ShippingAddress_Name | String | False |
The name associated with an order's shipping address. |
| ShippingAddress_Address1 | String | False |
The shipping address for the order. |
| ShippingAddress_Address2 | String | False |
An additional field for the shipping address. |
| ShippingAddress_City | String | False |
The city in the order's shipping address. |
| ShippingAddress_Province | String | False |
The state or normalized province in the order's shipping address. |
| ShippingAddress_ProvinceCode | String | False |
The two-letter code for the province or state the order's shipping address is located in. |
| ShippingAddress_PostalCode | String | False |
The postal or zip code in the order's shipping address. |
| ShippingAddress_Country | String | False |
The country in the order's shipping address. |
| ShippingAddress_CountryCode | String | False |
The two-letter code for the country in the shipping address. |
| ShippingAddress_Longitude | Double | False |
The longitude for the shipping address location. |
| ShippingAddress_Latitude | Double | False |
The latitude for the shipping address location. |
| ShippingAddress_Phone | String | False |
The phone number for the order's shipping address |
| ShippingAddress_Company | String | False |
The company associated with an order's shipping address. |
| BillingAddress_Name | String | False |
The name associated with an order's billing address. |
| BillingAddress_Address1 | String | False |
The billing address for the order. |
| BillingAddress_Address2 | String | False |
An additional field for the billing address. |
| BillingAddress_City | String | False |
The city in the billing address. |
| BillingAddress_Province | String | False |
The state or normalized province in the billing address. |
| BillingAddress_ProvinceCode | String | False |
The two-letter code for the province or state in the billing address. |
| BillingAddress_PostalCode | String | False |
The postal or zip code in the billing address. |
| BillingAddress_Country | String | False |
The country in the billing address. |
| BillingAddress_CountryCode | String | False |
The two-letter code for the country in the billing address. |
| BillingAddress_Longitude | Double | False |
The longitude for the billing address location. |
| BillingAddress_Latitude | Double | False |
The latitude for the billing address location. |
| BillingAddress_Phone | String | False |
The phone number for the billing address. |
| BillingAddress_Company | String | False |
The company associated with the billing address. |
| Lines | String | False |
An array of the order's line items. The column will not work for Update. Lines can be updated using EcommerceOrderLines table. |
| Outreach_Id | String | False |
A unique identifier for the outreach. Can be an email campaign ID. |
| Outreach_Name | String | False |
The name for the outreach. |
| Outreach_Type | String | False |
The type of the outreach. |
| Outreach_PublishedTime | String | False |
The date and time the Outreach was published in ISO 8601 format. |
| TrackingNumber | String | False |
The tracking number associated with the order. |
| TrackingCarrier | String | False |
The tracking carrier associated with the order. |
| TrackingUrl | String | False |
The tracking url associated with the order. |
| LandingSite | String | False |
The URL for the page where the buyer landed when entering the shop. |
| Promos | String | False |
The promo codes applied on the order.The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided. |
| OrderUrl | String | False |
The URL for the order. |
| DiscountTotal | Decimal | False |
The total amount of the discounts to be applied to the price of the order. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String |
Filter on customer_id, only valid for SELECT. |
| HasOutreach | Boolean |
Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad, only valid for SELECT. |
A list of an account's ecommerce products.
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.
SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123' SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123' and Id = '44'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| Id [KEY] | String | False |
A unique identifier for the product. |
| Title | String | False |
The title of a product. |
| Handle | String | False |
The handle of a product. |
| Url | String | False |
The URL of a product. |
| Description | String | False |
The description of a product. |
| Type | String | False |
The type of product. |
| Vendor | String | False |
The vendor for a product. |
| ImageUrl | String | False |
The image URL for a product. |
| Variants | String | False |
An array of the product's variants. |
| PublishedAtForeign | Datetime | False |
The date and time when the product was published. |
| CurrencyCode | String | True |
The currency code |
| Images | String | False |
An array of the product's images. |
A list of an ecommerce product's variants.
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.
SELECT * FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' SELECT * FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' and Id = '88'
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'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| ProductId [KEY] | String | False |
The ProductId for the table. |
| Id [KEY] | String | False |
A unique identifier for the product variant. |
| Title | String | False |
The title of a product variant. |
| Url | String | False |
The URL of a product variant. |
| Sku | String | False |
The stock keeping unit (SKU) of a product variant. |
| Price | Decimal | False |
The price of a product variant. |
| InventoryQuantity | Integer | False |
The inventory quantity of a product variant. |
| ImageUrl | String | False |
The image URL for a product variant. |
| Backorders | String | False |
The backorders of a product variant. |
| Visibility | String | False |
The visibility of a product variant. |
| CreatedAt | Datetime | True |
The date and time when the product was created. |
| UpdatedAt | Datetime | True |
The date and time the product was last updated. |
A listing of all avaialable images and files within an account's gallery.
SELECT, INSERT, UPDATE, and DELETE are supported for FileManagerFiles.
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.
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'
The Name, FolderId, and FileData are required for INSERTs.
INSERT INTO FileManagerFiles (Name, FolderID, FileData) VALUES ('myNewFolder', 'myFolderID', 'myBase64EncodedFileData')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique id given to the file. |
| FolderId | Integer | False |
The id of the folder. |
| Type | String | True |
The type of file in the gallery: Image or file. |
| Name | String | False |
The name of the file. |
| FullSizeUrl | String | True |
The url of the full-size file. |
| ThumbnailUrl | String | True |
The url of the thumbnail preview. |
| Size | Integer | True |
The size of the file in bytes. |
| CreatedAt | Datetime | True |
The date and time a file was added to the gallery. |
| CreatedBy | String | True |
The username of the profile that uploaded the file. |
| Width | Integer | True |
The width of the image. |
| Height | Integer | True |
The height of an image. |
| FileData | String | False |
When adding a new file, the base64-encoded file. Required for INSERT statement. |
A listing of all avaialable folders within an account's gallery.
SELECT, INSERT, UPDATE, and DELETE are supported for FileManagerFolders.
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.
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'
The Name is required for INSERTs.
INSERT INTO FileManagerFolders (Name) VALUES ('myNewFolder'')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique id given to the folder. |
| Name | String | False |
The name of the folder. |
| FileCount | Integer | True |
The number of files within the folder. |
| CreatedAt | Datetime | True |
The date and time a file was added to the gallery. |
| CreatedBy | String | True |
The username of the profile that created the folder. |
A listing of this list's interest categories.
SELECT, INSERT, UPDATE, and DELETE are supported for ListInterestCategories.
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.
SELECT * FROM ListInterestCategories WHERE ListId = 'abc' and Type='dropdown'
The Title, Type, and ListId are required for INSERTs.
INSERT INTO ListInterestCategories (Name, Type, ListID) VALUES ('myNewListInterestCategory', 'myType', 'myListID')
| Name | Type | ReadOnly | Description |
| ListId [KEY] | String | False |
The ID for the list that this category belongs to. |
| Id [KEY] | String | True | |
| Title | String | False |
The text description of this category. This field is displayed on signup forms and is often phrased as a question. |
| DisplayOrder | Integer | False |
Order in which the categories display in the list. Lower numbers display first. |
| Type | String | False |
Determines how this category's interests are displayed on signup forms. |
A list of this category's interests
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.
SELECT * FROM ListInterests WHERE ListId = 'abc' and Id='221' SELECT * FROM ListInterests WHERE ListId = 'abc' and CategoryId='456'
The Title, CategoryId, and ListId are required for INSERTs.
INSERT INTO ListInterests (Name, CategoryId, ListID) VALUES ('myNewListInterest', 'myCategory', 'myListID')
| Name | Type | ReadOnly | Description |
| CategoryId [KEY] | String | False |
The id for the interest category. |
| ListId [KEY] | String | False |
The ID for the list that this interest belongs to. |
| Id [KEY] | String | True |
The ID for the interest. |
| Name | String | False |
The name of the interest. This can be shown publicly on a subscription form. |
| SubscriberCount | String | True |
The number of subscribers associated with this interest. |
| DisplayOrder | Integer | False |
Order in which the interests display. |
Events information for a specific list.
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.
SELECT * FROM ListMemberEvents WHERE ListId = '121' and MemberId = '11'
Name column is required when INSERTing.
| Name | Type | ReadOnly | Description |
| Name | String | False |
The name of the event. |
| OccurredAt | Datetime | False |
The occurred datetime of the event. |
| Properties | String | False |
Properties of the event in an aggregate JSON Format. |
| ListId | String | False |
The unique id for the list. |
| MemberId | String | False |
The MD5 hash of the list member's email address. |
The last 10 notes for a specific list member, based on date created.
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.
SELECT * FROM ListMemberNotes WHERE ListId = '121' and MemberId = '11' and Id='456'
No fields are are required when INSERTing.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The note's ID. |
| CreatedAt | Datetime | True |
The date the note was created. |
| CreatedBy | String | True |
The author of the note. |
| UpdatedAt | Datetime | True |
The date the note was last updated |
| Note | String | False |
The content of the note. |
| ListId [KEY] | String | False |
The unique id for the list. |
| MemberId [KEY] | String | False |
The MD5 hash of the list member's email address. |
| ContactId | String | True |
As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the email_id is the MD5 hash of their email address, this contact_id is agnostic of contact?s inclusion of an email address. |
| EmailId | String | True |
The MD5 hash of the lowercase version of the list member's email address. |
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.
SELECT, INSERT, UPDATE, and DELETE are supported for ListMembers.
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.
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'
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.
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.
The ListId and Id are required for Delete.
DELETE FROM ListMembers where ListId='ada232' and Id='1511asd'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The MD5 hash of the list member's email address. |
| EmailAddress | String | False |
Email address for a subscriber. |
| UniqueEmailId [KEY] | String | True |
An identifier for the address across all of MailChimp. |
| EmailType | String | False |
Type of email this member asked to get ('html' or 'text'). |
| FullName | String | True |
The contact's full name. |
| Status | String | False |
Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', 'pending' or 'transactional'). |
| StatusIfNew | String | False |
Subscriber's status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'), to be used only on a PUT request if the email is not already present on the list. |
| Interests | String | False |
The key of this object's properties is the ID of the interest in question. |
| Stats_AvgOpenRate | Double | True |
A subscriber's average open rate. |
| Stats_AvgClickRate | Double | True |
A subscriber's average clickthrough rate. |
| IpSignup | String | False |
IP address the subscriber signed up from. |
| TimestampSignup | Datetime | False |
Date and time the subscriber signed up for the list. |
| IpOpt | String | False |
IP address the subscriber confirmed their opt-in status. |
| TimestampOpt | Datetime | False |
Date and time the subscribe confirmed their opt-in status. |
| MemberRating | Integer | True |
Star rating for this member between 1 and 5. |
| LastChanged | Datetime | True |
Date and time the member's info was last changed. |
| Language | String | False |
If set/detected, the language of the subscriber. |
| Vip | Boolean | False |
VIP status for subscriber. |
| EmailClient | String | True |
The email client the address as using. |
| Location_Latitude | Double | False |
The location latitude. |
| Location_Longitude | Double | False |
The location longitude. |
| Location_Gmtoff | Integer | True |
The time difference in hours from GMT. |
| Location_Dstoff | Integer | True |
The offset for timezones where daylight saving time is observed. |
| Location_CountryCode | String | True |
The unique code for the location country. |
| Location_Timezone | String | True |
The timezone for the location. |
| LastNote_NoteId | Integer | True |
The note's ID. |
| LastNote_CreatedAt | String | True |
The date the note was created. |
| LastNote_CreatedBy | String | True |
The author of the note. |
| LastNote_Note | String | True |
The content of the note. |
| ListId [KEY] | String | False |
The id for the list. |
| TagsAggregate | String | False |
Tags of the member, displayed as an aggregate. |
| ContactId | String | True |
As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the id is the MD5 hash of their email address, this contact_id is agnostic of contact?s inclusion of an email address. |
| WebId | Integer | True |
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}. |
| UnsubscribeReason | String | True |
A subscriber's reason for unsubscribing. |
| ConsentsToOneToOneMessaging | Boolean | True |
Indicates whether a contact consents to 1:1 messaging. |
| Stats_EcommerceData_TotalRevenue | Decimal | True |
The total revenue the list member has brought in. |
| Stats_EcommerceData_NumberOfOrders | Integer | True |
The total number of orders placed by the list member. |
| Stats_EcommerceData_CurrencyCode | String | True |
The three-letter ISO 4217 code for the currency that the store accepts. |
| Location_Region | String | True |
The region for the location. |
| MarketingPermissionsAggregate | String | False |
The marketing permissions for the subscriber. |
| Source | String | True |
The source from which the subscriber was added to this list. |
| TagsCount | Integer | True |
The number of tags applied to this member. |
| MergeFields | String | False |
A dictionary of merge fields where the keys are the merge tags. |
| SmsPhoneNumber | String | False |
A US phone number for SMS contact. |
| SmsSubscriptionStatus | String | False |
The status of an SMS subscription. 使用できる値は次のとおりです。subscribed, unsubscribed, nonsubscribed, pending |
| SmsSubscriptionLastUpdated | Datetime | False |
The datetime when the SMS subscription was last updated. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| InterestCategoryId | String |
The unique id for the interest category, valid only for SELECT. |
| InterestMatch | String |
Used to filter list members by interests. Must be accompanied by InterestCategoryId and InterestIds, valid only for SELECT. Possible values: 'any', 'all', or 'none' |
| InterestIds | String |
Used to filter list members by interests. Must be accompanied by InterestCategoryId and InterestMatch, valid only for SELECT. |
| SinceLastCampaign | Boolean |
Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Status is required to use this filter, valid only for SELECT |
| UnsubscribedSince | Datetime |
Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error, valid only for SELECT |
The merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles.
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.
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'
The Name and ListID are required for INSERTs.
INSERT INTO ListMergeFields (Name, ListID) VALUES ('myNewListMergeField', 'myListID')
| Name | Type | ReadOnly | Description |
| MergeId [KEY] | Integer | True |
An unchanging id for the merge field. |
| Tag | String | False |
The tag used in MailChimp campaigns and for the /members endpoint. |
| Name | String | False | |
| Type | String | False |
The type for the merge field. |
| Required | Boolean | False |
Boolean value for if the merge field is required |
| DefaultValue | String | False |
The default value for the merge field if null. |
| Public | Boolean | False |
Whether or not the merge field is displayed on the signup form. |
| DisplayOrder | Integer | False |
The order on the form where the merge field is displayed. |
| Options_DefaultCountry | Integer | False |
In an address field, the default country code if none supplied. |
| Options_PhoneFormat | String | False |
In a phone field, the phone number type: US or International. |
| Options_DateFormat | String | False |
In a date or birthday field, the format of the date. |
| Options_Choices | String | False |
In a radio or dropdown non-group field, the available options for members to pick from. |
| Options_Size | Integer | False |
In a text field, the default length of the text field. |
| HelpText | String | False |
Any extra text to help the subscriber. |
| ListId [KEY] | String | False |
A string that identifies this merge field collections' list. |
A collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization.
SELECT, INSERT, UPDATE, and DELETE are supported for Lists.
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.
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'
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')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A string that uniquely identifies this list |
| Name | String | False |
The name of the list. |
| Contact_Company | String | False |
The company name associated with the list. |
| Contact_Address1 | String | False |
The street address for the list contact. |
| Contact_Address2 | String | False |
The street address for the list contact. |
| Contact_City | String | False |
The city for the list contact. |
| Contact_State | String | False |
The state for the list contact. |
| Contact_Zip | String | False |
The postal or zip code for the list contact. |
| Contact_Country | String | False |
A two-character ISO3166 country code. Defaults to US if invalid. |
| Contact_Phone | String | False |
The phone number for the list contact. |
| PermissionReminder | String | False |
The permission reminder for the list: a line of text that appears in the footer of each campaign that explains why subscribers are receiving the email campaign. |
| UseArchiveBar | Boolean | False |
Whether or not campaigns for this list use the Archive Bar in archives by default. |
| CampaignDefaults_FromName | String | False |
The default from name for campaigns sent to this list. |
| CampaignDefaults_FromEmail | String | False |
The default from email (must be a valid email address) for campaigns sent to this list. |
| CampaignDefaults_Subject | String | False |
The default subject line for campaigns sent to this list. |
| CampaignDefaults_Language | String | False |
The default language for this lists's forms. |
| NotifyOnSubscribe | String | False |
The email address to send subscribe notifications to, when enabled. |
| NotifyOnUnsubscribe | String | False |
The email address to send unsubscribe notifications to, when enabled. |
| DateCreated | Datetime | True |
The date and time that this list was created. |
| ListRating | Integer | True |
An auto-generated activity score for the list (0-5). |
| EmailTypeOption | Boolean | False |
Whether or not the list supports multiple formats for emails. |
| SubscribeUrlShort | String | True |
Our eepurl shortened version of this list's subscribe form. |
| SubscribeUrlLong | String | True |
The full version of this list's subscribe form (host will vary). |
| BeamerAddress | String | True |
The email address to use for this list's Email Beamer. |
| Visibility | String | False |
Whether this list is public (pub) or private (prv). Used internally for projects like Wavelength. |
| Modules | String | True |
Any list-specific modules installed for this list. |
| Stats_MemberCount | Integer | True |
The number of active members in the given list. |
| Stats_UnsubscribeCount | Integer | True |
The number of members who have unsubscribed from the given list. |
| Stats_CleanedCount | Integer | True |
The number of members cleaned from the given list. |
| Stats_MemberCountSinceSend | Integer | True |
The number of active members in the given list since the last campaign was sent. |
| Stats_UnsubscribeCountSinceSend | Integer | True |
The number of members who have unsubscribed since the last campaign was sent. |
| Stats_CleanedCountSinceSend | Integer | True |
The number of members cleaned from the given list since the last campaign was sent. |
| Stats_CampaignCount | Integer | True |
The number of campaigns in any status that use this list. |
| Stats_CampaignLastSent | Datetime | True |
The date and time the last campaign was sent to this list. |
| Stats_MergeFieldCount | Integer | True |
The number of merge vars for this list (not including the required EMAIL one). |
| Stats_AvgSubRate | Double | True |
The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). |
| Stats_AvgUnsubRate | Double | True |
The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). |
| Stats_TargetSubRate | Double | True |
The target numberof subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). |
| Stats_OpenRate | Double | True |
The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). |
| Stats_ClickRate | Double | True |
The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). |
| Stats_LastSubDate | Datetime | True |
The date and time of the last time someone subscribed to this list. |
| Stats_LastUnsubDate | Datetime | True |
The date and time of the last time someone unsubscribed from this list. |
| WebId | Integer | True |
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}. |
| DoubleOptin | Boolean | False |
Whether or not to require the subscriber to confirm subscription via email. |
| HasWelcome | Boolean | True |
Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup. |
| MarketingPermissions | Boolean | False |
Whether or not the list has marketing permissions (eg. GDPR) enabled. |
| Stats_TotalContacts | Integer | True |
The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. |
Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
SELECT, INSERT, and DELETE are supported for ListSegmentMembers.
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.
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
The Name and ListID are required for INSERTs.
INSERT INTO ListSegmentMembers (EmailAddress,ListId,SegmentId) VALUES ('[email protected]','44a64c46cb','7032720')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The MD5 hash of the list member's email address. |
| EmailAddress | String | False |
Email address for a subscriber. |
| UniqueEmailId [KEY] | String | True |
An identifier for the address across all of MailChimp. |
| EmailType | String | True |
Type of email this member asked to get ('html' or 'text'). |
| Status | String | True |
Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'). |
| StatusIfNew | String | True |
Subscriber's status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'), to be used only on a PUT request if the email is not already present on the list. |
| Interests | String | True |
The key of this object's properties is the ID of the interest in question. |
| Stats_AvgOpenRate | Double | True |
A subscriber's average open rate. |
| Stats_AvgClickRate | Double | True |
A subscriber's average clickthrough rate. |
| IpSignup | String | True |
IP address the subscriber signed up from. |
| TimestampSignup | Datetime | True |
Date and time the subscriber signed up for the list. |
| IpOpt | String | True |
IP address the subscriber confirmed their opt-in status. |
| TimestampOpt | Datetime | True |
Date and time the subscribe confirmed their opt-in status. |
| MemberRating | Integer | True |
Star rating for this member between 1 and 5. |
| LastChanged | Datetime | True |
Date and time the member's info was last changed. |
| Language | String | True |
If set/detected, the language of the subscriber. |
| Vip | Boolean | True |
VIP status for subscriber. |
| EmailClient | String | True |
The email client the address as using. |
| Location_Latitude | Double | True | |
| Location_Longitude | Double | True | |
| Location_Gmtoff | Integer | True | |
| Location_Dstoff | Integer | True | |
| Location_CountryCode | String | True | |
| Location_Timezone | String | True | |
| LastNote_NoteId | Integer | True |
The note's ID. |
| LastNote_CreatedAt | String | True |
The date the note was created. |
| LastNote_CreatedBy | String | True |
The author of the note. |
| LastNote_Note | String | True |
The content of the note. |
| ListId [KEY] | String | False |
The id for the list. |
| SegmentId [KEY] | String | False |
The id for the segment. |
| MergeFields | String | True |
A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| IncludeCleaned | Boolean |
Include cleaned members in response, only valid for SELECT. |
| IncludeTransactional | Boolean |
Include transactional members in response, only valid for SELECT |
| IncludeUnsubscribed | Boolean |
Include unsubscribed members in response, only valid for SELECT |
A list of available segments.
SELECT, INSERT, UPDATE, and DELETE are supported for ListSegments.
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.
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'
The Name and ListID are required for INSERTs.
INSERT INTO ListSegments (Name, ListID) VALUES ('myNewListSegment', 'myListID')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
An integer to uniquely identify the segment. |
| Name | String | False |
The name of the segment. |
| MemberCount | Integer | True |
The number of active subscribers currently included in the segment. |
| Type | String | True |
The type of segment: saved, static, or fuzzy. |
| CreatedAt | Datetime | True |
The time and date the segment was created. |
| UpdatedAt | Datetime | True |
The time and date the segment was last updated. |
| Options_Match | String | False |
Match type of 'any' or 'all'. |
| Options_Conditions | String | False |
An array of segment conditions. |
| ListId [KEY] | String | False |
The id for the list. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| EmailList | String |
A comma-separated list of emails that you want to include in this ListSegment. |
| IncludeCleaned | Boolean |
Include cleaned members in response, only valid for SELECT |
| IncludeTransactional | Boolean |
Include transactional members in response, only valid for SELECT |
| IncludeUnsubscribed | Boolean |
Include unsubscribed members in response, only valid for SELECT |
Webhooks configured for the given list.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
An identifier for the webhook across all of MailChimp. |
| Url | String | False |
the URL for this Webhook. |
| Events_Subscribe | Boolean | False | |
| Events_Unsubscribe | Boolean | False | |
| Events_Profile | Boolean | False | |
| Events_Cleaned | Boolean | False | |
| Events_Upemail | Boolean | False | |
| Events_Campaign | Boolean | False | |
| Sources_User | Boolean | False | |
| Sources_Admin | Boolean | False | |
| Sources_Api | Boolean | False | |
| ListId [KEY] | String | False |
The id for the list. |
Folders for organizing templates
SELECT, INSERT, UPDATE, and DELTE are supported for TemplateFolders.
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.
SELECT * FROM TemplateFolders WHERE Id = '1245'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A string that uniquely identifieds this folder |
| Name | String | False |
The name of the folder |
| Count | Integer | True |
The number of templates in the folder |
A list an account's available templates.
SELECT, INSERT, UPDATE and DELETE are supported for Templates.
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.
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'
Columns Name and Html are required for Insert.
INSERT INTO Templates(name, html) VALUES ('test_template', '<title></title>')
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 from Templates where id=13695
| 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. 使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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 |
Get Transactional Allowlists.
SELECT, INSERT and DELETE is supported for TransactionalAllowlists.
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.
SELECT * FROM TransactionalAllowlists WHERE Email = '[email protected]'
Email is required for Insert operation.
INSERT INTO TransactionalAllowlists(Email) VALUES ('[email protected]')
Email is required for Delete operation.
DELETE FROM TransactionalAllowlists WHERE Email = '[email protected]'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Comment | String |
An optional description of why the email was added to the allowlist. Only used for INSERT. |
Get Transactional Tags.
SELECT and DELETE are supported for TransactionalTags.
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.
SELECT * FROM TransactionalTags WHERE Tag = 'welcome'
Tag is required for the DELETE operation.
DELETE FROM TransactionalTags WHERE Tag = 'welcome'
| Name | Type | ReadOnly | Description |
| Tag [KEY] | String | True |
The actual tag as a string. |
| Reputation | Integer | True |
The tag's current reputation on a scale from 0 to 100. |
| Sent | Integer | True |
The total number of messages sent by this sender. |
| HardBounces | Integer | True |
The total number of hard bounces by messages by this sender. |
| SoftBounces | Integer | True |
The total number of soft bounces by messages by this sender. |
| Rejects | Integer | True |
The total number of rejected messages by this sender. |
| Complaints | Integer | True |
The total number of spam complaints received for messages by this sender. |
| Unsubs | Integer | True |
The total number of unsubscribe requests received for messages by this sender. |
| Opens | Integer | True |
The total number of times messages by this sender have been opened. |
| Clicks | Integer | True |
The total number of times tracked URLs in messages by this sender have been clicked. |
| UniqueOpens | Integer | True |
The number of unique opens for emails sent for this sender. |
| UniqueClicks | Integer | True |
The number of unique clicks for emails sent for this sender. |
| StatsTodaySent | Integer | True |
The number of emails sent with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodayHardBounces | Integer | True |
The number of emails hard bounced with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodaySoftBounces | Integer | True |
The number of emails soft bounced with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodayRejects | Integer | True |
The number of emails rejected for sending this sender so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodayComplaints | Integer | True |
The number of spam complaints with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodayUnsubs | Integer | True |
The number of unsubscribes with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodayOpens | Integer | True |
The number of times emails have been opened with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodayClicks | Integer | True |
The number of URLs that have been clicked with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodayUniqueOpens | Integer | True |
The number of unique opens for emails sent with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsTodayUniqueClicks | Integer | True |
The number of unique clicks for emails sent with this tag so far today. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysSent | Integer | True |
The number of emails sent with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysHardBounces | Integer | True |
The number of emails hard bounced with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysSoftBounces | Integer | True |
The number of emails soft bounced with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysRejects | Integer | True |
The number of emails rejected for sending this sender in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysComplaints | Integer | True |
The number of spam complaints with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysUnsubs | Integer | True |
The number of unsubscribes with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysOpens | Integer | True |
The number of times emails have been opened with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysClicks | Integer | True |
The number of URLs that have been clicked with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysUniqueOpens | Integer | True |
The number of unique opens for emails sent with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast7DaysUniqueClicks | Integer | True |
The number of unique clicks for emails sent with this tag in the last 7 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysSent | Integer | True |
The number of emails sent with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysHardBounces | Integer | True |
The number of emails hard bounced with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysSoftBounces | Integer | True |
The number of emails soft bounced with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysRejects | Integer | True |
The number of emails rejected for sending this sender in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysComplaints | Integer | True |
The number of spam complaints with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysUnsubs | Integer | True |
The number of unsubscribes with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysOpens | Integer | True |
The number of times emails have been opened with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysClicks | Integer | True |
The number of URLs that have been clicked with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysUniqueOpens | Integer | True |
The number of unique opens for emails sent with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast30DaysUniqueClicks | Integer | True |
The number of unique clicks for emails sent with this tag in the last 30 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysSent | Integer | True |
The number of emails sent with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysHardBounces | Integer | True |
The number of emails hard bounced with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysSoftBounces | Integer | True |
The number of emails soft bounced with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysRejects | Integer | True |
The number of emails rejected for sending this sender in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysComplaints | Integer | True |
The number of spam complaints with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysUnsubs | Integer | True |
The number of unsubscribes with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysOpens | Integer | True |
The number of times emails have been opened with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysClicks | Integer | True |
The number of URLs that have been clicked with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysUniqueOpens | Integer | True |
The number of unique opens for emails sent with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast60DaysUniqueClicks | Integer | True |
The number of unique clicks for emails sent with this tag in the last 60 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysSent | Integer | True |
The number of emails sent with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysHardBounces | Integer | True |
The number of emails hard bounced with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysSoftBounces | Integer | True |
The number of emails soft bounced with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysRejects | Integer | True |
The number of emails rejected for sending this sender in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysComplaints | Integer | True |
The number of spam complaints with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysUnsubs | Integer | True |
The number of unsubscribes with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysOpens | Integer | True |
The number of times emails have been opened with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysClicks | Integer | True |
The number of URLs that have been clicked with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysUniqueOpens | Integer | True |
The number of unique opens for emails sent with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
| StatsLast90DaysUniqueClicks | Integer | True |
The number of unique clicks for emails sent with this tag in the last 90 days. This column will populated when Id is specified in WHERE clause. |
Get Transactional Templates.
SELECT, INSERT, UPDATE, and DELETE operations are supported for TransactionalTemplates.
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.
SELECT * FROM TransactionalTemplates WHERE Name = 'MyTemplate' SELECT * FROM TransactionalTemplates WHERE Label = 'MyLabel'
Name is required for the INSERT operation.
INSERT INTO TransactionalTemplates (Name, Subject, FromEmail, FromName, Publish) VALUES ('MyTemplate', 'Hello Subject', '[email protected]', 'Sender Name', true)
Name is required for the UPDATE operation as it acts as the key.
UPDATE TransactionalTemplates SET labels='[\"adw\", \"eww\"]' WHERE name='testname'
Nameis required for the DELETE operation.
DELETE FROM TransactionalTemplates WHERE Name = 'MyTemplate'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AccountExports | Generate a new account export or download a finished account export. |
| AuthorizedApps | A list of applications authorized to access the account. |
| AutomationEmailQueues | A summary of the queue for an email in an automation workflow. |
| AutomationEmails | A summary of the emails in an automation workflow. |
| Automations | A summary of the automations within an account. |
| AutomationsRemovedSubscribers | A summary of the subscribers removed from an automation workflow. |
| BatchOperations | Get a summary of batch requests that have been made. |
| BatchWebhooks | Get information about batch webhooks. |
| CampaignContents | Get the the HTML and plain-text content for a campaign. |
| CampaignOpenEmailDetails | A list of members who opened the campaign email. |
| CampaignSendCheckList | Review the send checklist for a campaign, and resolve any issues before sending. |
| CampaignVariateContents | Get the the HTML and plain-text content for a campaign. |
| ChimpChatterActivity | Return the Chimp Chatter for this account ordered by most recent. |
| ConnectedSites | Get all connected sites in an account. |
| ConversationMessages | Messages from a specific conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account. |
| Conversations | A collection of this account's tracked conversations. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account. |
| EcommerceProductImages | A Product Image represents a specific product image. |
| EcommercePromoCodes | Retrieves the list of promo codes under a promo rule |
| EcommercePromoRules | Get information about a store's promo rules |
| EcommerceStores | A list of an account's ecommerce stores. |
| FacebookAds | List of Facebook ads configured in Mailchimp. |
| FileManagerFolderFiles | List of files stored in Mailchimp file manager. |
| LandingPageContents | Get the content of a landing page. |
| LandingPages | Get a list of landing pages for the account. |
| ListAbuse | A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. |
| ListActivity | Up to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity. |
| ListClients | Top email clients used, as measured by their user-agent string |
| ListGrowthHistory | A month-by-month summary of a specific list's growth activity. |
| ListMemberActivity | The last 50 member events for a list. |
| ListMemberActivityFeeds | Get a member's activity on a specific list, including opens, clicks, and unsubscribes. |
| ListMemberGoals | List goal events for a list member in Mailchimp. |
| ListMemberTags | Tags assigned to a certain member/members. |
| ListSignupForms | Collection of List Signup Forms |
| ListsTagsSearch | Search for tags on a list. |
| ListSurveys | Returns all surveys for a list. |
| ReportAbuse | A list of abuse complaints for a specific list. |
| ReportAdvice | A list of feedback based on a campaign's statistics. |
| ReportClickDetails | A list of URLs and unique IDs included in HTML and plain-text versions of a campaign. |
| ReportClickDetailsMembers | A collection of members who clicked on a specific link within a campaign. |
| ReportDomainPerformance | Statistics for the top-performing email domains in a campaign. |
| ReportEepUrls | Get EepURL activity reports. |
| ReportEmailActivity | A list of member's subscriber activity in a specific campaign. |
| ReportingFacebookAds | List of Facebook ad reports in Mailchimp. |
| ReportingLandingPages | Get reports of your landing pages. |
| ReportingSurveyQuestionAnswers | List of answers for a survey question. |
| ReportingSurveyQuestions | Get reports about your survey questions. |
| ReportLocations | Top open locations for a specific campaign. |
| ReportProductActivity | Campaign product activity report. |
| Reports | A list of reports containing campaigns marked as Sent. |
| ReportSentTo | A list of subscribers who were sent a specific campaign. |
| ReportSubReports | Child campaign reports. |
| ReportUnsubscribes | A list of members who have unsubscribed from a specific campaign. |
| SurveyResponses | List of survey responses. |
| Surveys | Get reports for surveys. |
| TransactionalScheduledEmails | Get Transactional Scheduled Emails. |
| TransactionalSenders | Get Transactional Senders. |
| TransactionalUserInfos | Get Transactional user info. |
| VerifiedDomains | List of sending domains configured in Mailchimp. |
Generate a new account export or download a finished account export.
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.
SELECT * FROM AccountExports; SELECT * FROM AccountExports where Id=3191;
| Name | Type | Description |
| Id [KEY] | Integer | The ID for the export. |
| Started | Datetime | Start time for the export. |
| Finished | Datetime | If finished, the finish time for the export. |
| SizeInBytes | Integer | The size of the uncompressed export in bytes. |
| DownloadUrl | String | If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. |
| Links | String | A list of link types and descriptions for the API schema documents. |
A list of applications authorized to access the account.
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.
SELECT * FROM AuthorizedApps WHERE Id = '1245'
| Name | Type | Description |
| Id [KEY] | String | The Id for this application integration. |
| Name | String | The name of the application. |
| Description | String | The description for the application. |
| Users | String | An array of usernames of the users who have linked this app. |
A summary of the queue for an email in an automation workflow.
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.
SELECT * FROM AutomationEmailQueues WHERE Id = '1245' SELECT * FROM AutomationEmailQueues WHERE WorkflowId = '1245' and EmailId = '1245'
| 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 |
A summary of the emails in an automation workflow.
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.
SELECT * FROM AutomationEmails WHERE WorkflowId = '1245'
| 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.
使用できる値は次のとおりです。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. |
A summary of the automations within an account.
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.
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'
| 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. |
A summary of the subscribers removed from an automation workflow.
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.
SELECT * FROM AutomationsRemovedSubscribers WHERE WorkflowId = '1245'
| 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 |
Get a summary of batch requests that have been made.
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.
SELECT * FROM BatchOperations; SELECT * FROM BatchOperations where Id=2;
| Name | Type | Description |
| Id [KEY] | String | A string that uniquely identifies this batch request. |
| Status | String | The status of the batch call. Learn more about the batch operation status
使用できる値は次のとおりです。pending, preprocessing, started, finalizing, finished |
| TotalOperations | Integer | The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. |
| FinishedOperations | Integer | The number of completed operations. This includes operations that returned an error. |
| ErroredOperations | Integer | The number of completed operations that returned an error. |
| SubmittedAt | Datetime | The date and time when the server received the batch request in ISO 8601 format. |
| CompletedAt | Datetime | The date and time when all operations in the batch request completed in ISO 8601 format. |
| ResponseBodyUrl | String | The URL of the gzipped archive of the results of all the operations. |
| Links | String | A list of link types and descriptions for the API schema documents. |
Get information about batch webhooks.
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.
SELECT * FROM BatchWebhooks; SELECT * FROM BatchWebhooks where Id='2';
| Name | Type | Description |
| Id [KEY] | String | A string that uniquely identifies this batch webhook. |
| Url | String | A valid URL for the webhook. |
| Enabled | Boolean | Whether this webhook is enabled. |
Get the the HTML and plain-text content for a campaign.
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.
SELECT * FROM CampaignContents; SELECT * FROM CampaignContents where CampaignId='381b6f0c90';
| Name | Type | Description |
| CampaignId | String | The unique id for the campaign. |
| 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. |
| ArchiveHtml | String | The Archive HTML for the campaign. |
A list of members who opened the campaign email.
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.
For example:
SELECT * FROM CampaignOpenEmailDetails SELECT * FROM CampaignOpenEmailDetails WHERE CampaignId = '9f218dcf18' SELECT * FROM CampaignOpenEmailDetails WHERE Since = '2024-02-07 00:00:37.0'
| Name | Type | Description |
| CampaignId [KEY] | String | The Id for this application integration. |
| ListId [KEY] | String | The name of the application. |
| ListIsActive | Boolean | The description for the application. |
| ContactStatus | String | An array of usernames of the users who have linked this app. |
| EmailId [KEY] | String | The description for the application. |
| EmailAddress | String | The description for the application. |
| MergeFields | String | The description for the application. |
| Vip | Boolean | The description for the application. |
| OpensCount | Integer | The description for the application. |
| Opens | String | The description for the application. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Since | Datetime | Restrict results to campaign open events that occur after a specific time. |
Review the send checklist for a campaign, and resolve any issues before sending.
| Name | Type | Description |
| CampaignId [KEY] | String | The unique id for the campaign.` |
| Id [KEY] | String | The ID for the specific item. |
| Type | String | The item type.
使用できる値は次のとおりです。success, warning, error |
| Heading | String | The heading for the specific item. |
| Details | String | Details about the specific feedback item. |
Get the the HTML and plain-text content for a campaign.
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.
SELECT * FROM CampaignVariateContents; SELECT * FROM CampaignVariateContents where CampaignId='381b6f0c90';
| 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. |
Return the Chimp Chatter for this account ordered by most recent.
SELECT is supported for ChimpChatterActivity.
SELECT * FROM ChimpChatterActivity
| Name | Type | Description |
| Title | String | A string that uniquely identifies this batch request. |
| Message | String | The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. |
| Type | String | The raw HTML for the campaign.
使用できる値は次のとおりです。lists:new-subscriber, lists:unsubscribes, lists:profile-updates, campaigns:facebook-likes, campaigns:forward-to-friend, lists:imports |
| ModifiedAt | Datetime | The Archive HTML for the campaign. |
| Url | String | A list of link types and descriptions for the API schema documents. |
| ListId | String | A string that uniquely identifies this batch request. |
| CamapignId | String | A string that uniquely identifies this batch request. |
Get all connected sites in an account.
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.
SELECT * FROM ConnectedSites; SELECT * FROM ConnectedSites where Id='03008bc4e0f0';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the site. |
| StoreId | String | The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. |
| Platform | String | The platform of the connected site. |
| Domain | String | The connected site domain. |
| CreatedAt | Datetime | The date and time the connected site was created in ISO 8601 format. |
| UpdatedAt | Datetime | The date and time the connected site was last updated in ISO 8601 format. |
| SiteScriptUrl | String | The URL used for any integrations that offer built-in support for connected sites. |
| SiteScriptFragment | String | A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. |
| Links | String | A list of link types and descriptions for the API schema documents. |
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.
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.
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'
| 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 |
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.
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.
SELECT * FROM Conversations WHERE Id = '1254' SELECT * FROM Conversations WHERE CampaignId = '1245' SELECT * FROM Conversations WHERE ListId = '1245' SELECT * FROM Conversations WHERE HasUnreadMessages = 'true'
| 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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| HasUnreadMessages | String | Filter on unread_messages, only valid for SELECT. |
A Product Image represents a specific product image.
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.
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';
| Name | Type | Description |
| StoreId [KEY] | String | The id for the store. |
| ProductId [KEY] | String | The ID of the associated product. |
| Id [KEY] | String | A unique identifier for the product image. |
| Url | String | The actual promotional code. |
| VariantIds | String | URL used to redeem the promo code. |
| Links | String | A list of link types and descriptions for the API schema documents. |
Retrieves the list of promo codes under a promo rule
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.
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';
| 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. |
Get information about a store's promo rules
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.
SELECT * FROM EcommercePromoRules; SELECT * FROM EcommercePromoRules where where Id='ruleid1' SELECT * FROM EcommercePromoRules where Id='ruleid1' and storeId='STR002';
| Name | Type | Description |
| StoreId [KEY] | String | The Store Id. |
| Id [KEY] | String | The ID of the associated promo rule. |
| Ttile | String | The title that will show up in promotion campaign. |
| Description | String | The description of a promotion restricted to UTF-8 characters with max length 255. |
| StartsAt | Datetime | The date and time when the promotion is in effect in ISO 8601 format. |
| EndsAt | Datetime | The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. |
| Amount | Decimal | The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive |
| Type | String | Type of discount. For free shipping set type to fixed.
使用できる値は次のとおりです。fixed, percentage |
| Target | String | The target that the discount applies to.
使用できる値は次のとおりです。per_item, total, shipping |
| Enabled | Boolean | Whether the promo rule is currently enabled. |
| 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. |
A list of an account's ecommerce stores.
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.
SELECT * FROM EcommerceStores WHERE Id = '44'
| 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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。save, sending, paused |
| ListIsActive | Boolean | The status of the list connected to the store, namely if it's deleted or disabled. |
List of Facebook ads configured in Mailchimp.
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.
SELECT * FROM FacebookAds; SELECT * FROM FacebookAds where Id='2';
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the Facebook ad. |
| Name | String | The name of the Facebook ad. |
| Type | String | The type of the Facebook ad. |
| Status | String | The status of the Facebook ad. |
| CreateTime | Datetime | The date and time the Facebook ad was created. |
| UpdatedAt | Datetime | The date and time the Facebook ad was last updated. |
| StartTime | Datetime | The start time of the Facebook ad. |
| EndTime | Datetime | The end time of the Facebook ad. |
| PausedAt | Datetime | The date and time the Facebook ad was paused. |
| CanceledAt | Datetime | The date and time the Facebook ad was canceled. |
| PublishedTime | Datetime | The date and time the Facebook ad was published. |
| WebId | Integer | The web ID of the Facebook ad. |
| HasAudience | Boolean | Whether the Facebook ad has an audience. |
| HasContent | Boolean | Whether the Facebook ad has content. |
| HasSegment | Boolean | Whether the Facebook ad has a segment. |
| IsConnected | Boolean | Whether the Facebook ad is connected. |
| NeedsAttention | Boolean | Whether the Facebook ad needs attention. |
| ShowReport | Boolean | Whether the Facebook ad shows a report. |
| WasCanceledByFacebook | Boolean | Whether the Facebook ad was canceled by Facebook. |
| Thumbnail | String | The thumbnail image for the Facebook ad. |
| EmailSourceName | String | The name of the email source for the Facebook ad. |
| AudienceEmailSourceIsSegment | Boolean | Whether the audience email source is a segment. |
| AudienceEmailSourceListName | String | The list name of the audience email source. |
| AudienceEmailSourceName | String | The name of the audience email source. |
| AudienceEmailSourceSegmentType | String | The segment type of the audience email source. |
| AudienceEmailSourceType | String | The type of the audience email source. |
| AudienceIncludeSourceInTarget | Boolean | Whether to include the source in the audience target. |
| AudienceLookalikeCountryCode | String | The lookalike country code for the audience. |
| AudienceSourceType | String | The source type of the audience. |
| AudienceTargetingSpecsGender | Integer | The gender targeting specification for the audience. |
| AudienceTargetingSpecsInterests | String | The interests targeting specification for the audience. |
| AudienceTargetingSpecsLocationsCities | String | The cities location targeting specification for the audience. |
| AudienceTargetingSpecsLocationsCountries | String | The countries location targeting specification for the audience. |
| AudienceTargetingSpecsLocationsRegions | String | The regions location targeting specification for the audience. |
| AudienceTargetingSpecsLocationsZips | String | The zip codes location targeting specification for the audience. |
| AudienceTargetingSpecsMaxAge | Integer | The maximum age targeting specification for the audience. |
| AudienceTargetingSpecsMinAge | Integer | The minimum age targeting specification for the audience. |
| AudienceType | String | The type of the audience. |
| BudgetCurrencyCode | String | The currency code for the budget. |
| BudgetDuration | Integer | The duration of the budget. |
| BudgetTotalAmount | Integer | The total amount of the budget. |
| ChannelFbPlacementAudience | Boolean | Whether the Facebook ad is placed in the Facebook audience. |
| ChannelFbPlacementFeed | Boolean | Whether the Facebook ad is placed in the Facebook feed. |
| ChannelIgPlacementFeed | Boolean | Whether the Facebook ad is placed in the Instagram feed. |
| ContentAttachments | String | The attachments for the Facebook ad content. |
| ContentCallToAction | String | The call to action for the Facebook ad content. |
| ContentDescription | String | The description for the Facebook ad content. |
| ContentImageUrl | String | The image URL for the Facebook ad content. |
| ContentLinkUrl | String | The link URL for the Facebook ad content. |
| ContentMessage | String | The message for the Facebook ad content. |
| ContentTitle | String | The title for the Facebook ad content. |
| FeedbackAudience | String | The audience feedback for the Facebook ad. |
| FeedbackBudget | String | The budget feedback for the Facebook ad. |
| FeedbackCompliance | String | The compliance feedback for the Facebook ad. |
| FeedbackContent | String | The content feedback for the Facebook ad. |
| RecipientsListId | String | The list ID for the recipients of the Facebook ad. |
| RecipientsListIsActive | Boolean | Whether the recipients list is active for the Facebook ad. |
| RecipientsListName | String | The name of the recipients list for the Facebook ad. |
| RecipientsRecipientCount | Integer | The recipient count for the Facebook ad. |
| RecipientsSegmentOptsConditions | String | The segment options conditions for the recipients of the Facebook ad. |
| RecipientsSegmentOptsMatch | String | The segment options match for the recipients of the Facebook ad. |
| RecipientsSegmentOptsPrebuiltSegmentId | String | The prebuilt segment ID for the recipients of the Facebook ad. |
| RecipientsSegmentOptsSavedSegmentId | Integer | The saved segment ID for the recipients of the Facebook ad. |
| RecipientsSegmentText | String | The segment text for the recipients of the Facebook ad. |
| ReportSummaryClickRate | Integer | The click rate in the report summary for the Facebook ad. |
| ReportSummaryClicks | Integer | The number of clicks in the report summary for the Facebook ad. |
| ReportSummaryConversionRate | Integer | The conversion rate in the report summary for the Facebook ad. |
| ReportSummaryEcommerceAverageOrderRevenue | Integer | The average order revenue in the ecommerce report summary for the Facebook ad. |
| ReportSummaryEcommerceCurrencyCode | String | The currency code in the ecommerce report summary for the Facebook ad. |
| ReportSummaryEcommerceTotalRevenue | Integer | The total revenue in the ecommerce report summary for the Facebook ad. |
| ReportSummaryEngagements | Integer | The number of engagements in the report summary for the Facebook ad. |
| ReportSummaryImpressions | Integer | The number of impressions in the report summary for the Facebook ad. |
| ReportSummaryOpenRate | Integer | The open rate in the report summary for the Facebook ad. |
| ReportSummaryOpens | Integer | The number of opens in the report summary for the Facebook ad. |
| ReportSummaryProxyExcludedOpenRate | Integer | The proxy excluded open rate in the report summary for the Facebook ad. |
| ReportSummaryProxyExcludedOpens | Integer | The number of proxy excluded opens in the report summary for the Facebook ad. |
| ReportSummaryProxyExcludedUniqueOpens | Integer | The number of proxy excluded unique opens in the report summary for the Facebook ad. |
| ReportSummaryReach | Integer | The reach in the report summary for the Facebook ad. |
| ReportSummarySubscriberClicks | Integer | The number of subscriber clicks in the report summary for the Facebook ad. |
| ReportSummarySubscribes | Integer | The number of subscribes in the report summary for the Facebook ad. |
| ReportSummaryTotalSent | Integer | The total number of sent items in the report summary for the Facebook ad. |
| ReportSummaryUniqueOpens | Integer | The number of unique opens in the report summary for the Facebook ad. |
| ReportSummaryUniqueVisits | Integer | The number of unique visits in the report summary for the Facebook ad. |
| ReportSummaryVisits | Integer | The number of visits in the report summary for the Facebook ad. |
| SiteId | Integer | The site ID for the Facebook ad. |
| SiteName | String | The site name for the Facebook ad. |
| SiteUrl | String | The site URL for the Facebook ad. |
List of files stored in Mailchimp file manager.
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.
SELECT * FROM FileManagerFolderFiles; SELECT * FROM FileManagerFolderFiles where FolderId=1002;
| Name | Type | Description |
| Id [KEY] | Integer | A unique identifier for the file. |
| FolderId [KEY] | Integer | The folder ID the file is stored in. |
| CreatedAt | Datetime | The date and time the file was created. |
| CreatedBy | String | The user who uploaded the file. |
| FullSizeUrl | String | The URL for the full-size file. |
| Height | Integer | The height of the file (if image). |
| Name | String | The name of the file. |
| Size | Integer | The size of the file in bytes. |
| ThumbnailUrl | String | The URL for the file's thumbnail. |
| Type | String | The file type. |
| Width | Integer | The width of the file (if image). |
| TotalFileSize | Decimal | The total size of all File Manager files in bytes. |
Get the content of a landing page.
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.
SELECT * FROM LandingPageContents; SELECT * FROM LandingPageContents where PageId='2';
| Name | Type | Description |
| PageId [KEY] | String | The landing page id. |
| Html | String | The raw HTML for the landing page. |
| Json | String | The JSON structure for the landing page. |
Get a list of landing pages for the account.
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.
SELECT * FROM LandingPages; SELECT * FROM LandingPages where Id='2';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the landing page. |
| Name | String | The name of the landing page. |
| Title | String | The title of the landing page. |
| Description | String | The description of the landing page. |
| TemplateId | Integer | The template used to create the landing page. |
| Status | String | The status of the landing page (published, unpublished, or draft).
使用できる値は次のとおりです。published, unpublished, draft |
| ListId | String | The list's ID associated with the landing page. |
| StoreId | String | The ID of the store associated with the landing page. |
| WebId | Integer | The ID used in the Mailchimp web application. |
| CreatedAt | Datetime | The date and time the landing page was created. |
| UpdatedAt | Datetime | The date and time the landing page was last updated. |
| PublishedAt | Datetime | The date and time the landing page was published. |
| UnpublishedAt | Datetime | The date and time the landing page was unpublished. |
| CreatedBySource | String | The source the landing page was created from. |
| TrackingTrackWithMailchimp | Boolean | Whether to track clicks in links. |
| TrackingEnableRestrictedDataProcessing | Boolean | Whether to enable restricted data processing. |
| Url | String | The URL for the landing page. |
A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program.
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.
SELECT * FROM ListAbuse WHERE ListId = 'abc' and Id='452'
| Name | Type | Description |
| Id [KEY] | String | The id for the abuse report |
| CampaignId [KEY] | String | The campaign id for the abuse report |
| ListId [KEY] | String | The list id for the abuse report. |
| EmailId [KEY] | String | The MD5 hash of the list member's email address. |
| EmailAddress | String | Email address for a subscriber |
| Date | String | Date for the abuse report |
| 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. |
Up to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity.
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.
SELECT * FROM ListActivity WHERE ListId = 'abc'
| Name | Type | Description |
| ListId [KEY] | String | The ListId for the table. |
| Day [KEY] | Date | The date for the activity summary. |
| EmailsSent | Integer | The total number of emails sent on the date for the activity summary. |
| UniqueOpens | Integer | The number of unique opens. |
| RecipientClicks | Integer | The number of clicks. |
| HardBounce | Integer | The number of hard bounces. |
| SoftBounce | Integer | The number of soft bounces |
| Subs | Integer | The number of subscribes. |
| Unsubs | Integer | The number of unsubscribes. |
| OtherAdds | Integer | The number of subscribers who may have been added outside of the double opt-in process such as imports or API activity. |
| OtherRemoves | Integer | The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam. For example, deleted subscribers. |
Top email clients used, as measured by their user-agent string
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.
SELECT * FROM ListClients WHERE ListId = 'abc'
| Name | Type | Description |
| Client | String | The name of the email client. |
| Members | Integer | The number of subscribed members who used this email client. |
| ListId [KEY] | String | The unique id for the list. |
A month-by-month summary of a specific list's growth activity.
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.
SELECT * FROM ListGrowthHistory WHERE ListId = 'abc'
| Name | Type | Description |
| ListId [KEY] | String | The list id for the growth activity report. |
| Month [KEY] | String | The month that the growth history is describing. |
| Subscribed | Integer | Total subscribed members on the list at the end of the month. |
| Unsubscribed | Integer | Newly unsubscribed members on the list for a specific month. |
| Reconfirm | Integer | Newly reconfirmed members on the list for a specific month. |
| Cleaned | Integer | Newly cleaned (hard-bounced) members on the list for a specific month. |
| Pending | Integer | Pending members on the list for a specific month. |
| Deleted | Integer | Newly deleted members on the list for a specific month. |
| Transactional | Integer | Subscribers that have been sent transactional emails via Mandrill. |
The last 50 member events for a list.
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.
SELECT * FROM ListMemberActivity where ListId='121' and Action IN ('open', 'sent') and MemberId = '1211'
| 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. |
Get a member's activity on a specific list, including opens, clicks, and unsubscribes.
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.
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');
| Name | Type | Description |
| EmailId | String | The EmailId for the table. |
| ListId | String | The ListId for the table. |
| ActivityType | String | The type of event activity. |
| CreatedAtTimestamp | Datetime | The created at timestamp in ISO8601. |
| CampaignId | String | The campaign's unique id. |
| CampaignTitle | String | The title of the campaign. |
| LinkClicked | String | The URL of the link that was clicked. |
| BounceType | String | The type of bounce.
使用できる値は次のとおりです。hard, soft |
| BounceHasOpenActivity | Boolean | Indicates if the email associated with this bounce also has open activity on the same campaign. |
| IsAdminUnsubscribed | Boolean | Indicates if an admin unsubscribed a contact. |
| UnsubscribeReason | String | Indicates the reason that the contact was unsubscribed. |
| ThreadId | String | The thread's unique id of the conversation referenced in this event. |
| MessageText | String | The body of the message in this conversation. |
| CreatedBy | String | The username of the person who created this event. |
| IsUser | Boolean | Indicates that the message created by a user (as opposed to a contact). |
| HasRead | Boolean | Indicates that the message has been read. |
| FromEmail | String | The email of the contact who sent the reply. |
| AvatarUrl | String | The gravatar URL of the contact who sent the reply. |
| UpdatedAtTimestamp | Datetime | The updated at timestamp in ISO8601. |
| NoteId | String | The note's unique id. |
| NoteText | String | The note's text. |
| MarketingPermissonText | String | The text describing this marketing permission. |
| UpdatedBy | String | The name of the contact who updated this permission. |
| MarketingPermissionOptedIn | Boolean | Indicates if the marketing permission is enabled or not. |
| OutreachId | String | The outreach's unique id. |
| OutreachType | String | The type of outreach that triggered the event. |
| OutreachTitle | String | The title of the outreach. |
| StoreName | String | The name of the store. |
| SignupCategory | String | How was this user added to the list. |
| OrderId | String | The unique order id. |
| OrderTotal | String | The order total formatted as a string. |
| OrderItems | String | An array of items that have been ordered. |
| OrderUrl | String | The order URL. |
| EventName | String | The name of the event. |
| EventProperties | String | An arbitrary datastore containing properties for the given event. |
| SurveyId | String | The survey's unique id. |
| SurveyTitle | String | The title of the survey. |
List goal events for a list member in Mailchimp.
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.
SELECT * FROM ListMemberGoals WHERE ListId = '121' and EmailId = '11'
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the goal event. |
| ListId | String | The unique ID for the list. |
| EmailId | String | The unique id for the email that triggered the goal event. |
| GoalsId | String | The unique id for the goal that was triggered. |
| GoalsEvent | String | The type of goal event. |
| GoalsLastVisitedAt | Datetime | The date and time of the last visit for this event. |
| GoalsData | String | Any extra data associated with the event. |
Tags assigned to a certain member/members.
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.
SELECT * FROM ListMemberTags WHERE ListId = '12345' and MemberId = '458' and Id = '45';
| 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. |
Collection of List Signup Forms
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.
SELECT * FROM ListSignupForms WHERE ListId = 'abc'
| 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. |
Search for tags on a list.
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.
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%';
| 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. |
| ListId [KEY] | String | The ID of the list on which the member of this tag belongs to. |
Returns all surveys for a list.
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.
SELECT * FROM ListSurveys where ListId='545578' and Id='092ec96'
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the survey. |
| ListId | String | Identifier for the list associated with the survey. |
| Title | String | Title of the survey. |
| Status | String | Status of the survey. |
| CreatedAt | Datetime | Date and time the survey was created. |
| UpdatedAt | Datetime | Date and time the survey was last updated. |
| PublishedAt | Datetime | Date and time the survey was published. |
| HostedUrl | String | URL where the survey is hosted. |
| WebId | String | Web ID for the survey. |
| IsPipedToInbox | Boolean | Indicates if the survey is piped to inbox. |
| QuestionCount | Integer | Number of questions in the survey. |
| Questions | String | Questions included in the survey. |
| ResponseCount | Integer | Number of responses received for the survey. |
A list of abuse complaints for a specific list.
SELECT is supported for ReportAbuse.
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.
SELECT * FROM ReportAdvice WHERE CampaignId = 'abc' and Id = '556'
| Name | Type | Description |
| Id [KEY] | String | The unique id for the abuse report. |
| CampaignId [KEY] | String | The campaign id for the abuse report |
| ListId [KEY] | String | The list id for the abuse report. |
| EmailId [KEY] | String | The list-specific ID for the given email address |
| EmailAddress | String | Email address for a subscriber |
| Date | String | Date for the abuse report |
| 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. |
| ListIsActive | Boolean | The status of the list used, namely if it's deleted or disabled. |
A list of feedback based on a campaign's statistics.
SELECT is supported for ReportAdvice.
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.
SELECT * FROM ReportAdvice WHERE CampaignId = 'abc'
| Name | Type | Description |
| CampaignId | String | The CampaignId for the table. |
| Type | String | The 'type' of message ('negative', 'positive', 'neutral'). |
| Message | String | The advice message. |
A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.
SELECT is supported for ReportClickDetails.
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.
SELECT * FROM ReportClickDetails WHERE CampaignId = 'abc' and Id = '5659'
| 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. |
A collection of members who clicked on a specific link within a campaign.
SELECT is supported for ReportClickDetailsMembers.
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.
SELECT * FROM ReportClickDetailsMembers WHERE EmailId = '12a32' and CampaignId = '123d' and URLId = '3241s'
| Name | Type | Description |
| EmailId [KEY] | String | The list-specific ID for the given email address. |
| EmailAddress | String | Email address for a subscriber |
| Clicks | Integer | The total number of times the subscriber clicked on the link. |
| CampaignId [KEY] | String | The id for the campaign. |
| UrlId [KEY] | String | The id for the tracked URL in 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. |
| ContactStatus | String | The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. |
| 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. |
Statistics for the top-performing email domains in a campaign.
SELECT is supported for ReportDomainPerformance.
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.
SELECT * FROM ReportDomainPerformance WHERE CampaignId = 'abc'
| 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. |
Get EepURL activity reports.
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.
SELECT * FROM ReportEepUrls; SELECT * FROM ReportEepUrls where CampaignId='1121';
| Name | Type | Description |
| CampaignId | String | The unique id for the campaign. |
| Eepurl | String | The EepURL being tracked. |
| ClicksClicks | Integer | The number of clicks for this EepURL. |
| ClicksFirstClick | Datetime | The date and time of the first click. |
| ClicksLastClick | Datetime | The date and time of the last click. |
| ClicksLocations | String | The locations of the clicks (array). |
| Referrers | String | The referrers for this EepURL (array). |
| TwitterTweets | Integer | The number of tweets for this EepURL. |
| TwitterRetweets | Integer | The number of retweets for this EepURL. |
| TwitterStatuses | String | The statuses for this EepURL (array). |
| TwitterFirstTweet | String | The first tweet for this EepURL. |
| TwitterLastTweet | String | The last tweet for this EepURL. |
A list of member's subscriber activity in a specific campaign.
SELECT is supported for ReportEmailActivity.
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.
SELECT * FROM ReportEmailActivity where CampaignId = '45a'
| 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. |
List of Facebook ad reports in Mailchimp.
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.
SELECT * FROM ReportingFacebookAds; SELECT * FROM ReportingFacebookAds where Id='2';
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the Facebook ad report. |
| AudienceEmailSourceIsSegment | Boolean | Whether the audience email source is a segment. |
| AudienceEmailSourceListName | String | The list name of the audience email source. |
| AudienceEmailSourceName | String | The name of the audience email source. |
| AudienceEmailSourceSegmentType | String | The segment type of the audience email source. |
| AudienceEmailSourceType | String | The type of the audience email source. |
| AudienceIncludeSourceInTarget | Boolean | Whether to include the source in the audience target. |
| AudienceLookalikeCountryCode | String | The lookalike country code for the audience. |
| AudienceSourceType | String | The source type of the audience. |
| AudienceTargetingSpecsGender | Integer | The gender targeting specification for the audience. |
| AudienceTargetingSpecsInterests | String | The interests targeting specification for the audience. |
| AudienceTargetingSpecsLocationsCities | String | The cities location targeting specification for the audience. |
| AudienceTargetingSpecsLocationsCountries | String | The countries location targeting specification for the audience. |
| AudienceTargetingSpecsLocationsRegions | String | The regions location targeting specification for the audience. |
| AudienceTargetingSpecsLocationsZips | String | The zip codes location targeting specification for the audience. |
| AudienceTargetingSpecsMaxAge | Integer | The maximum age targeting specification for the audience. |
| AudienceTargetingSpecsMinAge | Integer | The minimum age targeting specification for the audience. |
| AudienceType | String | The type of the audience. |
| AudienceActivityClicks | String | The number of clicks for the audience activity. |
| AudienceActivityImpressions | String | The number of impressions for the audience activity. |
| AudienceActivityRevenue | String | The revenue for the audience activity. |
| BudgetCurrencyCode | String | The currency code for the budget. |
| BudgetDuration | Integer | The duration of the budget. |
| BudgetTotalAmount | Integer | The total amount of the budget. |
| CanceledAt | Datetime | The date and time the Facebook ad was canceled. |
| ChannelFbPlacementAudience | Boolean | Whether the Facebook ad is placed in the Facebook audience. |
| ChannelFbPlacementFeed | Boolean | Whether the Facebook ad is placed in the Facebook feed. |
| ChannelIgPlacementFeed | Boolean | Whether the Facebook ad is placed in the Instagram feed. |
| CreateTime | Datetime | The date and time the Facebook ad report was created. |
| EmailSourceName | String | The name of the email source. |
| EndTime | Datetime | The end time of the Facebook ad report. |
| HasSegment | Boolean | Whether the Facebook ad report has a segment. |
| Name | String | The name of the Facebook ad report. |
| NeedsAttention | Boolean | Whether the Facebook ad report needs attention. |
| PausedAt | Datetime | The date and time the Facebook ad report was paused. |
| PublishedTime | Datetime | The date and time the Facebook ad report was published. |
| RecipientsListId | String | The list ID for the recipients of the Facebook ad report. |
| RecipientsListIsActive | Boolean | Whether the recipients list is active for the Facebook ad report. |
| RecipientsListName | String | The name of the recipients list for the Facebook ad report. |
| RecipientsRecipientCount | Integer | The recipient count for the Facebook ad report. |
| RecipientsSegmentOptsConditions | String | The segment options conditions for the recipients of the Facebook ad report. |
| RecipientsSegmentOptsMatch | String | The segment options match for the recipients of the Facebook ad report. |
| RecipientsSegmentOptsPrebuiltSegmentId | String | The prebuilt segment ID for the recipients of the Facebook ad report. |
| RecipientsSegmentOptsSavedSegmentId | Integer | The saved segment ID for the recipients of the Facebook ad report. |
| RecipientsSegmentText | String | The segment text for the recipients of the Facebook ad report. |
| ReportSummaryAverageDailyBudgetAmount | Integer | The average daily budget amount in the report summary. |
| ReportSummaryAverageDailyBudgetCurrencyCode | String | The currency code for the average daily budget in the report summary. |
| ReportSummaryAverageOrderAmountAmount | Integer | The average order amount in the report summary. |
| ReportSummaryAverageOrderAmountCurrencyCode | String | The currency code for the average order amount in the report summary. |
| ReportSummaryClickRate | Integer | The click rate in the report summary. |
| ReportSummaryClicks | Integer | The number of clicks in the report summary. |
| ReportSummaryComments | Integer | The number of comments in the report summary. |
| ReportSummaryConversionRate | Integer | The conversion rate in the report summary. |
| ReportSummaryCostPerClickAmount | Integer | The cost per click amount in the report summary. |
| ReportSummaryCostPerClickCurrencyCode | String | The currency code for the cost per click in the report summary. |
| ReportSummaryEcommerceAverageOrderRevenue | Integer | The average order revenue in the ecommerce report summary. |
| ReportSummaryEcommerceCurrencyCode | String | The currency code in the ecommerce report summary. |
| ReportSummaryEcommerceTotalRevenue | Integer | The total revenue in the ecommerce report summary. |
| ReportSummaryEngagements | Integer | The number of engagements in the report summary. |
| ReportSummaryExtendedAtDatetime | String | The extended at datetime in the report summary. |
| ReportSummaryExtendedAtTimezone | String | The extended at timezone in the report summary. |
| ReportSummaryFirstTimeBuyers | Integer | The number of first time buyers in the report summary. |
| ReportSummaryHasExtendedAdDuration | Boolean | Whether the report summary has extended ad duration. |
| ReportSummaryImpressions | Integer | The number of impressions in the report summary. |
| ReportSummaryLikes | Integer | The number of likes in the report summary. |
| ReportSummaryOpenRate | Integer | The open rate in the report summary. |
| ReportSummaryOpens | Integer | The number of opens in the report summary. |
| ReportSummaryProxyExcludedOpenRate | Integer | The proxy excluded open rate in the report summary. |
| ReportSummaryProxyExcludedOpens | Integer | The number of proxy excluded opens in the report summary. |
| ReportSummaryProxyExcludedUniqueOpens | Integer | The number of proxy excluded unique opens in the report summary. |
| ReportSummaryReach | Integer | The reach in the report summary. |
| ReportSummaryReturnOnInvestment | Integer | The return on investment in the report summary. |
| ReportSummaryShares | Integer | The number of shares in the report summary. |
| ReportSummarySubscriberClicks | Integer | The number of subscriber clicks in the report summary. |
| ReportSummarySubscribes | Integer | The number of subscribes in the report summary. |
| ReportSummaryTotalOrders | Integer | The total number of orders in the report summary. |
| ReportSummaryTotalProductsSold | Integer | The total number of products sold in the report summary. |
| ReportSummaryTotalSent | Integer | The total number of sent items in the report summary. |
| ReportSummaryUniqueClicks | Integer | The number of unique clicks in the report summary. |
| ReportSummaryUniqueOpens | Integer | The number of unique opens in the report summary. |
| ReportSummaryUniqueVisits | Integer | The number of unique visits in the report summary. |
| ReportSummaryVisits | Integer | The number of visits in the report summary. |
| ShowReport | Boolean | Whether the Facebook ad report shows a report. |
| StartTime | Datetime | The start time of the Facebook ad report. |
| Status | String | The status of the Facebook ad report. |
| Thumbnail | String | The thumbnail image for the Facebook ad report. |
| Type | String | The type of the Facebook ad report. |
| UpdatedAt | Datetime | The date and time the Facebook ad report was last updated. |
| WasCanceledByFacebook | Boolean | Whether the Facebook ad report was canceled by Facebook. |
| WebId | Integer | The web ID of the Facebook ad report. |
Get reports of your landing pages.
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.
SELECT * FROM ReportingLandingPages; SELECT * FROM ReportingLandingPages where Id='2';
| Name | Type | Description |
| Id | String | The unique identifier for the landing page. |
| Clicks | Integer | Total clicks for the landing page. |
| ConversionRate | Decimal | The conversion rate for the landing page. |
| ListId | String | The unique id for the list. |
| ListName | String | The name of the list. |
| Name | String | The name of the landing page. |
| PublishedAt | Datetime | The time the landing page was published. |
| SignupTags | String | The signup tags for the landing page. |
| Status | String | The status of the landing page. |
| Subscribes | Integer | The number of subscribes for the landing page. |
| TimeseriesDailyStatsClicks | String | Daily statistics for clicks. |
| TimeseriesDailyStatsUniqueVisits | String | Daily statistics for unique visits. |
| TimeseriesDailyStatsVisits | String | Daily statistics for visits. |
| TimeseriesWeeklyStatsClicks | String | Weekly statistics for clicks. |
| TimeseriesWeeklyStatsUniqueVisits | String | Weekly statistics for unique visits. |
| TimeseriesWeeklyStatsVisits | String | Weekly statistics for visits. |
| Title | String | The title of the landing page. |
| UniqueVisits | Integer | The number of unique visits for the landing page. |
| UnpublishedAt | Datetime | The time the landing page was unpublished. |
| Url | String | The URL of the landing page. |
| Visits | Integer | The number of visits for the landing page. |
| WebId | Integer | The web ID of the landing page. |
| EcommerceAverageOrderRevenue | Decimal | The average order revenue for the landing page. |
| EcommerceCurrencyCode | String | The currency code for ecommerce transactions. |
| EcommerceTotalOrders | Integer | The total number of orders for the landing page. |
| EcommerceTotalRevenue | Decimal | The total revenue for the landing page. |
List of answers for a survey question.
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.
SELECT * FROM ReportingSurveyQuestionAnswers; SELECT * FROM ReportingSurveyQuestionAnswers where SurveyId='07328' and QuestionId='123';
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the answer. |
| SurveyId [KEY] | String | The ID of the survey. |
| QuestionId [KEY] | String | The ID of the survey question. |
| ResponseId | String | The ID for the survey response. |
| SubmittedAt | Datetime | The date and time the answer was submitted. |
| Value | String | The answer value. |
| IsNewContact | Boolean | Whether the contact is new. |
| ContactAvatarUrl | String | The contact's avatar URL. |
| ContactConsentsToOneToOneMessaging | Boolean | Whether the contact consents to one-to-one messaging. |
| ContactContactId | String | The contact's ID. |
| ContactEmail | String | The contact's email address. |
| ContactEmailId | String | The contact's email ID. |
| ContactFullName | String | The contact's full name. |
| ContactPhone | String | The contact's phone number. |
| ContactStatus | String | The contact's status.
使用できる値は次のとおりです。Subscribed, Unsubscribed, Non-Subscribed, Cleaned, Archived |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| RespondentFamiliarityIs | String | Filter survey responses by familiarity of the respondents. Possible values: 'new', 'known', or 'unknown' |
Get reports about your survey questions.
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.
SELECT * FROM SurveyQuestions; SELECT * FROM SurveyQuestions where Id='2' and SurveyId='1121';
| Name | Type | Description |
| Id [KEY] | String | The ID of the survey question. |
| SurveyId [KEY] | String | The ID of the survey. |
| Query | String | The question text. |
| Type | String | The type of this question. |
| Options | String | The options for this question. |
| HasOther | Boolean | Whether this question has an 'other' option. |
| OtherLabel | String | The label for the 'other' option. |
| IsRequired | Boolean | Whether this question is required. |
| ContactCountsUnknown | Integer | The total number of unknown contacts who responded to this question. |
| ContactCountsKnown | Integer | The number of known contacts who responded to this question. |
| ContactCountsNew | Integer | The number of new contacts who responded to this question. |
| TotalResponses | Integer | The total number of responses to this question. |
| AverageRating | Decimal | The average rating for this question. |
| MergeFieldId | Integer | The ID for the merge field. |
| MergeFieldLabel | String | The label for the merge field. |
| MergeFieldType | String | The type for the merge field.
使用できる値は次のとおりです。text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip |
| PlaceholderLabel | String | The placeholder label for this question. |
| RangeHighLabel | String | The label for the high end of the range. |
| RangeLowLabel | String | The label for the low end of the range. |
| SubscribeCheckboxEnabled | Boolean | Whether the subscribe checkbox is enabled. |
| SubscribeCheckboxLabel | String | The label for the subscribe checkbox. |
Top open locations for a specific campaign.
SELECT is supported for ReportLocations.
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.
SELECT * FROM ReportLocations where CampaignId = '45a'
| Name | Type | Description |
| CampaignId [KEY] | String | The CampaignId for the table. |
| Region [KEY] | String | A more specific location area such as city or state. |
| Opens | Integer | The number of unique campaign opens for a given region. |
| CountryCode | String | The ISO 3166 2 digit country code. |
| RegionName | String | The name of the region, if we have one. For blank 'region' values, this will be 'Rest of Country'. |
| ProxyExcludedOpens | Integer | The number of unique campaign opens for a region excluding opens from email clients that use proxies. |
Campaign product activity report.
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.
SELECT * FROM ReportProductActivity; SELECT * FROM ReportProductActivity where CampaignId='1121';
| Name | Type | Description |
| CampaignId | String | The unique id for the campaign. |
| CurrencyCode | String | CurrencyCode |
| ImageUrl | String | ImageUrl |
| RecommendationPurchased | Integer | RecommendationPurchased |
| RecommendationTotal | Integer | RecommendationTotal |
| Sku | String | Sku |
| Title | String | Title |
| TotalPurchased | Integer | TotalPurchased |
| TotalRevenue | Integer | TotalRevenue |
A list of reports containing campaigns marked as Sent.
SELECT is supported for Reports.
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.
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'
| 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. |
A list of subscribers who were sent a specific campaign.
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.
SELECT * FROM ReportSentTo where EmailId = '45a' and CampaignId = '458'
| 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. |
Child campaign reports.
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.
SELECT * FROM ReportSubReports; SELECT * FROM ReportSubReports where CampaignId='1121';
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the campaign. |
| CampaignId [KEY] | String | The campaign ID for the child campaign. |
| AbSplitAAbuseReports | Integer | Number of abuse reports for variant A. |
| AbSplitABounces | Integer | Number of bounces for variant A. |
| AbSplitAForwards | Integer | Number of forwards for variant A. |
| AbSplitAForwardsOpens | Integer | Number of opens from forwards for variant A. |
| AbSplitALastOpen | String | Timestamp of the last open for variant A. |
| AbSplitAOpens | Integer | Total number of opens for variant A. |
| AbSplitARecipientClicks | Integer | Number of recipient clicks for variant A. |
| AbSplitAUniqueOpens | Integer | Number of unique opens for variant A. |
| AbSplitAUnsubs | Integer | Number of unsubscribes for variant A. |
| AbSplitBAbuseReports | Integer | Number of abuse reports for variant B. |
| AbSplitBBounces | Integer | Number of bounces for variant B. |
| AbSplitBForwards | Integer | Number of forwards for variant B. |
| AbSplitBForwardsOpens | Integer | Number of opens from forwards for variant B. |
| AbSplitBLastOpen | String | Timestamp of the last open for variant B. |
| AbSplitBOpens | Integer | Total number of opens for variant B. |
| AbSplitBRecipientClicks | Integer | Number of recipient clicks for variant B. |
| AbSplitBUniqueOpens | Integer | Number of unique opens for variant B. |
| AbSplitBUnsubs | Integer | Number of unsubscribes for variant B. |
| CampaignTitle | String | The title of the child campaign. |
| EmailsSent | Integer | The total number of emails sent for the campaign. |
| AbuseReports | Integer | The total number of abuse reports for the campaign. |
| Unsubscribed | Integer | The total number of recipients who unsubscribed from the campaign. |
| BouncesHardBounces | Integer | The total number of hard bounces for the campaign. |
| BouncesSoftBounces | Integer | The total number of soft bounces for the campaign. |
| BouncesSyntaxErrors | Integer | The total number of syntax errors for the campaign. |
| OpensOpensTotal | Integer | The total number of opens for the campaign. |
| OpensUniqueOpens | Integer | The total number of unique opens for the campaign. |
| OpensOpenRate | Decimal | The open rate for the campaign. |
| OpensLastOpen | Datetime | The date and time of the last open for the campaign. |
| OpensProxyExcludedOpens | Integer | The total number of proxy excluded opens for the campaign. |
| OpensProxyExcludedUniqueOpens | Integer | The total number of proxy excluded unique opens for the campaign. |
| OpensProxyExcludedOpenRate | Decimal | The proxy excluded open rate for the campaign. |
| ClicksClicksTotal | Integer | The total number of clicks for the campaign. |
| ClicksUniqueClicks | Integer | The total number of unique clicks for the campaign. |
| ClicksUniqueSubscriberClicks | Integer | The total number of unique subscriber clicks for the campaign. |
| ClicksClickRate | Decimal | The click rate for the campaign. |
| ClicksLastClick | Datetime | The date and time of the last click for the campaign. |
| ForwardsForwardsCount | Integer | The total number of forwards for the campaign. |
| ForwardsForwardsOpens | Integer | The total number of opens from forwards for the campaign. |
| ListId | String | The list ID associated with the campaign. |
| ListName | String | The name of the list associated with the campaign. |
| ListIsActive | Boolean | Whether the list is active. |
| ListStatsSubRate | Decimal | The subscribe rate for the list. |
| ListStatsUnsubRate | Decimal | The unsubscribe rate for the list. |
| ListStatsOpenRate | Decimal | The open rate for the list. |
| ListStatsClickRate | Decimal | The click rate for the list. |
| ListStatsProxyExcludedOpenRate | Decimal | The proxy excluded open rate for the list. |
| DeliveryStatusEnabled | Boolean | Whether delivery status is enabled for the campaign. |
| DeliveryStatusCanCancel | Boolean | Whether the campaign delivery can be canceled. |
| DeliveryStatusEmailsSent | Integer | The number of emails sent for the campaign delivery status. |
| DeliveryStatusEmailsCanceled | Integer | The number of emails canceled for the campaign delivery status. |
| DeliveryStatusStatus | String | The status of the campaign delivery. |
| FacebookLikesFacebookLikes | Integer | The number of Facebook likes for the campaign. |
| FacebookLikesRecipientLikes | Integer | The number of recipient Facebook likes for the campaign. |
| FacebookLikesUniqueLikes | Integer | The number of unique Facebook likes for the campaign. |
| EcommerceCurrencyCode | String | The currency code for ecommerce transactions in the campaign. |
| EcommerceTotalOrders | Integer | The total number of ecommerce orders for the campaign. |
| EcommerceTotalRevenue | Decimal | The total revenue from ecommerce orders for the campaign. |
| EcommerceTotalSpent | Decimal | The total amount spent in ecommerce orders for the campaign. |
| IndustryStatsType | String | The industry type for the campaign. |
| IndustryStatsOpenRate | Decimal | The open rate for the campaign's industry. |
| IndustryStatsClickRate | Decimal | The click rate for the campaign's industry. |
| IndustryStatsBounceRate | Decimal | The bounce rate for the campaign's industry. |
| IndustryStatsAbuseRate | Decimal | The abuse rate for the campaign's industry. |
| IndustryStatsUnsubRate | Decimal | The unsubscribe rate for the campaign's industry. |
| IndustryStatsUnopenRate | Decimal | The unopen rate for the campaign's industry. |
| PreviewText | String | The preview text for the campaign. |
| SendTime | Datetime | The date and time the campaign was sent. |
| SubjectLine | String | The subject line of the campaign. |
| Timeseries | String | Timeseries data for the campaign. |
| Type | String | The type of the campaign. |
| RssLastSend | Datetime | The date and time of the last RSS send for the campaign. |
| ShareReportShareUrl | String | The shareable URL for the campaign report. |
| ShareReportSharePassword | String | The password for the shared campaign report. |
| Timewarp | String | The timewarp setting for the campaign. |
A list of members who have unsubscribed from a specific campaign.
SELECT is supported for ReportUnsubscribes.
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.
SELECT * FROM ReportUnsubscribes where EmailId = '45a' and CampaignId = '458'
| Name | Type | Description |
| EmailId [KEY] | String | The list-specific ID for the given email address |
| EmailAddress | String | Email address for a subscriber |
| Timestamp | Datetime | The date and time the member opted-out. |
| Reason | String | If available, the reason listed by the member for unsubscribing. |
| 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. |
List of survey responses.
SELECT is supported for SurveyResponses.
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.
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'
| Name | Type | Description |
| Id [KEY] | String | The ID for the survey response. |
| SubmittedAt | Datetime | The date and time when the survey response was submitted. |
| ContactEmailId | String | The MD5 hash of the lowercase version of the list member email address. |
| ContactId | String | The ID of this contact. |
| ContactStatus | String | The contact's current status. |
| ContactEmail | String | The contact's email address. |
| ContactFullName | String | The contact's full name. |
| ContactConsentsToOneToOneMessaging | Boolean | Indicates whether a contact consents to 1:1 messaging. |
| ContactAvatarUrl | String | URL for the contact's avatar or profile image. |
| IsNewContact | Boolean | If this contact was added to the Mailchimp audience via this survey. |
| SurveyId [KEY] | String | A string that uniquely identifies this survey. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| AnsweredQuestion | Integer | The ID of the question that was answered. |
| ChoseAnswer | String | The ID of the option chosen to filter responses on. |
| RespondentFamiliarityIs | String | Filter survey responses by familiarity of the respondents. Possible values: 'new', 'known', or 'unknown' |
Get reports for surveys.
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.
SELECT * FROM Surveys WHERE Id = '1245'
| Name | Type | Description |
| Id [KEY] | String | A string that uniquely identifies this survey. |
| WebId | Integer | The ID used in the Mailchimp web application. |
| ListId | String | The ID of the list connected to this survey. |
| ListName | String | The name of the list connected to this survey. |
| Title | String | The title of the survey. |
| Url | String | The URL for the survey. |
| Status | String | The status of the Surney. Possible values: published or unpublished. |
| PublishedAt | Datetime | The date and time the survey was published. |
| CreatedAt | Datetime | The date and time the survey was created. |
| UpdatedAt | Datetime | The date and time the survey was last updated. |
| TotalResponses | Integer | The total number of responses to this survey. |
Get Transactional Scheduled Emails.
Only SELECT is supported for TransactionalScheduledEmails.
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.
SELECT * FROM TransactionalScheduledEmails WHERE To = '[email protected]'
| 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. |
Get Transactional Senders.
Only SELECT is supported for TransactionalSenders.
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.
SELECT * FROM TransactionalSenders WHERE Address = '[email protected]'
| 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. |
Get Transactional user info.
Only SELECT is supported for TransactionalUserInfos.
There are filters supported server side for this view. This view will provide the details of current user.
SELECT * FROM TransactionalUserInfos
| 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. |
List of sending domains configured in Mailchimp.
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.
SELECT * FROM VerifiedDomains; SELECT * FROM VerifiedDomains where Domain='abc.com';
| Name | Type | Description |
| Domain [KEY] | String | The domain name. |
| Authenticated | Boolean | Whether the domain is authenticated to send email. |
| IsFreeEmailProvider | Boolean | Whether the domain is a free email provider. |
| Status | String | The status of the domain.
使用できる値は次のとおりです。VERIFICATION_IN_PROGRESS, VERIFIED, EXPIRED, ERROR, AUTHENTICATION_IN_PROGRESS, AUTHENTICATION_ERROR, AUTHENTICATED |
| VerificationEmail | String | The email address used for verification. |
| VerificationSent | Datetime | The date and time the verification email was sent. |
| Verified | Boolean | Whether the domain is verified. |
ストアドプロシージャはファンクションライクなインターフェースで、Mailchimp の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMailchimp から関連するレスポンスデータを返します。
| Name | Description |
| AddOrRemoveMemberTags | Adds or removes tags from a list member. If a tag that does not exist is provided and marked as 'active', a new tag is created. |
| AddSubscriberToWorkflowEmail | Manually add a subscriber to a workflow, bypassing the default trigger settings. |
| CampaignCancel | Cancels a MailChimp Regular or Plain-Text campaign . |
| CampaignPause | Pauses a MailChimp RSS campaign. |
| CampaignResume | Resumes a MailChimp RSS campaign. |
| CampaignSchedule | Schedules a MailChimp campaign. Either Timewarp or the batch properties can be used, not both. |
| CampaignSend | Sends a MailChimp campaign. |
| CampaignTest | Sends a test email for a MailChimp campaign. |
| CampaignUnschedule | Unschedules a MailChimp campaign. |
| DeleteECommerceCarts | Deletes the ECommerceCart. |
| RemoveSubscriberFromWorkflow | Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've sent from that workflow. Once you remove a subscriber, you cannot add them back to the same workflow. |
| TransactionalCancelScheduledEmail | Cancel a scheduled email. |
| TransactionalRescheduledEmail | Reschedule a scheduled email. |
| TransactionalSendMessage | Send a new transactional message through the Transactional API. |
| TransactionalSendTemplate | Send a new transactional message through the Transactional API using a template. |
| UpdateECommerceCarts | Update the ECommerceCart. To update lines in ECommerceCarts, use UPDATE in the ECommerceCartLines table. |
| ViewTemplatesDefaultContent | Get the sections that you can edit in a template, including each section's default content. |
Adds or removes tags from a list member. If a tag that does not exist is provided and marked as 'active', a new tag is created.
Tags can be provided either as a directly specified array or via a 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';
exec AddOrRemoveMemberTags TagsAggregate = '[{"name": "TestName11","status": "inactive"},{"name": "TestName7","status": "active"}]', listid = '123', MemberId = 'test';
| Name | Type | Required | Description |
| ListId | String | True | The unique ID for the list. |
| MemberId | String | True | The MD5 hash of the lowercase version of the list member's email address. |
| TagsAggregate | String | True | A list of tags assigned to the list member. |
| IsSyncing | String | False | When is_syncing is true, automations based on the tags in the request will not fire. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Manually add a subscriber to a workflow, bypassing the default trigger settings.
| Name | Type | Required | Description |
| WorkflowId | String | True | The Workflow ID of the automation. |
| EmailId | String | True | The ID of the email used in automation. |
| EmailAddress | String | True | The email address to add in automation. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Cancels a MailChimp Regular or Plain-Text campaign .
| Name | Type | Required | Description |
| CampaignID | String | True | The ID of the campaign to cancel. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Pauses a MailChimp RSS campaign.
| Name | Type | Required | Description |
| CampaignID | String | True | The ID of the campaign to pause. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Resumes a MailChimp RSS campaign.
| Name | Type | Required | Description |
| CampaignID | String | True | The ID of the campaign to resume. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Schedules a MailChimp campaign. Either Timewarp or the batch properties can be used, not both.
| Name | Type | Required | Description |
| CampaignID | String | True | The ID of the campaign to schedule. |
| ScheduleTime | String | True | The local date and time to schedule the campaign for delivery. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45). |
| Timewarp | String | False | Boolean determining whether the campaign should use Timewarp when sending.
デフォルト値はfalseです。 |
| BatchCount | String | False | The number of batches to send. |
| BatchDelay | String | False | The delay, in minutes, between batches |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Sends a MailChimp campaign.
| Name | Type | Required | Description |
| CampaignID | String | True | The ID of the campaign to send. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Sends a test email for a MailChimp campaign.
| Name | Type | Required | Description |
| CampaignID | String | True | The ID of the campaign to test. |
| TestEmails | String | True | A comma-separated list of emails to send. |
| SendType | String | True | The type of test email to send. Either html or plaintext
使用できる値は次のとおりです。html, plaintext デフォルト値はhtmlです。 |
| Name | Type | Description |
| Success | String | Whether the test was successful. |
Unschedules a MailChimp campaign.
| Name | Type | Required | Description |
| CampaignID | String | True | The ID of the campaign to unschedule. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Deletes the ECommerceCart.
| Name | Type | Required | Description |
| StoreId | String | True | The StoreId for the table. |
| Id | String | True | A unique identifier for the cart. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've sent from that workflow. Once you remove a subscriber, you cannot add them back to the same workflow.
| Name | Type | Required | Description |
| WorkflowId | String | True | The Workflow ID of the automation. |
| EmailAddress | String | True | The email address of the automation. |
| Name | Type | Description |
| Success | String | Whether the operation was successful. |
Cancel a scheduled email.
Id input is required. For example:
exec TransactionalCancelScheduledEmail Id = '515abc'
| Name | Type | Required | Description |
| Id | String | True | A scheduled email Id, as returned by any of the TransactionalSendMessage stored procedures or TransactionalScheduledEmails views. |
| Name | Type | Description |
| Success | String | Indicates 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 is sent. |
| FromEmail | String | The sending status of the recipient. |
| To | String | The email's sender address. |
| Subject | String | The email's subject. |
Reschedule a scheduled email.
Id and SendAt inputs are required. For example:
exec TransactionalRescheduledEmail Id = '515abc', SendAt = '2025-08-01T10:10:10.23'
| 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. |
| 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. |
Send a new transactional message through the Transactional API.
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]'
| Name | Type | Required | Description |
| Html | String | False | The full HTML content to be sent. |
| Text | String | False | The optional full text content to be sent. |
| Subject | String | False | The message subject. |
| FromEmail | String | False | The sender's email address. |
| FromName | String | False | The optional from name to be used. |
| To | String | False | An array of recipient information. |
| ToEmails | String | False | A comma-separated list of email addresses for type 'to'. |
| ToNames | String | False | A comma-separated list of names for type 'to'. |
| CcEmails | String | False | A comma-separated list of email addresses for type 'cc'. |
| CcNames | String | False | A comma-separated list of names for type 'cc'. |
| BccEmails | String | False | A comma-separated list of email addresses for type 'bcc'. |
| BccNames | String | False | A comma-separated list of names for type 'bcc'. |
| Headers | String | False | The optional extra headers to add to the message. |
| Important | Boolean | False | Indicates whether this message is important and should be delivered ahead of non-important messages. |
| TrackOpens | Boolean | False | Indicates whether to turn on open tracking for the message. |
| TrackClicks | Boolean | False | Indicates whether to turn on click tracking for the message. |
| AutoText | Boolean | False | Indicates whether to automatically generate a text part for messages that are not given text. |
| AutoHtml | Boolean | False | Indicates whether to automatically generate an HTML part for messages that are not given HTML. |
| InlineCss | Boolean | False | Indicates whether to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size. |
| UrlStripQs | Boolean | False | Indicates whether to strip the query string from URLs when aggregating tracked URL data. |
| PreserveRecipients | Boolean | False | Indicates whether 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 | Indicates 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.
使用できる値は次のとおりです。mailchimp, handlebars |
| GlobalMergeVars | String | False | The global merge variables to use for all recipients. |
| MergeVars | String | False | The 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. The message must already exist. |
| GoogleAnalyticsDomains | String | False | An array of strings indicating which matching URLs have Google Analytics parameters appended to their query string automatically. |
| GoogleAnalyticsCampaign | String | False | An optional string indicating the value to set for the utm_campaign tracking parameter. |
| Metadata | String | False | An associative array of user metadata. |
| RecipientMetadata | String | False | The per-recipient metadata that overrides the global values specified in the metadata parameter. |
| Attachments | String | False | An array of supported attachments to add to the message. |
| AttachmentLocations | String | False | The comma-separated values of file location of attachments. |
| AttachmentName | String | False | The 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 | The comma-separated values of file location of images. |
| ImageName | String | False | The name of the image for which the content is sent in ImageContent. |
| Async | Boolean | False | Enables 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. |
| Name | Type | Description |
| Success | String | Indicates whether the operation was successful. |
| Id | String | The message's unique Id. |
| 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. |
Send a new transactional message through the Transactional API using a template.
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]'
| 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 | The optional full text content to be sent. |
| Subject | String | False | The message subject. |
| FromEmail | String | False | The sender email address. |
| FromName | String | False | The optional from name to be used. |
| To | String | False | An array of recipient information. |
| ToEmails | String | False | The comma-separated list of emails for type 'to'. |
| ToNames | String | False | The comma-separated list of names for type 'to'. |
| CcEmails | String | False | The comma-separated list of emails for type 'cc'. |
| CcNames | String | False | The comma-separated list of names for type 'cc'. |
| BccEmails | String | False | The comma-separated list of emails for type 'bcc'. |
| BccNames | String | False | The comma-separated list of names for type 'bcc'. |
| Headers | String | False | The optional extra headers to add to the message. |
| Important | Boolean | False | Indicates whether this message is important, and should be delivered ahead of non-important messages. |
| TrackOpens | Boolean | False | Indicates whether to turn on open tracking for the message. |
| TrackClicks | Boolean | False | Indicates whether to turn on click tracking for the message. |
| AutoText | Boolean | False | Indicates whether to automatically generate a text part for messages that are not given text. |
| AutoHtml | Boolean | False | Indicates whether to automatically generate an HTML part for messages that are not given HTML. |
| InlineCss | Boolean | False | Indicates whether to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size. |
| UrlStripQs | Boolean | False | Indicates whether to strip the query string from URLs when aggregating tracked URL data. |
| PreserveRecipients | Boolean | False | Indicates whether 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 | Indicates 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.
使用できる値は次のとおりです。mailchimp, handlebars |
| GlobalMergeVars | String | False | The global merge variables to use for all recipients. |
| MergeVars | String | False | The 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. The subaccount must already exist or the stored procedure will fail. |
| GoogleAnalyticsDomains | String | False | An array of strings indicating which matching URLs have Google Analytics parameters appended to their query string automatically. |
| GoogleAnalyticsCampaign | String | False | An optional string indicating the value to set for the utm_campaign tracking parameter. |
| Metadata | String | False | An associative array of user metadata. |
| RecipientMetadata | String | False | The per-recipient metadata that overrides the global values specified in the metadata parameter. |
| Attachments | String | False | An array of supported attachments to add to the message. |
| AttachmentLocations | String | False | The comma-separated values of file location of attachments. |
| AttachmentName | String | False | The 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 | The comma-separated values of file location of images. |
| ImageName | String | False | The 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. |
| Name | Type | Description |
| Success | String | Indicates whether the operation was successful. |
| Id | String | The message's unique Id. |
| 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. |
Update the ECommerceCart. To update lines in ECommerceCarts, use UPDATE in the ECommerceCartLines table.
| Name | Type | Required | Description |
| StoreId | String | True | The StoreId for the table. |
| Id | String | True | A unique identifier for the cart. |
| Customer | String | False | Information about a specific customer. Carts for existing customers should include only the Id parameter in the customer object body. |
| CampaignId | String | False | A string that uniquely identifies the campaign associated with a cart. |
| CheckoutUrl | String | False | The URL for the cart. |
| CurrencyCode | String | False | The three-letter ISO 4217 code for the currency that the cart uses. |
| OrderTotal | Decimal | False | The order total for the cart. |
| TaxTotal | Decimal | False | The total tax for the cart. |
| Name | Type | Description |
| Success | String | Indicates whether the operation was successful. |
| Id | String | The Id of the cart. |
| StoreId | String | The Id of the store. |
| Customer | String | Information about a specific customer. Carts for existing customers should include only the Id parameter in the customer object body. |
| CampaignId | String | A string that uniquely identifies the campaign associated with a cart. |
| CheckoutUrl | String | The URL for the cart. |
| CurrencyCode | String | The three-letter ISO 4217 code for the currency that the cart uses. |
| OrderTotal | Decimal | The order total for the cart. |
| TaxTotal | Decimal | The total tax for the cart. |
Get the sections that you can edit in a template, including each section's default content.
| Name | Type | Required | Description |
| TemplateId | String | True | The unique id for the template. |
| Name | Type | Description |
| * | String | All the output mentioned in the response. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Mailchimp のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類(テーブルまたはビュー)。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Lists テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Lists'
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | カラムを含むテーブルまたはビューの名前。 |
| ColumnName | String | カラム名。 |
| DataTypeName | String | データ型の名前。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| Length | Int32 | カラムのストレージサイズ。 |
| DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
| NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
| IsNullable | Boolean | カラムがNull を含められるかどうか。 |
| Description | String | カラムの簡単な説明。 |
| Ordinal | Int32 | カラムのシーケンスナンバー。 |
| IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
| IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
| IsHidden | Boolean | カラムが非表示かどうか。 |
| IsArray | Boolean | カラムが配列かどうか。 |
| IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
| IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
| ColumnType | String | スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、GetOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2
パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
| SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
| ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
| ColumnName | String | ストアドプロシージャパラメータの名前。 |
| Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| DataTypeName | String | データ型の名前。 |
| NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
| NumericScale | Int32 | 数値データの小数点以下の桁数。 |
| IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
| IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
| IsArray | Boolean | パラメータが配列かどうか。 |
| Description | String | パラメータの説明。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| Values | String | このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。 |
| SupportsStreams | Boolean | パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。 |
| IsPath | Boolean | パラメータがスキーマ作成操作のターゲットパスかどうか。 |
| Default | String | 何も値が指定されていない場合に、このパラメータで使用される値。 |
| SpecificName | String | 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。 |
| IsCDataProvided | Boolean | プロシージャがネイティブのMailchimp プロシージャではなく、CData によって追加 / 実装されているかどうか。 |
| Name | Type | Description |
| IncludeResultColumns | Boolean | 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。 |
主キーおよび外部キーについて説明します。
次のクエリは、Lists テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Lists'
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
| IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| 名前 | タイプ | 説明 |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
| ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | インデックスを含むデータベースの名前。 |
| SchemaName | String | インデックスを含むスキーマの名前。 |
| TableName | String | インデックスを含むテーブルの名前。 |
| IndexName | String | インデックス名。 |
| ColumnName | String | インデックスに関連付けられたカラムの名前。 |
| IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
| IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
| Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
| SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
| OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | 接続プロパティ名。 |
| ShortDescription | String | 簡単な説明。 |
| Type | String | 接続プロパティのデータ型。 |
| Default | String | 明示的に設定されていない場合のデフォルト値。 |
| Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
| Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
| Required | Boolean | プロパティが接続に必要かどうか。 |
| Category | String | 接続プロパティのカテゴリ。 |
| IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
| Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
| PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
| Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
| Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
| ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
| SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
| SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| 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 | サポートされている数値関数。 | 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 | サポートされている日付および時刻関数。 | 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 | レプリケーション中にスキップされたテーブルを示します。 | |
| REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
| IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
| SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
| DIALECT | 使用するSQL ダイアレクトを示します。 | |
| KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
| SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | 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 | 使用したいcacheOptions を指定する文字列値。 | |
| ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
| PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
| MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
| REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
| REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
| REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
| CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | 製品名。 |
| Version | String | 製品のバージョン番号。 |
| Datasource | String | 製品が接続するデータソースの名前。 |
| NodeId | String | 製品がインストールされているマシンの固有識別子。 |
| HelpURL | String | 製品のヘルプドキュメントのURL。 |
| License | String | 製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。) |
| Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
| Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
| DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
| DataSyncCategory | String | CData Sync 機能のカテゴリ(例:Source、Destination)。 |
| プロパティ | 説明 |
| AuthScheme | MailChimp への接続時にAPIKey 認証またはOAuth 認証のどちらを使用するか。 |
| APIKey | MailChimp アカウントへのアクセスに使用されるAPI キー。 |
| プロパティ | 説明 |
| IncludeCustomFields | Set whether to include custom fields that are added to the ListMembers view. This defaults to true. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Pagesize | provider がMailchimp にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | MailChimp への接続時にAPIKey 認証またはOAuth 認証のどちらを使用するか。 |
| APIKey | MailChimp アカウントへのアクセスに使用されるAPI キー。 |
MailChimp への接続時にAPIKey 認証またはOAuth 認証のどちらを使用するか。
string
"APIKey"
MailChimp アカウントへのアクセスに使用されるAPI キー。
string
""
MailChimp アカウントへのアクセスに使用されるAPI キー。API キーは、MailChimp で[Account]->[Extras]->[API Keys]をクリックすると見つけることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeCustomFields | Set whether to include custom fields that are added to the ListMembers view. This defaults to true. |
Set whether to include custom fields that are added to the ListMembers view. This defaults to true.
bool
true
Set whether to include custom fields that are added to the ListMembers view. This defaults to true.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
string
""
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
string
""
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint(hex 値はスペースまたはコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Pagesize | provider がMailchimp にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
int
-1
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
provider がMailchimp にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
int
1000
クエリを処理する際、Mailchimp でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。
この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。
Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
int
60
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
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
All rights reserved.
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.