SparkPost

The Lyftron Provider for SparkPost offers the most natural way to access SparkPost 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 SparkPost data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s SparkPost 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 SparkPost.
• Comprehensive full support of ANSI Sql to query data with ease.
• Collaborative query processing.

Prerequisites

The user must have credentials for SparkPost, 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 SparkPost 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 SparkPost 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 SparkPost connection with Lyftron.

Profile=C:\profiles\SparkPost.apip;ProfileSettings='APIKey=< Api-Key >';

Key	Value	Field
Connection Name	Enter your connection details	Required
Profile	C:\profiles\SparkPost.apip	Required
APIKey	your SparkPost < Api-Key >	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 SparkPost 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
ABTests	Tables	An A/B test is a method of comparing templates to see which performs best.
ABTestsDraft	Tables	Generating Draft of AB Tests.
AccountInformation	Tables	Retrieve information regarding your SparkPost account and set account options.
Alerts	Tables	Retrieve full information about a single or list of alert.
BatchStatusInformation	Tables	Returns the status information for the batches that have been generated. Status information includes the successes of batches that previously failed to reach the webhook's target URL and batches that are currently in a failed state.
BounceClassificationMetrics	Tables	Provides deliverability metrics, specific to bounce events, grouped by the domain and bounce reasons.
BounceReasonMetrics	Tables	Provides deliverability metrics, specific to bounce events, grouped by the bounce classification.
BounceReasonMetricsByDomain	Tables	Provides deliverability metrics, specific to bounce events, grouped by the domain and bounce reasons.
DelayReasonMetrics	Tables	Provides deliverability metrics, specific to delay events, grouped by the delay reasons.
DelayReasonMetricsByDomain	Tables	Provides deliverability metrics, specific to delay events, grouped by the domain and delay reasons.
DeliverabilityMetricsByCampaign	Tables	Provides string metrics grouped by campaign over the time window specified.
DeliverabilityMetricsBySendingDomain	Tables	Provides string metrics grouped by sending domain over the time window specified.
DeliverabilityMetricsBySendingIP.rsd	Tables	This service does not define any meta-information (see the keyword rsb:info in RSBScript guide). Please encourage the administrator of this service to describe the API of this service. Simple meta-information not only clarifies the usage but also facilitates calling the service using software tools.
DeliverabilityMetricsBySubAccount	Tables	Provides string metrics grouped by subaccount over the time window specified. Please note that master account events will be returned grouped by the subaccount_id field containing the value 0.
DeliverabilityMetricsByTemplate	Tables	Provides string metrics grouped by template over the time window specified.
DeliverabilityMetricsByWatchedDomain	Tables	Provides string metrics grouped by watched domain over the time window specified. The difference between domain and watched domain is that watched domains are comprised of the top 99% domains in the world.
DeliverabilityMetricsIPPool	Tables	Provides string metrics grouped by IP pool over the time window specified.
DeliverabilityMetricsRecipientDomain	Tables	Provides string metrics grouped by domain over the time window specified.
DeliverabilityMetricsSummary	Tables	Provides high-level summary of string metrics and lists the child endpoints that contain string data, which can be used as group by qualifiers.
DeliveriesByAttempt	Tables	Provides string count of deliveries grouped by the attempt number.
EngagementDetails	Tables	Provides deliverability metrics, specific to engagement events (clicks/opens), grouped by the link name (or URL if no link name exists).
EventsDocumentation	Tables	Returns a list of descriptions of the event fields that could be included in a response from the message events search. Fields will vary by event type.
EventsSamples	Tables	Returns an example message event for each event type listed in the events parameter.
InBoundDomains	Tables	Returns an array with all your inbound domains.
IPPools	Tables	Returns a list of all your IP Pools.
ListCampaigns	Tables	Returns a list of IP pools that the Metrics API contains data on.
ListDomains	Tables	Returns a list of IP pools that the Metrics API contains data on.
ListIPPools	Tables	Returns a list of IP pools that the Metrics API contains data on.
ListSendingIPs	Tables	Returns a list of sending IPs that the Metrics API contains data on.
ListSubAccounts	Tables	Subaccounts are a way for you to provision and manage senders separately from each other, and to provide assets and reporting data for each of them.
MetricsDiscoverabilityLinks	Tables	The Metrics API is designed for discoverability of child links. Calling the API root displays a list of URIs that exists within the Metrics API.
RecipientEmail	Tables	A sending domain is a domain that is used to indicate who an email is from via the From: header
RecipientLists	Tables	The Recipient List API operates on lists as a whole and does not currently support management of individual recipients.
RecipientValidation	Tables	A sending domain is a domain that is used to indicate who an email is from via the From: header
RejectionReasonMetrics	Tables	Provides deliverability metrics, specific to rejection events, grouped by the rejection reasons.
RejectionReasonMetricsByDomain	Tables	Provides deliverability metrics, specific to rejection events, grouped by the domain and rejection reasons.
RelayWebhooks	Tables	List all your relay webhooks.
ScheduledTransmissions	Tables	Returns details about a scheduled transmission.
SearchForListEntries	Tables	A suppression list, also known as an exclusion list, stores a recipient's opt-out preferences.
SearchForMessageEvents	Tables	Search Events based on type.
SendingDomain	Tables	A sending domain is a domain that is used to indicate who an email is from via the From: header
SendingDomains	Tables	A sending domain is a domain that is used to indicate who an email is from via the From: header
SendingIPs	Tables	Returns a list of all sending IPs.
Snippets	Tables	Snippets are short reusable pieces of email content
SubAccount	Tables	Subaccounts are a way for you to provision and manage senders separately from each other, and to provide assets and reporting data for each of them.
SubAccountsSummary	Tables	Subaccounts are a way for you to provision and manage senders separately from each other, and to provide assets and reporting data for each of them.
Suppression	Tables	A suppression list, also known as an exclusion list, stores a recipient's opt-out preferences.
SuppressionListSummary	Tables	Returns the total number of suppressions for your account, as well as a break down of suppressions by source.
Templates	Tables	Templates are a way to store and edit email content.
TimeSeriesMetrics	Tables	Provides deliverability metrics ordered by a precision of time.
TrackingDomains	Tables	Tracking domains are used in engagement tracking to report email opens and link clicks.
WebhookEventSamples	Tables	Returns an example of the event data that will be posted by a webhook for the specified events.
WebhookEventsDocumentation	Tables	Returns a list of descriptions of the events, event types, and event fields that could be included in a webhooks batches to your target URL.
Webhooks	Tables	Returns a list of all your webhooks.