Campaign Monitor

Campaign Monitor is an email marketing service.

Campaign Monitor integration replicates data using the Campaign Monitor API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

Creating the connection

For more information, see Connecting to SaaS applications.

Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify.
Tip noteYou may need to scroll down to see this field.
When status is Verified, the authentication is verified.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.

Connection settings
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 `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Application Client ID	Application client ID.
Application Client Secret	Application client secret.
API Client ID	API client ID.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

campaign_bounces

The campaign_bounces table contains info about the subscribers who bounced for a given campaign.

Replication Method	CDC
Primary Keys	CampaignID EmailAddress Date ListID
Replication Key	Date
Useful links	Campaign Monitor API method

BounceType

STRING

CampaignID

STRING

Date

DATE-TIME

EmailAddress

STRING

ListID

STRING

Reason

STRING

campaign_clicks

The campaign_clicks table contains info about subscribers who clicked a link in a given campaign.

Replication Method	CDC
Primary Keys	CampaignID EmailAddress ListID Date
Replication Key	Date
Useful links	Campaign Monitor API method

CampaignID

STRING

City

STRING

CountryCode

STRING

CountryName

STRING

Date

DATE-TIME

EmailAddress

STRING

IPAddress

STRING

Latitude

NUMBER

ListID

STRING

Longitude

NUMBER

Region

STRING

URL

STRING

campaign_email_client_usage

The campaign_email_client_usage table contains info about the email clients subscribers use to open campaigns.

Replication Method

Full Table

Primary Keys

CampaignID

Client

Version

Useful links

Campaign Monitor API method

CampaignID

STRING

Client

STRING

Percentage

NUMBER

Subscribers

INTEGER

Version

STRING

campaign_opens

The campaign_opens table contains info about subscribers who opened a campaign.

Replication Method	CDC
Primary Keys	CampaignID EmailAddress ListID Date
Replication Key	Date
Useful links	Campaign Monitor API method

CampaignID

STRING

City

STRING

CountryCode

STRING

CountryName

STRING

Date

DATE-TIME

EmailAddress

STRING

IPAddress

STRING

Latitude

NUMBER

ListID

STRING

Longitude

NUMBER

Region

STRING

campaign_recipients

The campaign_recipients table contains info about the subscribers that a campaign was sent to.

Replication Method

CDC

Primary Keys

CampaignID

EmailAddress

ListID

Useful links

Campaign Monitor API method

CampaignID

STRING

EmailAddress

STRING

ListID

STRING

campaign_spam_complaints

The campaign_spam_complaints table contains info about subscribers who marked a campaign as spam.

Replication Method	CDC
Primary Keys	CampaignID EmailAddress ListID Date
Replication Key	Date
Useful links	Campaign Monitor API method

CampaignID

STRING

Date

DATE-TIME

EmailAddress

STRING

ListID

STRING

campaign_summary

The campaign_summary table contains summary info about sent campaigns.

Replication Method

Full Table

Primary Key

CampaignID

Useful links

Campaign Monitor API method

Bounced

INTEGER

CampaignID

STRING

Clicks

INTEGER

Forwards

INTEGER

Likes

INTEGER

Mentions

INTEGER

Recipients

INTEGER

SpamComplaints

INTEGER

TotalOpened

INTEGER

UniqueOpened

INTEGER

Unsubscribed

INTEGER

WebVersionTextURL

STRING

WebVersionURL

STRING

WorldviewURL

STRING

campaign_unsubscribes

The campaign_unsubscribes table contains info about the subscribers who unsubscribed from the email for a campaign.

Replication Method	CDC
Primary Keys	CampaignID EmailAddress ListID Date
Replication Key	Date
Useful links	Campaign Monitor API method

CampaignID

STRING

Date

DATE-TIME

EmailAddress

STRING

IPAddress

STRING

ListID

STRING

campaigns

The campaigns table contains info about the the campaigns in your Campaign Monitor account.

Replication Method

CDC

Primary Key

CampaignID

Useful links

Campaign Monitor documentation

CampaignID

STRING

FromEmail

STRING

FromName

STRING

Name

STRING

ReplyTo

STRING

SentDate

DATE-TIME

Subject

STRING

TotalRecipients

NUMBER

WebVersionTextURL

STRING

WebVersionURL

STRING

list_active_subscribers

The list_active_subscribers table contains info about the active subscribers for lists.

Replication Method	CDC
Primary Keys	ListID EmailAddress Date
Replication Key	Date
Useful links	Campaign Monitor API method

ConsentToTrack

STRING

CustomFields

ARRAY

This is a nested data structure:

Key: STRING
Value: STRING

Date

DATE-TIME

EmailAddress

STRING

ListID

STRING

Name

STRING

ReadsEmailWith

STRING

State

STRING

list_bounced_subscribers

The list_bounced_subscribers table contains info about the bounced subscribers for lists.

Replication Method	CDC
Primary Keys	ListID EmailAddress Date
Replication Key	Date
Useful links	Campaign Monitor API method

ConsentToTrack

STRING

CustomFields

ARRAY

This is a nested data structure:

Key: STRING
Value: STRING

Date

DATE-TIME

EmailAddress

STRING

ListID

STRING

Name

STRING

ReadsEmailWith

STRING

State

STRING

list_deleted_subscribers

The list_deleted_subscribers table contains info about the deleted subscribers for lists.

Replication Method	CDC
Primary Keys	ListID EmailAddress Date
Replication Key	Date
Useful links	Campaign Monitor API method

ConsentToTrack

STRING

CustomFields

ARRAY

This is a nested data structure:

Key: STRING
Value: STRING

Date

DATE-TIME

EmailAddress

STRING

ListID

STRING

Name

STRING

ReadsEmailWith

STRING

State

STRING

list_details

The list_details table contains summary info about lists in your Campaign Monitor account.

Replication Method

CDC

Primary Key

ListID

Useful links

Campaign Monitor API method

ConfirmationSuccessPage

STRING

ConfirmedOptIn

BOOLEAN

ListID

STRING

Title

STRING

UnsubscribePage

STRING

UnsubscribeSetting

STRING

list_unconfirmed_subscribers

The list_unconfirmed_subscribers table contains info about the unconfirmed subscribers for lists.

Replication Method	CDC
Primary Keys	ListID EmailAddress Date
Replication Key	Date
Useful links	Campaign Monitor API method

ConsentToTrack

STRING

CustomFields

ARRAY

This is a nested data structure:

Key: STRING
Value: STRING

Date

DATE-TIME

EmailAddress

STRING

ListID

STRING

Name

STRING

ReadsEmailWith

STRING

State

STRING

list_unsubscribed_subscribers

The list_unsubscribed_subscribers table contains info about the unsubscribed subscribers for lists.

Replication Method	CDC
Primary Keys	ListID EmailAddress Date
Replication Key	Date
Useful links	Campaign Monitor API method

ConsentToTrack

STRING

CustomFields

ARRAY

This is a nested data structure:

Key: STRING
Value: STRING

Date

DATE-TIME

EmailAddress

STRING

ListID

STRING

Name

STRING

ReadsEmailWith

STRING

State

STRING

lists

The lists table contains info about the lists in your Campaign Monitor account.

Replication Method

Full Table

Primary Key

ListID

Useful links

Campaign Monitor documentation

ListID

STRING

Name

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here