Listrak

Listrak is a comprehensive digital marketing automation platform.

Listrak integration replicates data using the Listrak SOAP 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.

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.

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.
Username	Username.
Password	Password.

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.

lists

The lists table contains info about your contact lists.

Replication Method

Full Table

Primary Key

ListID

Useful links

Listrak documentation

Listrak API method

Join lists with	on
messages	lists.ListID = messages.ListID
subscribed_contacts	lists.ListID = subscribed_contacts.ListID

BounceUnsubscribeCount

INTEGER

CreateDate

DATE-TIME

DomainAliasEmail

STRING

DomainAliasLink

STRING

EnableBrowserLink

BOOLEAN

EnableDoubleOptin

BOOLEAN

EnableDynamicContent

BOOLEAN

EnableGoogleAnalytics

BOOLEAN

EnableInternationalization

BOOLEAN

EnableListHygiene

BOOLEAN

EnableListRemoveHeader

BOOLEAN

EnableRSS

BOOLEAN

EnableRemovalLink

BOOLEAN

FromEmail

STRING

FromName

STRING

GoogleTrackingDomains

ARRAY

This is a nested data structure.

ListID

INTEGER

ListName

STRING

ShowAdvancedPersonalization

BOOLEAN

ShowEmailList

BOOLEAN

Vmta

OBJECT

This is a nested data structure:

Description: STRING
VmtaID: INTEGER

bounceHandling

INTEGER

message_bounces

The message_bounces table contains info about contact bounces for a message.

Replication Method

Full Table

Primary Keys

MsgID

EmailAddress

Useful links

Listrak documentation

Listrak API method

Join message_bounces with	on
message_clicks	message_bounces.ContactID = message_clicks.ContactID message_bounces.MsgID = message_clicks.MsgID
message_opens	message_bounces.ContactID = message_opens.ContactID message_bounces.MsgID = message_opens.MsgID
message_reads	message_bounces.ContactID = message_reads.ContactID message_bounces.MsgID = message_reads.MsgID
message_unsubs	message_bounces.ContactID = message_unsubs.ContactID message_bounces.MsgID = message_unsubs.MsgID
subscribed_contacts	message_bounces.ContactID = subscribed_contacts.ContactID
message_sends	message_bounces.MsgID = message_sends.MsgID
messages	message_bounces.MsgID = messages.MsgID

BounceCount

INTEGER

BounceDate

STRING

BounceDetail

STRING

BounceReason

STRING

ContactID

STRING

EmailAddress

STRING

MsgID

INTEGER

message_clicks

The message_clicks table contains info about contact clicks for a message.

Replication Method

Full Table

Primary Keys

MsgID

EmailAddress

Useful links

Listrak documentation

Listrak API method

Join message_clicks with	on
message_bounces	message_clicks.ContactID = message_bounces.ContactID message_clicks.MsgID = message_bounces.MsgID
message_opens	message_clicks.ContactID = message_opens.ContactID message_clicks.MsgID = message_opens.MsgID
message_reads	message_clicks.ContactID = message_reads.ContactID message_clicks.MsgID = message_reads.MsgID
message_unsubs	message_clicks.ContactID = message_unsubs.ContactID message_clicks.MsgID = message_unsubs.MsgID
subscribed_contacts	message_clicks.ContactID = subscribed_contacts.ContactID
message_sends	message_clicks.MsgID = message_sends.MsgID
messages	message_clicks.MsgID = messages.MsgID

ClickDate

STRING

ContactID

STRING

EmailAddress

STRING

LinkDescription

STRING

LinkUrl

STRING

MsgID

INTEGER

message_opens

The message_opens table contains info about contact opens for a message.

Replication Method

Full Table

Primary Keys

MsgID

EmailAddress

Useful links

Listrak documentation

Listrak API method

Join message_opens with	on
message_bounces	message_opens.ContactID = message_bounces.ContactID message_opens.MsgID = message_bounces.MsgID
message_clicks	message_opens.ContactID = message_clicks.ContactID message_opens.MsgID = message_clicks.MsgID
message_reads	message_opens.ContactID = message_reads.ContactID message_opens.MsgID = message_reads.MsgID
message_unsubs	message_opens.ContactID = message_unsubs.ContactID message_opens.MsgID = message_unsubs.MsgID
subscribed_contacts	message_opens.ContactID = subscribed_contacts.ContactID
message_sends	message_opens.MsgID = message_sends.MsgID
messages	message_opens.MsgID = messages.MsgID

ContactID

STRING

EmailAddress

STRING

MsgID

INTEGER

OpenDate

STRING

message_reads

The message_reads table contains info about contact reads for a message.

Replication Method

Full Table

Primary Keys

MsgID

EmailAddress

Useful links

Listrak documentation

Listrak API method

