Mailchimp Data Model

Connection String Options

  1. API Key
  2. Auto Cache
  3. Cache Connection
  4. Cache Driver
  5. Cache Location
  6. Cache Metadata
  7. Callback URL
  8. Connect On Open
  9. Datacenter
  10. Firewall Password
  11. Firewall Port
  12. Firewall Server
  13. Firewall Type
  14. Firewall User
  15. Initiate OAuth
  16. Location
  17. Logfile
  18. Max Log File Size
  19. OAuth Access Token
  20. OAuth Client Id
  21. OAuth Client Secret
  22. OAuth Settings Location
  23. Offline
  24. Other
  25. Proxy Auth Scheme
  26. Proxy Auto Detect
  27. Proxy Password
  28. Proxy Port
  29. Proxy Server
  30. Proxy SSL Type
  31. Proxy User
  32. Pseudo Columns
  33. Query Cache
  34. Readonly
  35. RTK
  36. SSL Server Cert
  37. Support Enhanced SQL
  38. Tables
  39. Timeout
  40. Verbosity

API Key

Data Type

string

Default Value

""

Remarks

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

 

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically caches the results of SELECT queries to a cache specified by the CacheLocation option. CacheLocation defines the path to a simple, file-based cache.

AutoCache is the simplest caching configuration available, however, like any caching scheme, using a cache is not without pitfalls such as reporting on stale data. The driver is designed to be fully functional without relying on caching.

The following sections outline how and when to use AutoCache. Understanding how AutoCache works and its limitations will help you choose an effective caching strategy. For more information on deploying other caching strategies, see Caching Data.

How AutoCaching Works

 

When you execute a SELECT statement with AutoCache set, the driver executes the query to the remote data and persists the results; rows and columns that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it.

Non-queries (such as UPDATE/INSERT/DELETE statements) are executed to the remote data as well; these statements will not modify the data in the cache at all, regardless of the value set for AutoCache.

To work with the local data, append #CACHE to the table name. For example:

SELECT * FROM [Lists#CACHE]
Limitations of AutoCache

 

In the following scenarios, consider the alternatives listed below:

  • When you need to work with the cache transparently: Because AutoCache requires a special syntax to utilize the cache, it is not suitable for use with BI, analytics, and reporting. Many of these tools generate SQL statements for you; these generated statements will still be executed to MailChimp instead of the cache.

    In these situations, one solution is to use the Offline property. When this is set, all queries are executed locally. See Caching: Best Practices for examples.

    One downside of this approach is that it requires a separate connection. As an alternative, consider using the CData Sync tool to maintain a local database that is kept fresh with scheduled updates.

     

  • When you need more control over cached data: The AutoCache feature does not have the ability to remove rows from the cache that were deleted from the remote data. It also does not support dropping a table from the cache or more advanced cache maintenance such as changing the cached table schemas.

    In this scenario, consider CACHE Statements. CACHE statements can remove cached rows that no longer exist in MailChimp.

    See Caching Explicitly for more information on how to use CACHE statements.

  • When you need to work with an RDBMS: AutoCache can only be used with the default database, JavaDB or SQLite. Many enterprises will need to use an RDBMS to support more concurrent writes or integrate with existing infrastructure. You can specify a database driver with CacheConnection and CacheDriver.

 

 

Cache Connection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheConnection defines the connection properties necessary to connect to the cache database.

Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost:7437;user=sa;password=123456;databaseName=Cache'

 

 

 

Cache Driver

Data Type

string

Default Value

""

Remarks

You can cache to any database that you have a JDBC driver for. The driver has been tested with SQL Server, Derby and Java DB, MySQL, Oracle, and SQLite.

The cache database is determined based on CacheDriver and the CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data. The example below caches to SQL Server:

Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost:7437;user=sa;password=123456;databaseName=Cache'
Note that the driver JAR must be specified on the classpath.

 

 

Cache Location

Data Type

string

Default Value

""

Remarks

If AutoCache is set but the cache location is not specified, CacheLocation defaults to the cache folder on the directory specified by the Location setting.

The CacheLocation is a simple, file-based cache. See the CacheConnection and CacheDriver properties to cache to other databases.

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

The cache.db file will be created in the location specified by the CacheConnection or if that is not set, the CacheLocation.

 

Callback URL

Data Type

string

Default Value

""

Remarks

This value is the URL that MailChimp redirects to during the authentication process.

 

Connect On Open

Data Type

bool

Default Value

true

Remarks

When set to 'true', a connection will be made to MailChimp when the connection is opened. This property enables the 'Test Connection' feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to MailChimp and nothing from this initial connection is maintained.

Setting this property to 'false' may provide performance improvements (depending upon the number of times a connection is opened).

 

Datacenter

Data Type

string

Default Value

""

Remarks

The datacenter used for your MailChimp account. This value can be found in the URL when logging into MailChimp in the browser.

 

Firewall Password

Data Type

string

Default Value

""

Remarks

If FirewallServer is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall.

 

Firewall Port

Data Type

string

Default Value

""

Remarks

Note that the driver sets the FirewallPort to the default port associated with the specified FirewallType. See the description of the FirewallType option for details.

 

Firewall Server

Data Type

string

Default Value

""

Remarks

If this property is set to a domain name, a DNS request is initiated and the name is translated to the corresponding IP address.

 

Firewall Type

Data Type

string

Default Value

"NONE"

Remarks

The applicable values are:

 

   
Firewall Type Default FirewallPort
TUNNEL 80
SOCKS4 1080
SOCKS5 1080

 

 

Firewall User

Data Type

string

Default Value

""

Remarks

If the FirewallServer is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate against the firewall.

 

Initiate OAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

 

 

Location

Data Type

string

Default Value

""

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files used in your application must be deployed with other assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

""

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. There is no limit by default. Values lower than 100kB will use 100kB as the value instead.

 

OAuth Access Token

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Client Id

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration, you will receive a client Id, sometimes also called a consumer key, and a client secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth Client Secret

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration you will receive a client Id and a client secret, sometimes also called a consumer secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth Settings Location

Data Type

string

Default Value

"%APPDATA%\\CData\\MailChimp Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to TRUE, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

 

Other

Data Type

string

Default Value

""

Remarks

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

Caching Configuration

 

   
CachePartial=True Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True Passes the specified query to the cache database instead of using the SQL parser of the driver.

 

Integration and Formatting

 

   
SupportAccessLinkedMode In Access' linked mode, it is generally a good idea to always use a cache as most data sources do not support multiple Id queries. However if you want to use the driver in Access but not in linked mode, this property must be set to False to avoid using a cache of a SELECT * query for the given table.
ConvertDateTimesToGMT Whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.
ClientCulture This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
Culture This setting can be used to specify culture settings that determine how the driver interprets certain data types that are passed into the driver. For example, setting Culture='de-DE' will output German formats even on an American machine.

 

 

Proxy Auth Scheme

Data Type

string

Default Value

"BASIC"

Remarks

This value may be BASIC, DIGEST, NONE, NTLM, NEGOTIATE or PROPRIETARY.

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

This indicates whether to use the default system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.

 

Proxy Password

Data Type

string

Default Value

""

Remarks

If the ProxyServer is specified, the ProxyUser and ProxyPassword properties are used to connect and authenticate against the firewall.

 

Proxy Port

Data Type

string

Default Value

"80"

Remarks

See the description of the ProxyServer field for details.

 

Proxy Server

Data Type

string

Default Value

""

Remarks

If this property is set to a domain name, a DNS request is initiated and the name is translated to the corresponding address.

 

Proxy SSL Type

Data Type

string

Default Value

"AUTO"

Remarks

This value may be AUTO, ALWAYS, NEVER, or TUNNEL.

 

Proxy User

Data Type

string

Default Value

""

Remarks

If a ProxyServer is specified, the ProxyUser and ProxyPassword options are used to connect and authenticate against the firewall.

 

Pseudo Columns

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; i.e., "*=*".

 

Query Cache

Data Type

string

Default Value

""

Remarks

The QueryCache allows you to cache the results of a query in-memory and use them until the cache expires. Setting the QueryCache can improve performance if the same or similar (see below) queries are executed often. The in-memory query cache is shared across connections, so it can help with performance even if more than one connection is being used.

The cache manager for QueryCache will not only use the results in the cache for exactly the same query, but also for queries that represent a subset of data in the cached query. For example, in the following queries, the cache created while executing Query A will be used to obtain the results for both Query B and Query C.

SELECT * from Account; // Query A
SELECT * from Account WHERE Name LIKE '%John'; // Query B
SELECT Id, Name from from Account LIMIT 10; // Query C

 

Setting the QueryCache to zero disables in-memory caching.

 

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

 

RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

SSL Server Cert

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected. This can take the form of a full PEM certificate, the path to a file containing the certificate, the public key, the MD5 thumbprint, or the SHA1 thumbprint. If not specified, any trusted certificate will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

Use QueryCache to cache in memory for a given time in seconds or to disable in-memory caching.

 

Tables

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

 

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the HTTP requests.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.




 

Tables

  1. AuthorizedApps
  2. AutomationEmailQueues
  3. AutomationsRemovedSubscribers
  4. CampaignFeedback
  5. CampaignFolders
  6. Campaigns
  7. ConversationMessages
  8. EcommerceCartLines
  9. EcommerceCarts
  10. EcommerceCustomers
  11. EcommerceOrderLines
  12. EcommerceOrders
  13. EcommerceProducts
  14. EcommerceProductVariants
  15. EcommerceStores
  16. FileManagerFiles
  17. FileManagerFolders
  18. ListInterestCategories
  19. ListInterests
  20. ListMemberNotes
  21. ListMembers
  22. ListMergeFields
  23. Lists
  24. ListSegmentMembers
  25. ListSegments
  26. ListsTwitterLeadGenCards
  27. ListsWebhooks
  28. TemplateFolders
  29. Templates

AuthorizedApps

A list of applications authorized to access the account.

 

Table Specific Information

 

SELECT and INSERT are supported for AuthorizedApps.

Insert

 

There are no required fields when INSERTing.

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String False

The Id for this application integration.

Name String False

The name of the application.

Description String False

The description for the application.

Users String False

An array of usernames of the users who have linked this app.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

AutomationEmailQueues

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

 

Table Specific Information

 

SELECT and INSERT are supported for AutomationEmailQueues.

Select

 

A WorkflowId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Insert

 

The WorkflowId, EmailId, and EmailAddress are required for INSERTs.

INSERT INTO AutomationEmailQueues (WorkflowId, EmailId, EmailAddress) VALUES ('myWorkflowId', 'myEmailId', 'myEmailAddress')
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The MD5 hash of the lowercase version of the list member's email address.

WorkflowId [KEY] String True

A string that uniquely identifies an automation workflow.

EmailId [KEY] String True

A string that uniquely identifies an email in an automation workflow.

ListId [KEY] String True

A string that uniquely identifies a list.

EmailAddress String False

Email Address

NextSend String True

Next Send

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

AutomationsRemovedSubscribers

A summary of the subscribers removed from an automation workflow.

 

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The MD5 hash of the lowercase version of the list member's email address.

WorkflowId [KEY] String True

A string that uniquely identifies an automation workflow.

ListId [KEY] String True

A string that uniquely identifies a list.

EmailAddress String False

Email Address

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

CampaignFeedback

A summary of the comment feedback for a specific campaign.

 

Table Specific Information

 

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

Select

 

A CampaignId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Insert

 

The CampaignId and Message are required for INSERTs.

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

 

 

 

   
Name Type ReadOnly Description
FeedbackId [KEY] Integer True

The individual id for the feedback item.

ParentId [KEY] Integer True

If a reply, the id of the parent feedback item.

BlockId [KEY] 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 String True

The date and time the feedback item was created.

UpdatedAt String 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 True

The unique id for the campaign.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

CampaignFolders

Folders for organizing campaigns

 

Columns

 

 

 

   
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

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

Campaigns

A summary of the campaigns within an account.

 

Table Specific Information

 

SELECT and DELETE are supported for Campaigns.

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

A string that uniquely identifies this campaign.

Type String True

The type of campaign (regular, plaintext, absplit, or rss).

CreateTime String 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 String True

The time and date a campaign was sent.

ContentType String True

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_Highrise String False

Highrise tracking options for a campaign. Must be using MailChimp's built-in Highrise 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 String False

The send time for Group A.

AbSplitOpts_SendTimeB String False

The send time for Group B.

AbSplitOpts_SendTimeWinner String 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ConversationMessages

Messages from a specific conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account.

 

Table Specific Information

 

SELECT and INSERT are supported for ConversationMessages.

Select

 

A ConversationId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Insert

 

The ConversationId, FromEmail, and Read are required for INSERTs.

INSERT INTO ConversationMessages (ConversationId, FromEmail, and Read) VALUES ('myConversationId', 'myFromEmail', 'true')
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

A string that uniquely identifies this message

ConversationId [KEY] String True

A string that identifies this message's conversation

ListId [KEY] Integer True

The unique identifier of the list this conversation is associated with

FromLabel String True

A label representing the sender of this message

FromEmail String False

A label representing the email of the sender of this message

Subject String False

The subject of this message

Message String False

The plain-text content of the message

Read Boolean False

Whether or not this message has been marked as read

Timestamp String True

Date the message was either sent or received

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

EcommerceCartLines

A list of an ecommerce cart's lines.

 

Columns

 

 

 

   
Name Type ReadOnly Description
StoreId [KEY] String True

The StoreId for the table.

CartId [KEY] String True

The CartId for the table.

Id [KEY] String False

A unique identifier for the cart line item.

ProductId [KEY] 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 [KEY] 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 Double False

The price of a cart line item.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

EcommerceCarts

A list of an account's ecommerce carts.

 

Columns

 

 

 

   
Name Type ReadOnly Description
StoreId [KEY] String True

The StoreId for the table.

Id [KEY] 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 [KEY] 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 Double False

The order total for the cart.

TaxTotal Double False

The total tax for the cart.

Lines String False

An array of the cart's line items.

CreatedAt String True

The date and time when the cart was created.

UpdatedAt String True

The date and time when the cart was last updated.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

EcommerceCustomers

A list of an account's ecommerce customers.

 

Columns

 

 

 

   
Name Type ReadOnly Description
StoreId [KEY] String True

The StoreId for the table.

Id [KEY] String True

A unique identifier for the customer.

EmailAddress String True

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 False

The customer's total order count.

TotalSpent Double False

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 String True

The date and time the customer was created.

UpdatedAt String True

The date and time the customer was last updated.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

EcommerceOrderLines

A list of an ecommerce order's lines.

 

Columns

 

 

 

   
Name Type ReadOnly Description
StoreId [KEY] String True

The StoreId for the table.

OrderId [KEY] String True

The OrderId for the table.

Id [KEY] String False

A unique identifier for the order line item.

ProductId [KEY] 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 [KEY] 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 Double False

The price of an ecommerce order line item.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

EcommerceOrders

A list of an account's ecommerce orders.

 

Columns

 

 

 

   
Name Type ReadOnly Description
StoreId [KEY] String True

The StoreId for the table.

Id [KEY] String True

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 [KEY] 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 Double False

The order total for the order.

TaxTotal Double False

The tax total for the order.

ShippingTotal Double 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 String False

The date and time the order was processed.

CancelledAtForeign String False

The date and time the order was cancelled.

UpdatedAtForeign String 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

EcommerceProducts

A list of an account's ecommerce products.

 

Columns

 

 

 

   
Name Type ReadOnly Description
StoreId [KEY] String True

The StoreId for the table.

Id [KEY] String True

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 String False

The date and time when the product was published.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

EcommerceProductVariants

A list of an ecommerce product's variants.

 

Columns

 

 

 

   
Name Type ReadOnly Description
StoreId [KEY] String True

The StoreId for the table.

ProductId [KEY] String True

The ProductId for the table.

Id [KEY] String True

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 Double 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 String True

The date and time when the product was created.

UpdatedAt String True

The date and time the product was last updated.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

EcommerceStores

A list of an account's ecommerce stores.

 

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The unique identifier for the store.

ListId [KEY] String True

The unique identifier for the MailChimp list that's associated with the store. The list_id for a specific store can't change.

Name String False

The name of the store.

Platform String False

The ecommerce platform of the store.

Domain String False

The store domain.

EmailAddress String False

The email address for the store.

CurrencyCode String False

The three-letter ISO 4217 code for the currency that the store accepts.

MoneyFormat String False

The currency format for the store. For example: `$`, `£`, etc.

PrimaryLocale String False

The primary locale for the store. For example: `en`, `de`, etc.

Timezone String False

The timezone for the store.

Phone String False

The store phone number.

Address_Address1 String False

The store's mailing address.

Address_Address2 String False

An additional field for the store's mailing address.

Address_City String False

The city the store is located in.

Address_Province String False

The store's state name or normalized province.

Address_ProvinceCode String False

The two-letter code for the store's province or state.

Address_PostalCode String False

The store's postal or zip code.

Address_Country String False

The store's country.

Address_CountryCode String False

The two-letter code for to the store's country.

Address_Longitude Double False

The longitude of the store location.

Address_Latitude Double False

The latitude of the store location.

CreatedAt String True

The date and time the store was created.

UpdatedAt String True

The date and time the store was last updated.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

FileManagerFiles

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

 

Table Specific Information

 

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

Select

 

A FolderId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Insert

 

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

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

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The unique id given to the file.

FolderId [KEY] 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 String 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

FileManagerFolders

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

 

Table Specific Information

 

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

Insert

 

The Name is required for INSERTs.

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

 

 

 

   
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 String True

The date and time a file was added to the gallery.

CreatedBy String True

The username of the profile that created the folder.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListInterestCategories

A listing of this list's interest categories.

 

Table Specific Information

 

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

Select

 

A ListId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Insert

 

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

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

 

 

 

   
Name Type ReadOnly Description
ListId [KEY] String True

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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListInterests

A list of this category's interests

 

Table Specific Information

 

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

Select

 

A ListId and CategoryId are required to retrieve data from this table. If none are specified in the WHERE clause, the first ones avaiable for your account will be used.

Insert

 

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

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

 

 

 

   
Name Type ReadOnly Description
CategoryId [KEY] String True

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 False

The number of subscribers associated with this interest.

DisplayOrder Integer False

Order in which the interests display.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListMemberNotes

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

 

Table Specific Information

 

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

Select

 

A ListId and EmailId are required to retrieve data from this table. If none are specified in the WHERE clause, the first ones avaiable for your account will be used.

Insert

 

No fields are are required when INSERTing.

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The note's ID.

CreatedAt String True

The date the note was created.

CreatedBy String True

The author of the note.

UpdatedAt String True

The date the note was last updated

Note String False

The content of the note.

ListId [KEY] String True

The unique id for the list.

EmailId [KEY] String True

The MD5 hash of the list member's email address.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListMembers

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

 

Table Specific Information

 

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

Select

 

A ListId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Insert

 

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

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

 

 

 

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

Status String False

Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', or 'pending').

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 True

IP address the subscriber signed up from.

TimestampSignup String True

Date and time the subscriber signed up for the list.

IpOpt String True

IP address the subscriber confirmed their opt-in status.

TimestampOpt String True

Date and time the subscribe confirmed their opt-in status.

MemberRating Integer True

Star rating for this member between 1 and 5.

LastChanged String 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

 

Location_Longitude Double False

 

Location_Gmtoff Integer True

 

Location_Dstoff Integer True

 

Location_CountryCode String True

 

Location_Timezone String True

 

LastNote_NoteId Integer False

The note's ID.

LastNote_CreatedAt String False

The date the note was created.

LastNote_CreatedBy String False

The author of the note.

LastNote_Note String False

The content of the note.

ListId [KEY] String True

The id for the list.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListMergeFields

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

 

Table Specific Information

 

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

Select

 

A ListId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Insert

 

The Name and ListID are required for INSERTs.

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

 

 

 

   
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 True

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 True

A string that identifies this merge field collections' list.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

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.

 

Table Specific Information

 

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

Insert

 

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

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

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

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 String 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 String 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 String True

The date and time of the last time someone subscribed to this list.

Stats_LastUnsubDate String True

The date and time of the last time someone unsubscribed from this list.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListSegmentMembers

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

 

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The MD5 hash of the list member's email address.

EmailAddress String True

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

Status String False

Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', or 'pending').

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 True

IP address the subscriber signed up from.

TimestampSignup String True

Date and time the subscriber signed up for the list.

IpOpt String True

IP address the subscriber confirmed their opt-in status.

TimestampOpt String True

Date and time the subscribe confirmed their opt-in status.

MemberRating Integer True

Star rating for this member between 1 and 5.

LastChanged String 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

 

Location_Longitude Double False

 

Location_Gmtoff Integer True

 

Location_Dstoff Integer True

 

Location_CountryCode String True

 

Location_Timezone String True

 

LastNote_NoteId Integer False

The note's ID.

LastNote_CreatedAt String False

The date the note was created.

LastNote_CreatedBy String False

The author of the note.

LastNote_Note String False

The content of the note.

ListId [KEY] String True

The id for the list.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListSegments

A list of available segments.

 

Table Specific Information

 

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

Select

 

A ListId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Insert

 

The Name and ListID are required for INSERTs.

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

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

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 String True

The time and date the segment was created.

UpdatedAt String 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 True

The id for the list.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListsTwitterLeadGenCards

Twitter Lead Generation Cards for given List

 

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

Card unique ID

Name String True

Twitter Lead Generation Card Name

Title String True

Twitter Lead Generation Card Title

CtaText String True

Phrase to display on Call to Action button

PrivacyPolicyUrl String True

Privacy Policy URL

CustomKeyName String True

Custom key name to store twitter subscriber's display name

ImageUrl String True

Header image url, size must be 800x200px

TwitterCardId [KEY] String True

Twitter Lead Generation Card ID

TwitterAccountId [KEY] String True

Twitter Account ID

ListId [KEY] String True

List ID

PreviewUrl String True

Twitter Lead Generation Card Preview Url

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

ListsWebhooks

Webhooks configured for the given list.

 

Columns

 

 

 

   
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 True

The id for the list.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

TemplateFolders

Folders for organizing templates

 

Columns

 

 

 

   
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

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

Templates

A list an account's available templates.

 

Table Specific Information

 

SELECT and DELTE are supported for Templates.

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String 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 String True

The date and time the template was created.

CreatedBy String True

The login name for template's creator.

Active Boolean False

User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether or not the template is still active.

FolderId [KEY] 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

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 




 

Views

  1. AutomationEmails
  2. Automations
  3. Conversations
  4. ListAbuse
  5. ListActivity
  6. ListClients
  7. ListGrowthHistory
  8. ListMemberActivity
  9. ListSignupForms
  10. ReportAbuse
  11. ReportAdvice
  12. ReportClickDetails
  13. ReportClickDetailsMembers
  14. ReportDomainPerformance
  15. ReportEmailActivity
  16. ReportLocations
  17. Reports
  18. ReportSentTo
  19. ReportUnsubscribes

AutomationEmails

A summary of the emails in an automation workflow.

 

Table Specific Information

 

SELECT is supported for AutomationEmails.

Select

 

A WorkflowId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
Id [KEY] String A string that uniquely identifies the automation email.
WorkflowId [KEY] String A string that uniquely identifies an automation workflow.
Position Integer  
Delay_Amount Integer The delay amount for an automation email.
Delay_Type String The type of delay for an automation email.
Delay_Direction String Whether the delay settings describe before or after the delay action of an automation email.
Delay_Action String The action that triggers the delay of an automation emails.
CreateTime String The date and time the campaign was created.
StartTime String 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 String 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_Highrise String Highrise tracking options for a campaign. Must be using MailChimp's built-in Highrise 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

Automations

A summary of the automations within an account.

 

Columns

 

 

 

   
Name Type Description
Id [KEY] String A string that identifies this automation.
CreateTime String The date and time the automation was created.
StartTime String 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_Highrise String Highrise tracking options for an automation. Must be using MailChimp's built-in Highrise 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

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.

 

Columns

 

 

 

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

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

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.

 

Table Specific Information

 

SELECT is supported for ListAbuse.

Select

 

A ListId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
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

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ListActivity

Up to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity.

 

Table Specific Information

 

SELECT is supported for ListActivity.

Select

 

A ListId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
ListId [KEY] String The ListId for the table.
Day String 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ListClients

Top email clients used, as measured by their user-agent string

 

Columns

 

 

 

   
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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ListGrowthHistory

A month-by-month summary of a specific list's growth activity.

 

Table Specific Information

 

SELECT is supported for ListGrowthHistory.

Select

 

A ListId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
ListId [KEY] String The list id for the growth activity report.
Month String The month that the growth history is describing.
Existing Integer Existing members on the list for a given month.
Imports Integer Imported members on the list for a given month.
Optins Integer New opt-in members on the list for a given month.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ListMemberActivity

The last 50 member events for a list.

 

Table Specific Information

 

SELECT is supported for ListMemberActivity.

Select

 

A ListId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
MemberId [KEY] String The MemberId of the member to get events for.
EmailId [KEY] String The EmailId for the table.
ListId [KEY] String The ListId for the table.
Action String The type of action recorded for the subscriber.
Timestamp String 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 [KEY] String The web-based ID for the campaign.
Title String If set, the campaign's title.
ParentCampaign String The ID of the parent campaign.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ListSignupForms

Collection of List Signup Forms

 

Columns

 

 

 

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

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportAbuse

A list of abuse complaints for a specific list.

 

Table Specific Information

 

SELECT is supported for ReportAbuse.

Select

 

A CampaignId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
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

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportAdvice

A list of feedback based on a campaign's statistics.

 

Table Specific Information

 

SELECT is supported for ReportAdvice.

Select

 

A CampaignId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
CampaignId [KEY] String The CampaignId for the table.
Type String The 'type' of message ('negative', 'positive', 'neutral').
Message String The advice message.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportClickDetails

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

 

Table Specific Information

 

SELECT is supported for ReportClickDetails.

Select

 

A CampaignId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
Id [KEY] String  
Url String The URL for the link in the campaign.
TotalClicks Integer The number of total clicks for a given link.
ClickPercentage Double The percentage of total clicks a given link generated for a campaign.
UniqueClicks Integer Number of unique clicks for a given link.
UniqueClickPercentage Double The percentage of unique clicks a given link generated for a campaign.
LastClick String 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportClickDetailsMembers

A collection of members who clicked on a specific link within a campaign.

 

Table Specific Information

 

SELECT is supported for ReportClickDetailsMembers.

Select

 

A CampaignId and UrlId are required to retrieve data from this table. If none are specified in the WHERE clause, the first ones avaiable for your account will be used.

Columns

 

 

 

   
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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportDomainPerformance

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

 

Table Specific Information

 

SELECT is supported for ReportDomainPerformance.

Select

 

A CampaignId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
CampaignId [KEY] 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 taht came from this domain.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportEmailActivity

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

 

Table Specific Information

 

SELECT is supported for ReportEmailActivity.

Select

 

A CampaignId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
CampaignId [KEY] String The unique id for the campaign.
ListId [KEY] String The unique id for the list.
EmailId [KEY] String The list-specific ID for the given email address.
EmailAddress String Email address for a subscriber
Activity String An array of objects, each showing an interaction with the email.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportLocations

Top open locations for a specific campaign.

 

Columns

 

 

 

   
Name Type Description
CampaignId [KEY] String The CampaignId for the table.
Region String A more specific location area such as city or state.
Opens Integer The number of unique campaign opens for a given region.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

Reports

A list of reports containing campaigns marked as Sent.

 

Columns

 

 

 

   
Name Type Description
Id [KEY] String A string that uniquely identifies this campaign.
CampaignTitle String The title of the campaign.
Type String The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto).
EmailsSent Integer The total number of emails sent for this campaign.
AbuseReports Integer The number of abuse reports generated for this campaign.
Unsubscribed Integer The total number of unsubscribed members for this campaign.
SendTime String 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 String 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 String 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportSentTo

A list of subscribers who were sent a specific campaign.

 

Table Specific Information

 

SELECT is supported for ReportSentTo.

Select

 

A CampaignId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
EmailId [KEY] String The list-specific ID for the given email address.
EmailAddress String Email address for a subscriber.
Status String The status of the member ('sent', 'hard' for hard bounce, or 'soft' for soft bounce).
OpenCount Integer The number of times a campaign was opened by this member.
LastOpen String The date and time of the last open for this member.
AbsplitGroup String For A/B Split Campaigns, the group the member was apart of ('a', 'b', or 'winner').
GmtOffset Integer For campaigns sent with timewarp, the time zone group the member is apart of.
CampaignId [KEY] String The id for the campaign.
ListId [KEY] String The id for the list.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

 

 

 

ReportUnsubscribes

A list of members who have unsubscribed from a specific campaign.

 

Table Specific Information

 

SELECT is supported for ReportUnsubscribes.

Select

 

A CampaignId is required to retrieve data from this table. If none is specified in the WHERE clause, the first one avaiable for your account will be used.

Columns

 

 

 

   
Name Type Description
EmailId [KEY] String The list-specific ID for the given email address
EmailAddress String Email address for a subscriber
Timestamp String 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.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.