This connector is currently in beta and subject to change.

The Sisense MailChimp connector is a standalone connector that allows you to import data from MailChimp’s API into the ElastiCube Manager. After you have downloaded and installed the connector, you can connect through a connection string you provide Sisense in the ElastiCube Manager. The connection string is used to authenticate users who connect to MailChimp’s API. To obtain a connection string, you will need to retrieve an API Key from MailChimp or register a MailChimp app.

Once you have connected to MailChimp, you can import a variety of tables from the MailChimp API.

This page describes how to install the MailChimp connector, how to connect to
MailChimp with a connection string, and what tables you can import into the ElastiCube Manager:

Installing the MailChimp Connector

Sisense provides the MailChimp connector as a standalone connector that you can download and add to your list of default Sisense connectors.

To install the MailChimp connector:

  1. Download the MailChimp installation file.
  2. Open the installation file and click Install.
  3. After the installation process is complete, click Close.

The MailChimp connector is displayed in the ElastiCube Manager under Add Data > Web Services.

Connecting to the MailChimp REST API

There are two authentication methods available for connecting to MailChimp, through an API Key or through OAuth. Both methods expose the same data, the difference is in what information is required by MailChimp to authenticate your account. For the API Key, all you need is a key provided my MailChimp in your account. For Oauth, you need to register an app with MailChimp, and then pass those details to Sisense.

After you have the relevant information from MailChimp, you create a connection string and connect to MailChimp.

The steps below describe how to retrieve the API Key and Oauth credentials that need to be included in the connection string.

Using the API Key to Connect to MailChimp

The APIKey grants full access to your MailChimp account. To obtain the APIKey, log into MailChimp and click Account > Extras > API Keys.

With the API Key, you can connect to MailChimp by passing the key in a connection string.

Using OAuth to Connect to MailChimp

To access MailChimp’s REST API from Sisense, you must provide valid Oauth MailChimp credentials. These credentials are provided by MailChimp when you register an application.

OAuth requires the authenticating user to interact with MailChimp using the browser. The driver facilitates this in various ways as described below.

Register Your Application

Follow the steps below to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret:

  1. Log into your MailChimp account and click Account > Extras > API Keys > Register and Manage Your Apps.
  2. Enter the information you want to be displayed to users when they are prompted to grant permissions to your application. This information includes your app name, company, and website.
  3. If you are making a desktop application, in the Redirect URI box enter http://127.0.0.1. If you are making a Web application, in the Redirect URI box enter a URL where you would like users to be redirected after they grant permissions to your application.

Authenticating through MailChimp

After setting the following connection properties, you are ready to connect:

  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • CallbackURL: Set this to the callback URL you specified in your app settings.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken and OAuthAccessTokenSecret.

When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Refreshes the access token when it expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Adding MailChimp Tables to Your ElastiCube

After you have retrieve your API Key or OAuth credentials from MailChimp, you provide the relevant information in a connection string. Sisense uses connection strings to connect to MailChimp and import data into the ElastiCube Manager. Each connection string contains a authentication parameters that the data source uses to verify your identity and what information you can export to Sisense. To learn more, see Connection String Parameters.

For API Keys, the connection string to MailChimp is in the following format:

jdbc:mailchimp:APIKey=xxxxxxxxxxxxxxxxxxxxxx;

For OAuth, the connection string to MailChimp is in the following format:

jdbc:mailchimp:OAuthClientId=xxxxxxxxx;OAuthClientSecret=xxxxxxxxx;CallbackURL=http://127.0.0.1;InitiateOAuth=GETANDREFRESH;

To add MailChimp data:

  1. In ElastiCube Manager, click Add Data and then, MailChimp. The Connect to MailChimp window is displayed.
  2. In Datasource Connection String, enter your connection string.
  3. Click Connect to Server. MailChimp is displayed in the Select Database list.
  4. Click OK. Sisense connects to MailChimp and displays a list of tables available for you to import.
  5. Select the relevant tables and click Add. The tables are displayed in the ElastiCube Manager.

MailChimp Tables

The Sisense MailChimp connector allows you to import the following tables into the ElastiCube Manager.

Available Tables

NameDescription
AuthorizedAppsA list of applications authorized to access the account.
AutomationEmailQueuesA summary of the queue for an email in an automation workflow.
AutomationsRemovedSubscribersA summary of the subscribers removed from an automation workflow.
CampaignFeedbackA summary of the comment feedback for a specific campaign.
CampaignFoldersFolders for organizing campaigns
CampaignsA summary of the campaigns within an account.
ConversationMessagesMessages 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.
EcommerceCartLinesA list of an ecommerce cart's lines.
EcommerceCartsA list of an account's ecommerce carts.
EcommerceCustomersA list of an account's ecommerce customers.
EcommerceOrderLinesA list of an ecommerce order's lines.
EcommerceOrdersA list of an account's ecommerce orders.
EcommerceProductsA list of an account's ecommerce products.
EcommerceProductVariantsA list of an ecommerce product's variants.
EcommerceStoresA list of an account's ecommerce stores.
FileManagerFilesA listing of all available images and files within an account's gallery.
FileManagerFoldersA listing of all variable folders within an account's gallery.
ListInterestCategoriesA listing of this list's interest categories.
ListInterestsA list of this category's interests
ListMemberNotesThe last 10 notes for a specific list member, based on date created.
ListMembersIndividuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
ListMergeFieldsThe merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles.
ListsA collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization.
ListSegmentMembersIndividuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
ListSegmentsA list of available segments.
ListsTwitterLeadGenCardsTwitter Lead Generation Cards for given List
ListsWebhooksWebhooks configured for the given list.
TemplateFoldersFolders for organizing templates
TemplatesA list an account's available templates.

 

Available Views

NameDescription
AutomationEmailsA summary of the emails in an automation workflow.
AutomationsA summary of the automations within an account.
ConversationsA 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.
ListAbuseA collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program.
ListActivityUp to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity.
ListClientsTop email clients used, as measured by their user-agent string
ListGrowthHistoryA month-by-month summary of a specific list's growth activity.
ListMemberActivityThe last 50 member events for a list.
ListSignupFormsCollection of List Signup Forms
ReportAbuseA list of abuse complaints for a specific list.
ReportAdviceA list of feedback based on a campaign's statistics.
ReportClickDetailsA list of URLs and unique IDs included in HTML and plain-text versions of a campaign.
ReportClickDetailsMembersA collection of members who clicked on a specific link within a campaign.
ReportDomainPerformanceStatistics for the top-performing email domains in a campaign.
ReportEmailActivityA list of member's subscriber activity in a specific campaign.
ReportLocationsTop open locations for a specific campaign.
ReportsA list of reports containing campaigns marked as Sent.
ReportSentToA list of subscribers who were sent a specific campaign.
ReportUnsubscribesA list of members who have unsubscribed from a specific campaign.

Versions

VersionRelease DateDescription
6.6.0.54March 28, 2017Beta release