Listrak integration summary

Stitch’s Listrak integration replicates data using the Listrak SOAP API. Refer to the Schema section for a list of objects available for replication.

Listrak feature snapshot

A high-level look at Stitch's Listrak (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on June 27, 2018

 Supported by

Singer Community
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-listrak
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Unsupported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Supported

 Column selection

Unsupported
Select all

Supported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Listrak

Step 1: Create a Listrak Stitch user

  1. Sign into your Listrak account.
  2. From the home page, click Manage.
  3. Click Accounts > User Manager.
  4. Scroll to the bottom of the page and click Create New User.
  5. Fill in the User Information fields.
  6. In the Lists section, select the lists you want the Stitch user to have access to. Note: Stitch will only be able to replicate data for lists that it is able to access.
  7. For Granted Access, select Role Based Access.
  8. In the section below this field, select check the boxes for the following permissions:
    • Analytics Access - This allows the Stitch user to view analytics for messages, contacts, and lists for available lists.
    • API Access - This allows the Stitch user to replicate data from your Listrak using the Listrak API.
  9. Click Add User when finished.

Step 2: Add Stitch IP Addresses to Listrak's SOAP API whitelist

To ensure Stitch can access your Listrak instance, you’ll need to whitelist Stitch’s IP addresses.

Step 2.1: Verify your Stitch account's data pipeline region

The IP addresses you’ll whitelist depend on the Data pipeline region your account is in.

  1. Sign into your Stitch account, if you haven’t already.
  2. Click User menu (your icon) > Manage Account Settings and locate the Data pipeline region section to verify your account’s region.

  3. Locate the list of IP addresses for your region:

Keep this list handy - you’ll need it in the next step.

Step 2.2: Add the IP addresses to the SOAP API whitelist

  1. In your Listrak account, navigate to Manage > Accounts > SOAP API IP Authorization.
  2. Add the Stitch IP addresses that you retrieved in the previous step.

Step 3: Add Listrak as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Listrak icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Listrak” would create a schema called stitch_listrak in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Username field, enter the Stitch Listrak user’s username.
  6. In the Password field, enter the Stitch Listrak user’s password.

Step 4: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Listrak integration. This means that:

  • For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

Change this setting if you want to replicate data beyond Listrak’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 5: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Listrak integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Listrak, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Listrak table reference

lists

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

ListID
API endpoint :

GetContactListCollection

The lists table contains info about your contact lists.

lists table schema

ListID
INTEGER

The list ID.

Reference:

bounceHandling
INTEGER

Indicates how bounces are handled for the list.

BounceUnsubscribeCount
INTEGER

The number of bounces allowed before being automatically unsubscribed from the list.

CreateDate
STRING

The time the list was created.

DomainAliasEmail
STRING

The alias email for emails in the list’s messages.

DomainAliasLink
STRING

The alias domain for links in the list’s messages.

EnableBrowserLink
BOOLEAN

If true, browser links are enabled for the list.

EnableDoubleOptin
BOOLEAN

If true, double opt-in is enabled for the list.

EnableDynamicContent
BOOLEAN

If true, dynamic content is enabled for the list.

EnableGoogleAnalytics
BOOLEAN

If true, Google Analytics is enabled for the list.

EnableInternationalization
BOOLEAN

If true, internationalization is enabled for the list.

EnableListHygiene
BOOLEAN

If true, list hygiene is enabled for the list.

EnableListRemoveHeader
BOOLEAN

If true, unsubscribe information is automatically included in message headers.

EnableRemovalLink
BOOLEAN

If true, list removal links are automatically included for the list.

EnableRSS
BOOLEAN

If true, RSS is enabled for the list.

FromName
STRING

The From name used by default when sending messages to the list.

FromEmail
STRING

The From email used by default when sending messages to the list.

GoogleTrackingDomains
ARRAY

The Google tracking domains associated with the list.

Click to expand GoogleTrackingDomains

GoogleTrackingDomains
STRING

The Google tracking domain.
lists (table), GoogleTrackingDomains (attribute)

ListName
STRING

The name of the list.

ShowAdvancedPersonalization
BOOLEAN

If true, advanced personalization is enabled for the list.

messages

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

MsgID
API endpoint :

ReportListMessageActivity

The messages table contains info about message statistics.

messages table schema

MsgID
INTEGER

