Overview
The Lyftron Provider for Dotmailer offers the most natural way to access Dotmailer data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing Dotmailer data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Dotmailer data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to Dotmailer.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for Dotmailer, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Establishing a Connection with Lyftron's Quickstart Steps
Create your Dotmailer connection with Lyftron by following the 5 easy steps show below:
Step1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button
Step2. Select your connector
In the connector selection panel, search and click Dotmailer for your connection
Step3. Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish Dotmailer connection with Lyftron.
Profile=C:\profiles\Dotmailer.apip;User=your_api_username;Password=your_api_password;Other='RegionId=your_regionid';Key | Value | Field |
Connection Name | Enter your connection details | Required |
Profile | C:\profiles\Dotmailer.apip | Required |
User | your Dotmailer api_username | Required |
Password | your Dotmailer api_password | Required |
RegionId | your Dotmailer regionid | Required |
Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Step4. Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Step5. Save your connection
Hurray! Now you have successfully connected with the Lyftron Dotmailer connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.
Generally, querying APIs tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns.
Name | Type | Description |
Account | Tables | Gets a summary of information about the current status of the account. |
AddressBookCampaigns | Tables | Retrieves any campaigns that have been sent to an address book or a segment. |
AddressBookContacts | Tables | Retrieves a list of contacts in a given address book or segment by ID. |
AddressBookContactsScoring | Tables | Retrieves contact scoring for contacts within a specific address book or segment. |
AddressBooks | Tables | Gets all address books. |
CampaignActivity | Tables | Returns a list of contacts who were sent a specified campaign, with a summary report of the contact's activity. |
CampaignAddressBooks | Tables | Returns a list of any address books and segments that a specified campaign has ever been sent to. |
CampaignAttachments | Tables | Returns documents that are currently attached to a campaign. |
CampaignClicks | Tables | Returns a list of clicks for links within a specified campaign. |
CampaignClicksGroups | Tables | Returns a list of clicks for links, along with the links' assigned link groups, within a specified campaign. |
CampaignContactClicksLinkGroups | Tables | Returns a list of clicks for links, along with the links' assigned link groups, by a specified contact in a specified campaign. |
CampaignDetails | Tables | Retrieves a campaign by ID, along with all its details |
CampaignHardBouncer | Tables | Retrieves a list of contacts who hard bounced when sent a particular campaign. |
CampaignOpens | Tables | Retrieves a list of campaign opens. |
Campaigns | Tables | Retrieves all campaigns |
CampaignSocialBookmarkViews | Tables | Retrieves campaign social bookmark views for a campaign. |
CampaignSummary | Tables | Retrieves a summary of reporting information for a specified campaign. |
ContactAddressBooks | Tables | Returns a list of any address books and segments that a specified campaign has ever been sent to. |
ContactCampaignActivity | Tables | Returns a summary report of activity by a specific contact with regards to a specific campaign sent to them. |
ContactCampaignClicks | Tables | Returns a list of link clicks by a specified contact in a specified campaign. |
ContactCampaignOpens | Tables | Retrieves a list of campaign opens for a contact. |
ContactCampaignPageViews | Tables | Returns a list of page views for a specific campaign for a contact. |
ContactCampaignReplies | Tables | Returns a list of campaign replies for a contact |
ContactCampaignROIActivity | Tables | Returns a list of ROI information for a campaign for a contact |
ContactCampaignSocialBookmarkViews | Tables | Retrieves campaign social bookmark views for a contact. |
ContactPreferences | Tables | Returns all preferences for the account and indicates those that a given contact is opted into. |
Contacts | Tables | Retrieves a list of all contacts in the account. |
ContactScoring | Tables | Retrieves contact scoring for all contacts in the account or scoring for a contact by ID (Email). |
DataFields | Tables | Retrieves all contact data fields within the account. |
DocumentFolders | Tables | Retrieves the document folder tree structure that exists within your account. |
FolderDocuments | Tables | Retrieves all of the uploaded documents within a specified folder. |
ImageFolders | Tables | Retrieves the campaign image folder tree structure. |
Preferences | Tables | Returns an array of all preferences and preference categories.Preference categories have the isPreference key set to false. Preferences have the isPreference key set to true.If no preferences exist, an empty array is returned, otherwise an array, which contains preference objects and preference category objects is returned. |
PrivateAddressBooks | Tables | Gets all private address books. |
Programs | Tables | Retrieves all programs |
PublicAddressBooks | Tables | Gets all public address books. |
Segments | Tables | Retrieves all segments within your account. |
SurveyFields | Tables | Retrieves a list of survey pages, each containing a list of the fields on that page. |
SurveyResponses | Tables | Retrieves a list of all responses for a survey. |
Surveys | Tables | Retrieves all surveys in the account. |
Templates | Tables | Returns all saved templates within your account. |
Advanced Settings
To view a detailed advanced settings options, go to Dotmailer Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.