SparkPost
SparkPost is an email delivery platform that provides transactional and marketing email services.
SparkPost integration replicates data using the SparkPost API.
See the Schema section for a list of objects available for replication.Preparing for authentication
To access your data, you need to authenticate the connection with your account credentials.
To create your API key:
- Log into your SparkPost account.
- Navigate to Configuration > API Keys > Create API Key.
- Name the API key.
- Choose which permissions you want the API key to have.
- Click Create API Key.
- Copy and paste your API key into a secured file.
Restrict API key network traffic by allowing only specific IP addresses. To configure this, locate your Qlik Talend Cloud tenant IP addresses. For more information, see Allowlisting domains and IP addresses.
Creating the connection
For more information, see Connecting to SaaS applications.
- Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.
| Setting | Description |
|---|---|
| Data gateway | Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement. |
| Start Date | Enter the date, in the format |
| API Key | API key. |
| Precision | The default setting is DAY. Use this parameter to aggregate time-series data returned by the SparkPost Metrics API.
Select one of the following options to define the aggregation level:
|
Schema
Depending on your destination, table and column names may not appear as they are outlined below.
events
Replication Method | CDC |
Primary Key | event_id |
| Useful links |
webhooks
Replication Method | CDC |
Primary Key | id |
| Useful links |
templates
Replication Method | Full Table |
Primary Key | id |
| Useful links |
sending_domains
Replication Method | Full Table |
Primary Key | domain |
| Useful links |
tracking_domains
Replication Method | Full Table |
Primary Key | domain |
| Useful links |
suppression_list
Replication Method | Full Table |
Primary Key | recipient |
| Useful links |
recipient_lists
Replication Method | Full Table |
Primary Key | id |
| Useful links |
account
Replication Method | Full Table |
Primary Key | customer_id |
| Useful links |
usage
Replication Method | Full Table |
Primary Key | timestamp |
| Useful links |
subaccounts
Replication Method | Full Table |
Primary Key | id |
| Useful links |
ip_pools
Replication Method | Full Table |
Primary Key | id |
| Useful links |
metrics_recipient_domain
Replication Method | CDC |
Primary Key | timestamp domain |
| Useful links |
metrics_sending_ip
Replication Method | CDC |
Primary Key | timestamp sending_ip |
| Useful links |
metrics_ip_pool
Replication Method | CDC |
Primary Key | timestamp ip_pool |
| Useful links |
metrics_sending_domain
Replication Method | CDC |
Primary Key | timestamp sending_domain |
| Useful links |
metrics_subaccount
Replication Method | CDC |
Primary Key | timestamp subaccount_id |
| Useful links |
metrics_campaign
Replication Method | CDC |
Primary Key | timestamp campaign_id |
| Useful links |
metrics_template
Replication Method | CDC |
Primary Key | timestamp template_id |
| Useful links |
metrics_subject_campaign
Replication Method | CDC |
Primary Key | timestamp subject_campaign |
| Useful links |
metrics_watched_domain
Replication Method | CDC |
Primary Key | timestamp watched_domain |
| Useful links |
metrics_mailbox_provider
Replication Method | CDC |
Primary Key | timestamp mailbox_provider |
| Useful links |
metrics_mailbox_provider_region
Replication Method | CDC |
Primary Key | timestamp mailbox_provider_region |
| Useful links |
metrics_time_series
Replication Method | CDC |
Primary Key | timestamp |
| Useful links |
metrics_bounce_reason
Replication Method | CDC |
Primary Key | timestamp reason classification_id |
| Useful links |
metrics_bounce_reason_by_domain
Replication Method | CDC |
Primary Key | timestamp reason domain classification_id |
| Useful links |
metrics_bounce_classification
Replication Method | CDC |
Primary Key | timestamp classification_id |
| Useful links |
metrics_rejection_reason
Replication Method | CDC |
Primary Key | timestamp reason rejection_category_id |
| Useful links |
metrics_rejection_reason_by_domain
Replication Method | CDC |
Primary Key | timestamp reason domain rejection_category_id |
| Useful links |
metrics_delay_reason
Replication Method | CDC |
Primary Key | timestamp reason |
| Useful links |
metrics_delay_reason_by_domain
Replication Method | CDC |
Primary Key | timestamp reason domain |
| Useful links |
metrics_engagement_details
Replication Method | CDC |
Primary Key | timestamp link_name |
| Useful links |
metrics_deliveries_by_attempt
Replication Method | CDC |
Primary Key | timestamp attempt |
| Useful links |