Join message_reads with	on
message_bounces	message_reads.ContactID = message_bounces.ContactID message_reads.MsgID = message_bounces.MsgID
message_clicks	message_reads.ContactID = message_clicks.ContactID message_reads.MsgID = message_clicks.MsgID
message_opens	message_reads.ContactID = message_opens.ContactID message_reads.MsgID = message_opens.MsgID
message_unsubs	message_reads.ContactID = message_unsubs.ContactID message_reads.MsgID = message_unsubs.MsgID
subscribed_contacts	message_reads.ContactID = subscribed_contacts.ContactID
message_sends	message_reads.MsgID = message_sends.MsgID
messages	message_reads.MsgID = messages.MsgID

ContactID

STRING

EmailAddress

STRING

MsgID

INTEGER

ReadDate

STRING

message_sends

The message_sends table contains MsgID and EmailAddress pairs, allowing you to identify the messages that your contacts have been sent.

Replication Method

Full Table

Primary Keys

MsgID

EmailAddress

Useful links

Listrak documentation

Listrak API method

Join message_sends with	on
message_bounces	message_sends.MsgID = message_bounces.MsgID
message_clicks	message_sends.MsgID = message_clicks.MsgID
message_opens	message_sends.MsgID = message_opens.MsgID
message_reads	message_sends.MsgID = message_reads.MsgID
message_unsubs	message_sends.MsgID = message_unsubs.MsgID
messages	message_sends.MsgID = messages.MsgID

EmailAddress

STRING

MsgID

INTEGER

message_unsubs

The message_unsubs table contains info about contacts who requested to be removed from a list from the supplied message.

Replication Method

Full Table

Primary Keys

MsgID

EmailAddress

Useful links

Listrak documentation

Listrak API method

Join message_unsubs with	on
message_bounces	message_unsubs.ContactID = message_bounces.ContactID message_unsubs.MsgID = message_bounces.MsgID
message_clicks	message_unsubs.ContactID = message_clicks.ContactID message_unsubs.MsgID = message_clicks.MsgID
message_opens	message_unsubs.ContactID = message_opens.ContactID message_unsubs.MsgID = message_opens.MsgID
message_reads	message_unsubs.ContactID = message_reads.ContactID message_unsubs.MsgID = message_reads.MsgID
subscribed_contacts	message_unsubs.ContactID = subscribed_contacts.ContactID
message_sends	message_unsubs.MsgID = message_sends.MsgID
messages	message_unsubs.MsgID = messages.MsgID

AdditionDate

STRING

ContactID

STRING

EmailAddress

STRING

MsgID

INTEGER

RemovalDate

STRING

RemovalMethod

STRING

messages

The messages table contains info about message statistics.

Replication Method

Full Table

Primary Key

MsgID

Useful links

Listrak documentation

Listrak API method

Join messages with	on
message_bounces	messages.MsgID = message_bounces.MsgID
message_clicks	messages.MsgID = message_clicks.MsgID
message_opens	messages.MsgID = message_opens.MsgID
message_reads	messages.MsgID = message_reads.MsgID
message_sends	messages.MsgID = message_sends.MsgID
message_unsubs	messages.MsgID = message_unsubs.MsgID
lists	messages.ListID = lists.ListID
subscribed_contacts	messages.ListID = subscribed_contacts.ListID

AverageOrderValue

NUMBER

ClickCount

INTEGER

ClickerCount

INTEGER

ClickerPercent

NUMBER

ConversionCount

INTEGER

DeliverCount

INTEGER

ListID

INTEGER

MsgID

INTEGER

NewClickerCount

INTEGER

OpenCount

INTEGER

OpenPercent

NUMBER

OrderTotal

NUMBER

ReadCount

INTEGER

ReadPercent

NUMBER

RemoveCount

INTEGER

RemovePercent

NUMBER

RepeatClickerCount

INTEGER

SendDate

DATE-TIME

Subject

STRING

subscribed_contacts

The subscribed_contacts table contains info about contacts who are currently subscribed to the specified list.

Replication Method

Full Table

Primary Keys

ContactID

ListID

Useful links

Listrak documentation

Listrak API method

Join subscribed_contacts with	on
message_bounces	subscribed_contacts.ContactID = message_bounces.ContactID
message_clicks	subscribed_contacts.ContactID = message_clicks.ContactID
message_opens	subscribed_contacts.ContactID = message_opens.ContactID
message_reads	subscribed_contacts.ContactID = message_reads.ContactID
message_unsubs	subscribed_contacts.ContactID = message_unsubs.ContactID
lists	subscribed_contacts.ListID = lists.ListID
messages	subscribed_contacts.ListID = messages.ListID

AdditionDate

DATE-TIME

AdditionMethod

STRING

ContactID

STRING

EmailAddress

STRING

ListID

INTEGER

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