The message ID.

Reference:

AverageOrderValue
NUMBER

The average order value associated with the message.

ClickCount
INTEGER

The current number of clicks for the message.

ClickerCount
INTEGER

The current number of contacts who clicked for the message.

ClickerPercent
NUMBER

The percent of contacts who clicked the message.

ConversionCount
INTEGER

The current number of conversions for the message.

DeliverCount
INTEGER

The current number of messages delivered.

ListID
INTEGER

The ID of the list the message was sent to.

Reference:

NewClickerCount
INTEGER

The current number of new clickers for the message.

OpenCount
INTEGER

The current number of opens for the message.

OpenPercent
NUMBER

The percentage of contacts who opened the message.

OrderTotal
NUMBER

The order total associated with the message.

ReadCount
INTEGER

The current number of reads for the message.

ReadPercent
NUMBER

The percentage of contacts who read the message.

RemovePercent
NUMBER

The percentage of contacts who unsubscribed as a result of the message.

RemoveCount
INTEGER

The current number of unsubscribes for the message.

RepeatClickerCount
INTEGER

The current number of contacts who clicked multiple times for the message.

SendDate
STRING

The date the message was sent.

Subject
STRING

The subject of the message.

message_bounces

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

MsgID : EmailAddress
API endpoint :

ReportRangeMessageContactBounces

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

message_bounces table schema

MsgID
INTEGER

The ID of the message that bounced.

Reference:

EmailAddress
STRING

The email address associated with the bounce.

ContactID
STRING

The ID of the contact that the bounced message was sent to.

Reference:

BounceReason
STRING

An explanation for the reason for the bounce.

BounceDetail
STRING

Additional detail about the bounce.

BounceDate
STRING

The date that the bounce occurred.

BounceCount
INTEGER

The number of bounces for the message.

message_clicks

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

MsgID : EmailAddress
API endpoint :

ReportRangeMessageContactClick

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

message_clicks table schema

MsgID
INTEGER

The message ID that contains the link that was clicked.

Reference:

EmailAddress
STRING

The email address of the contact who clicked the link.

ContactID
STRING

The ID of the contact who clicked the link.

Reference:

LinkUrl
STRING

The URL of the link.

ClickDate
STRING

The date the contact clicked the link.

LinkDescription
STRING

A description of the link.

message_opens

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

MsgID : EmailAddress
API endpoint :

ReportRangeMessageContactOpen

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

message_opens table schema

MsgID
INTEGER

The ID of the message that was opened.

Reference:

EmailAddress
STRING

The email address of the contact that opened the email.

ContactID
STRING

The ID of the contact that opened the email.

Reference:

OpenDate
STRING

The date the contact opened the email.

message_reads

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

MsgID : EmailAddress
API endpoint :

ReportRangeMessageContactRead

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

message_reads table schema

MsgID
INTEGER

The ID of the message that was read.

Reference:

EmailAddress
STRING

The email address of the contact who read the message.

ContactID
STRING

The ID of the contact who read the message.

Reference:

ReadDate
STRING

The date the contact read the message.

message_sends

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

MsgID : EmailAddress
API endpoint :

ReportMessageContactSent

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

message_sends table schema

MsgID
INTEGER

The ID of the message that was sent.

Reference:

EmailAddress
STRING

The email address that the message was sent to.

message_unsubs

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

MsgID : EmailAddress
API endpoint :

ReportRangeMessageContactRemoval

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

message_unsubs table schema

MsgID
INTEGER

The ID of the message that resulted in the unsubscribe.

Reference:

EmailAddress
STRING

The email address that requested the unsubscribe.

ContactID
STRING

The ID of the contact who unsubscribed.

Reference:

AdditionDate
STRING

The date the contact initially subscribed.

RemovalDate
STRING

The date the contact unsubscribed.

RemovalMethod
STRING

The method the contact used to unsubscribe.

subscribed_contacts

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

ContactID : ListID
API endpoint :

ReportRangeSubscribedContacts

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

subscribed_contacts table schema

ContactID
STRING

The ID of the contact.

Reference:

ListID
INTEGER

The ID of the list the contact is subscribed to.

Reference:

AdditionDate
STRING

The date the contact was added to the list.

AdditionMethod
STRING

The method used to add the contact to the list.

EmailAddress
STRING

The email address associated with the contact.
Related Troubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.