Iterable Core (v1) | Stitch Documentation

Iterable is in beta
Iterable is currently in beta. The info in this guide is subject to change.

Iterable extraction is supported by Stitch
This integration is powered by Singer's Iterable tap and certified by Stitch. Check out and contribute to the repo on GitHub.

For support, contact Stitch support.

Iterable integration summary

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

Iterable feature snapshot

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

STITCH
Release status	Beta	Supported by	Stitch
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-iterable
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Iterable

Iterable setup requirements

To set up Iterable in Stitch, you need:

You must be an org admin or a user with API and Webhook configuration permissions in your Iterable account.

Step 1: Generate an Iterable API key

Sign into you Iterable account.
Navigate to Integrations>API Keys.
Click New API Key.
In the Create a new API key window, name your API key and select read-only.
Click Create.
Copy your new API key and have it ready for the next step.

Step 2: Add Iterable as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Iterable icon.
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 Iterable” would create a schema called stitch_iterable in the destination. Note: Schema names cannot be changed after you save the integration.
In the Iterable API Key field, paste the API key you copied in step 1.
In the API Window in Days field, enter a value. This parameter should be set to an optimum value to improve historical sync performance. Setting this value too low will take longer to complete historical sync and setting it larger may result in request timeouts or memory overflow issues.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Iterable integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

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

Step 4: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

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.

Iterable integrations support the following replication scheduling methods:

Replication Frequency
Anchor Scheduling
Advanced Scheduling using Cron (Advanced or Premium plans only)

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.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements for selection and replication.

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Iterable integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’s Tables to Replicate tab, locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
Repeat this process for all the tables and columns you want to replicate.
When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Important: Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections. Refer to the Select All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click the Tables to Replicate tab.
In the list of tables, click the box next to the Table Names column.
In the menu that displays, click Track all Tables and Fields:
Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Iterable, 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.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

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.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

Iterable table reference

Schemas and versioning

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for version 1 of this integration.

This is the latest version of the Iterable integration.

Table and column names in your destination

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

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

campaigns

The campaigns table contains information about campaigns in your Iterable projcect.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	updatedAt
Useful links	campaigns schema on GitHub Iterable API method

campaigns table foreign keys

Join campaigns with	on
email_bounce	campaigns.id = email_bounce.campaignId campaigns.templateId = email_bounce.templateId
email_click	campaigns.id = email_click.campaignId campaigns.templateId = email_click.templateId
email_complaint	campaigns.id = email_complaint.campaignId campaigns.templateId = email_complaint.templateId
email_open	campaigns.id = email_open.campaignId campaigns.templateId = email_open.templateId
email_send	campaigns.id = email_send.campaignId campaigns.templateId = email_send.templateId
email_send_skip	campaigns.id = email_send_skip.campaignId campaigns.templateId = email_send_skip.templateId
email_subscribe	campaigns.id = email_subscribe.campaignId campaigns.templateId = email_subscribe.templateId
email_unsubscribe	campaigns.id = email_unsubscribe.campaignId campaigns.templateId = email_unsubscribe.templateId
templates	campaigns.id = templates.campaignId campaigns.templateId = templates.templateId

campaigns table schema

campaignState

STRING

createdAt

DATE-TIME

createdByUserId

STRING

endedAt

DATE-TIME

INTEGER

labels

ARRAY

listIds

ARRAY

messageMedium

STRING

name

STRING

recurringCampaignId

INTEGER

sendSize

NUMBER

startAt

DATE-TIME

suppressionListIds

ARRAY

templateId

INTEGER

type

STRING

updatedAt

DATE-TIME

updatedByUserId

STRING

workflowId

INTEGER

channels

The channels table contains information about all channels within your Iterable project.

Replication Method

Full Table

Primary Key

Useful links

channels schema on GitHub

Iterable API method

channels table foreign keys

Join channels with	on
email_send	channels.id = email_send.channelId
email_send_skip	channels.id = email_send_skip.channelId
email_subscribe	channels.id = email_subscribe.channelIds.items
email_unsubscribe	channels.id = email_unsubscribe.channelIds.items channels.id = email_unsubscribe.channelId
message_types	channels.id = message_types.channelId

channels table schema

channelType

STRING

INTEGER

messageMedium

STRING

name

STRING

email_bounce

The email_bounce table contains information about bounced emails within your Iterable campaign.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	createdAt
Useful links	email_bounce schema on GitHub Iterable API method

email_bounce table foreign keys

Join email_bounce with	on
campaigns	email_bounce.campaignId = campaigns.id email_bounce.templateId = campaigns.templateId
email_click	email_bounce.campaignId = email_click.campaignId email_bounce.email = email_click.email email_bounce.templateId = email_click.templateId
email_complaint	email_bounce.campaignId = email_complaint.campaignId email_bounce.email = email_complaint.email email_bounce.templateId = email_complaint.templateId
email_open	email_bounce.campaignId = email_open.campaignId email_bounce.email = email_open.email email_bounce.templateId = email_open.templateId
email_send	email_bounce.campaignId = email_send.campaignId email_bounce.email = email_send.email email_bounce.templateId = email_send.templateId
email_send_skip	email_bounce.campaignId = email_send_skip.campaignId email_bounce.email = email_send_skip.email email_bounce.templateId = email_send_skip.templateId
email_subscribe	email_bounce.campaignId = email_subscribe.campaignId email_bounce.email = email_subscribe.email email_bounce.templateId = email_subscribe.templateId
email_unsubscribe	email_bounce.campaignId = email_unsubscribe.campaignId email_bounce.email = email_unsubscribe.email email_bounce.templateId = email_unsubscribe.templateId
templates	email_bounce.campaignId = templates.campaignId email_bounce.templateId = templates.templateId
users	email_bounce.email = users.email
list_users	email_bounce.email = list_users.email

email_bounce table schema

campaignId

INTEGER

createdAt

DATE-TIME

email

STRING

eventName

STRING

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

messageId

STRING

recipientState

STRING

status

STRING

templateId

INTEGER

email_click

The email_click table contains information about clicks on your Iterable email campaign.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	createdAt
Useful links	email_click schema on GitHub Iterable API method

email_click table foreign keys

Join email_click with	on
campaigns	email_click.campaignId = campaigns.id email_click.templateId = campaigns.templateId
email_bounce	email_click.campaignId = email_bounce.campaignId email_click.email = email_bounce.email email_click.templateId = email_bounce.templateId
email_complaint	email_click.campaignId = email_complaint.campaignId email_click.email = email_complaint.email email_click.templateId = email_complaint.templateId
email_open	email_click.campaignId = email_open.campaignId email_click.email = email_open.email email_click.templateId = email_open.templateId
email_send	email_click.campaignId = email_send.campaignId email_click.email = email_send.email email_click.templateId = email_send.templateId
email_send_skip	email_click.campaignId = email_send_skip.campaignId email_click.email = email_send_skip.email email_click.templateId = email_send_skip.templateId
email_subscribe	email_click.campaignId = email_subscribe.campaignId email_click.email = email_subscribe.email email_click.templateId = email_subscribe.templateId
email_unsubscribe	email_click.campaignId = email_unsubscribe.campaignId email_click.email = email_unsubscribe.email email_click.templateId = email_unsubscribe.templateId
templates	email_click.campaignId = templates.campaignId email_click.templateId = templates.templateId
users	email_click.email = users.email
list_users	email_click.email = list_users.email

email_click table schema

campaignId

INTEGER

city

STRING

contentId

INTEGER

country

STRING

createdAt

DATE-TIME

email

STRING

eventName

STRING

hrefIndex

INTEGER

STRING

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

messageId

STRING

region

STRING

templateId

INTEGER

url

STRING

userAgent

STRING

userAgentDevice

STRING

email_complaint

The email_complaint table contains information about email recipients that sent complaints for your Iterable campain.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	createdAt
Useful links	email_complaint schema on GitHub Iterable API method

email_complaint table foreign keys

Join email_complaint with	on
campaigns	email_complaint.campaignId = campaigns.id email_complaint.templateId = campaigns.templateId
email_bounce	email_complaint.campaignId = email_bounce.campaignId email_complaint.email = email_bounce.email email_complaint.templateId = email_bounce.templateId
email_click	email_complaint.campaignId = email_click.campaignId email_complaint.email = email_click.email email_complaint.templateId = email_click.templateId
email_open	email_complaint.campaignId = email_open.campaignId email_complaint.email = email_open.email email_complaint.templateId = email_open.templateId
email_send	email_complaint.campaignId = email_send.campaignId email_complaint.email = email_send.email email_complaint.templateId = email_send.templateId
email_send_skip	email_complaint.campaignId = email_send_skip.campaignId email_complaint.email = email_send_skip.email email_complaint.templateId = email_send_skip.templateId
email_subscribe	email_complaint.campaignId = email_subscribe.campaignId email_complaint.email = email_subscribe.email email_complaint.templateId = email_subscribe.templateId
email_unsubscribe	email_complaint.campaignId = email_unsubscribe.campaignId email_complaint.email = email_unsubscribe.email email_complaint.templateId = email_unsubscribe.templateId
templates	email_complaint.campaignId = templates.campaignId email_complaint.templateId = templates.templateId
users	email_complaint.email = users.email
list_users	email_complaint.email = list_users.email

email_complaint table schema

campaignId

INTEGER

createdAt

DATE-TIME

email

STRING

eventName

STRING

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

messageId

STRING

recipientState

STRING

templateId

INTEGER

email_open

The email_open table contains information about email recipients that opened your Iterable campaign.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	createdAt
Useful links	email_open schema on GitHub Iterable API method

email_open table foreign keys

Join email_open with	on
campaigns	email_open.campaignId = campaigns.id email_open.templateId = campaigns.templateId
email_bounce	email_open.campaignId = email_bounce.campaignId email_open.email = email_bounce.email email_open.templateId = email_bounce.templateId
email_click	email_open.campaignId = email_click.campaignId email_open.email = email_click.email email_open.templateId = email_click.templateId
email_complaint	email_open.campaignId = email_complaint.campaignId email_open.email = email_complaint.email email_open.templateId = email_complaint.templateId
email_send	email_open.campaignId = email_send.campaignId email_open.email = email_send.email email_open.templateId = email_send.templateId
email_send_skip	email_open.campaignId = email_send_skip.campaignId email_open.email = email_send_skip.email email_open.templateId = email_send_skip.templateId
email_subscribe	email_open.campaignId = email_subscribe.campaignId email_open.email = email_subscribe.email email_open.templateId = email_subscribe.templateId
email_unsubscribe	email_open.campaignId = email_unsubscribe.campaignId email_open.email = email_unsubscribe.email email_open.templateId = email_unsubscribe.templateId
templates	email_open.campaignId = templates.campaignId email_open.templateId = templates.templateId
users	email_open.email = users.email
list_users	email_open.email = list_users.email

email_open table schema

campaignId

INTEGER

city

STRING

contentId

INTEGER

country

STRING

createdAt

DATE-TIME

email

STRING

eventName

STRING

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

messageId

STRING

proxySource

STRING

region

STRING

templateId

INTEGER

userAgent

STRING

userAgentDevice

STRING

email_send

The email_send table contains information about campaign emails you sent in your Iterable account.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	createdAt
Useful links	email_send schema on GitHub Iterable API method

email_send table foreign keys

Join email_send with	on
campaigns	email_send.campaignId = campaigns.id email_send.templateId = campaigns.templateId
email_bounce	email_send.campaignId = email_bounce.campaignId email_send.email = email_bounce.email email_send.templateId = email_bounce.templateId
email_click	email_send.campaignId = email_click.campaignId email_send.email = email_click.email email_send.templateId = email_click.templateId
email_complaint	email_send.campaignId = email_complaint.campaignId email_send.email = email_complaint.email email_send.templateId = email_complaint.templateId
email_open	email_send.campaignId = email_open.campaignId email_send.email = email_open.email email_send.templateId = email_open.templateId
email_send_skip	email_send.campaignId = email_send_skip.campaignId email_send.channelId = email_send_skip.channelId email_send.email = email_send_skip.email email_send.templateId = email_send_skip.templateId
email_subscribe	email_send.campaignId = email_subscribe.campaignId email_send.channelId = email_subscribe.channelIds.items email_send.email = email_subscribe.email email_send.templateId = email_subscribe.templateId
email_unsubscribe	email_send.campaignId = email_unsubscribe.campaignId email_send.channelId = email_unsubscribe.channelIds.items email_send.channelId = email_unsubscribe.channelId email_send.email = email_unsubscribe.email email_send.templateId = email_unsubscribe.templateId
templates	email_send.campaignId = templates.campaignId email_send.templateId = templates.templateId
channels	email_send.channelId = channels.id
message_types	email_send.channelId = message_types.channelId
users	email_send.email = users.email
list_users	email_send.email = list_users.email

email_send table schema

campaignId

INTEGER

catalogCollectionCount

INTEGER

catalogLookupCount

INTEGER

channelId

INTEGER

contentId

INTEGER

createdAt

DATE-TIME

email

STRING

espName

STRING

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

messageBusId

STRING

messageId

STRING

messageTypeId

INTEGER

productRecommendationCount

INTEGER

templateId

INTEGER

transactionalData

OBJECT

Click to expand transactionalData

campaignId

INTEGER

categories

ARRAY

compare_at_price

NUMBER

createdAt

DATE-TIME

description

STRING

discount

INTEGER

email

STRING

eventName

STRING

eventUpdatedAt

DATE-TIME

handle

STRING

imageUrl

STRING

inventory

INTEGER

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

name

STRING

price

INTEGER

product_id

STRING

product_type

STRING

sku

STRING

templateId

INTEGER

url

STRING

vendor

STRING

email_send_skip

The email_send_skip table contains information about campaign email recipients that were skipped in your Iterable account.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	createdAt
Useful links	email_send_skip schema on GitHub Iterable API method

email_send_skip table foreign keys

Join email_send_skip with	on
campaigns	email_send_skip.campaignId = campaigns.id email_send_skip.templateId = campaigns.templateId
email_bounce	email_send_skip.campaignId = email_bounce.campaignId email_send_skip.email = email_bounce.email email_send_skip.templateId = email_bounce.templateId
email_click	email_send_skip.campaignId = email_click.campaignId email_send_skip.email = email_click.email email_send_skip.templateId = email_click.templateId
email_complaint	email_send_skip.campaignId = email_complaint.campaignId email_send_skip.email = email_complaint.email email_send_skip.templateId = email_complaint.templateId
email_open	email_send_skip.campaignId = email_open.campaignId email_send_skip.email = email_open.email email_send_skip.templateId = email_open.templateId
email_send	email_send_skip.campaignId = email_send.campaignId email_send_skip.channelId = email_send.channelId email_send_skip.email = email_send.email email_send_skip.templateId = email_send.templateId
email_subscribe	email_send_skip.campaignId = email_subscribe.campaignId email_send_skip.channelId = email_subscribe.channelIds.items email_send_skip.email = email_subscribe.email email_send_skip.templateId = email_subscribe.templateId
email_unsubscribe	email_send_skip.campaignId = email_unsubscribe.campaignId email_send_skip.channelId = email_unsubscribe.channelIds.items email_send_skip.channelId = email_unsubscribe.channelId email_send_skip.email = email_unsubscribe.email email_send_skip.templateId = email_unsubscribe.templateId
templates	email_send_skip.campaignId = templates.campaignId email_send_skip.templateId = templates.templateId
channels	email_send_skip.channelId = channels.id
message_types	email_send_skip.channelId = message_types.channelId
users	email_send_skip.email = users.email
list_users	email_send_skip.email = list_users.email

email_send_skip table schema

campaignId

INTEGER

channelId

INTEGER

contentId

INTEGER

createdAt

DATE-TIME

email

STRING

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

messageId

STRING

messageTypeId

INTEGER

reason

STRING

templateId

INTEGER

transactionalData

OBJECT

Click to expand transactionalData

campaignId

INTEGER

categories

ARRAY

compare_at_price

NUMBER

createdAt

DATE-TIME

description

STRING

discount

INTEGER

email

STRING

eventName

STRING

eventUpdatedAt

DATE-TIME

handle

STRING

imageUrl

STRING

inventory

INTEGER

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

name

STRING

price

INTEGER

product_id

STRING

product_type

STRING

sku

STRING

templateId

INTEGER

url

STRING

vendor

STRING

The email_subscribe table contains information about emails subscribed to your Iterable campaign.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	createdAt
Useful links	email_subscribe schema on GitHub Iterable API method

email_subscribe table foreign keys

Join email_subscribe with	on
campaigns	email_subscribe.campaignId = campaigns.id email_subscribe.templateId = campaigns.templateId
email_bounce	email_subscribe.campaignId = email_bounce.campaignId email_subscribe.email = email_bounce.email email_subscribe.templateId = email_bounce.templateId
email_click	email_subscribe.campaignId = email_click.campaignId email_subscribe.email = email_click.email email_subscribe.templateId = email_click.templateId
email_complaint	email_subscribe.campaignId = email_complaint.campaignId email_subscribe.email = email_complaint.email email_subscribe.templateId = email_complaint.templateId
email_open	email_subscribe.campaignId = email_open.campaignId email_subscribe.email = email_open.email email_subscribe.templateId = email_open.templateId
email_send	email_subscribe.campaignId = email_send.campaignId email_subscribe.channelIds.items = email_send.channelId email_subscribe.email = email_send.email email_subscribe.templateId = email_send.templateId
email_send_skip	email_subscribe.campaignId = email_send_skip.campaignId email_subscribe.channelIds.items = email_send_skip.channelId email_subscribe.email = email_send_skip.email email_subscribe.templateId = email_send_skip.templateId
email_unsubscribe	email_subscribe.campaignId = email_unsubscribe.campaignId email_subscribe.channelIds.items = email_unsubscribe.channelIds.items email_subscribe.channelIds.items = email_unsubscribe.channelId email_subscribe.email = email_unsubscribe.email email_subscribe.templateId = email_unsubscribe.templateId
templates	email_subscribe.campaignId = templates.campaignId email_subscribe.templateId = templates.templateId
channels	email_subscribe.channelIds.items = channels.id
message_types	email_subscribe.channelIds.items = message_types.channelId
users	email_subscribe.email = users.email
list_users	email_subscribe.email = list_users.email

email_subscribe table schema

campaignId

INTEGER

channelIds

ARRAY

createdAt

DATE-TIME

email

STRING

emailListId

INTEGER

emailListIds

ARRAY

eventName

STRING

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

profileUpdatedAt

DATE-TIME

signupSource

STRING

templateId

INTEGER

userId

STRING

workflowId

INTEGER

email_unsubscribe

The email_unsubscribe table contains information about emails unsubscribed from your Iterable campaign.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	createdAt
Useful links	email_unsubscribe schema on GitHub Iterable API method

email_unsubscribe table foreign keys

Join email_unsubscribe with	on
campaigns	email_unsubscribe.campaignId = campaigns.id email_unsubscribe.templateId = campaigns.templateId
email_bounce	email_unsubscribe.campaignId = email_bounce.campaignId email_unsubscribe.email = email_bounce.email email_unsubscribe.templateId = email_bounce.templateId
email_click	email_unsubscribe.campaignId = email_click.campaignId email_unsubscribe.email = email_click.email email_unsubscribe.templateId = email_click.templateId
email_complaint	email_unsubscribe.campaignId = email_complaint.campaignId email_unsubscribe.email = email_complaint.email email_unsubscribe.templateId = email_complaint.templateId
email_open	email_unsubscribe.campaignId = email_open.campaignId email_unsubscribe.email = email_open.email email_unsubscribe.templateId = email_open.templateId
email_send	email_unsubscribe.campaignId = email_send.campaignId email_unsubscribe.channelIds.items = email_send.channelId email_unsubscribe.channelId = email_send.channelId email_unsubscribe.email = email_send.email email_unsubscribe.templateId = email_send.templateId
email_send_skip	email_unsubscribe.campaignId = email_send_skip.campaignId email_unsubscribe.channelIds.items = email_send_skip.channelId email_unsubscribe.channelId = email_send_skip.channelId email_unsubscribe.email = email_send_skip.email email_unsubscribe.templateId = email_send_skip.templateId
email_subscribe	email_unsubscribe.campaignId = email_subscribe.campaignId email_unsubscribe.channelIds.items = email_subscribe.channelIds.items email_unsubscribe.channelId = email_subscribe.channelIds.items email_unsubscribe.email = email_subscribe.email email_unsubscribe.templateId = email_subscribe.templateId
templates	email_unsubscribe.campaignId = templates.campaignId email_unsubscribe.templateId = templates.templateId
channels	email_unsubscribe.channelIds.items = channels.id email_unsubscribe.channelId = channels.id
message_types	email_unsubscribe.channelIds.items = message_types.channelId email_unsubscribe.channelId = message_types.channelId
users	email_unsubscribe.email = users.email
list_users	email_unsubscribe.email = list_users.email

email_unsubscribe table schema

bounceMessage

STRING

campaignId

INTEGER

channelId

INTEGER

channelIds

ARRAY

createdAt

DATE-TIME

email

STRING

emailListId

INTEGER

emailListIds

ARRAY

eventName

STRING

itblInternal

OBJECT

Click to expand itblInternal

documentCreatedAt

DATE-TIME

documentUpdatedAt

DATE-TIME

messageId

STRING

recipientState

STRING

status

STRING

templateId

INTEGER

unsubSource

STRING

workflowId

INTEGER

list_users

The list_users table contains information about users in a list in your Iterable account.

Replication Method

Full Table

Primary Keys

listId

Useful links

list_users schema on GitHub

Iterable API method

list_users table foreign keys

Join list_users with	on
users	list_users.email = users.email
email_bounce	list_users.email = email_bounce.email
email_click	list_users.email = email_click.email
email_complaint	list_users.email = email_complaint.email
email_open	list_users.email = email_open.email
email_send	list_users.email = email_send.email
email_send_skip	list_users.email = email_send_skip.email
email_subscribe	list_users.email = email_subscribe.email
email_unsubscribe	list_users.email = email_unsubscribe.email
lists	list_users.listId = lists.id

list_users table schema

email

STRING

listId

INTEGER

updatedAt

DATE-TIME

lists

The lists tablecontains information about lists within your Iterable project.

Replication Method

Full Table

Primary Key

Useful links

lists schema on GitHub

Iterable API method

lists table foreign keys

Join lists with	on
list_users	lists.id = list_users.listId

lists table schema

createdAt

DATE-TIME

description

STRING

INTEGER

listType

STRING

name

STRING

message_types

The message_types table contains information about all message types within your Iterable project.

Replication Method

Full Table

Primary Key

Useful links

message_types schema on GitHub

Iterable API method

message_types table foreign keys

Join message_types with	on
channels	message_types.channelId = channels.id
email_send	message_types.channelId = email_send.channelId
email_send_skip	message_types.channelId = email_send_skip.channelId
email_subscribe	message_types.channelId = email_subscribe.channelIds.items
email_unsubscribe	message_types.channelId = email_unsubscribe.channelIds.items message_types.channelId = email_unsubscribe.channelId
templates	message_types.id = templates.messageTypeId

message_types table schema

channelId

INTEGER

createdAt

DATE-TIME

INTEGER

name

STRING

subscriptionPolicy

STRING

updatedAt

DATE-TIME

metadata

The metadata table contains the metadata for a single key in your Iterable account.

Replication Method

Full Table

Primary Key

key

Useful links

metadata schema on GitHub

Iterable API method

metadata table schema

key

STRING

lastModified

DATE-TIME

size

INTEGER

table

STRING

value

OBJECT

Click to expand value

categories

ARRAY

compare_at_price

NUMBER

description

STRING

discount

INTEGER

handle

STRING

imageUrl

STRING

inventory

INTEGER

name

STRING

price

INTEGER

product_id

STRING

product_type

STRING

sku

STRING

url

STRING

vendor

STRING

templates

The templates table contains information about project templates in you Iterable account.

Replication Method	Key-based Incremental
Primary Key	templateId
Replication Key	updatedAt
Useful links	templates schema on GitHub Iterable API method

templates table foreign keys

Join templates with	on
campaigns	templates.campaignId = campaigns.id templates.templateId = campaigns.templateId
email_bounce	templates.campaignId = email_bounce.campaignId templates.templateId = email_bounce.templateId
email_click	templates.campaignId = email_click.campaignId templates.templateId = email_click.templateId
email_complaint	templates.campaignId = email_complaint.campaignId templates.templateId = email_complaint.templateId
email_open	templates.campaignId = email_open.campaignId templates.templateId = email_open.templateId
email_send	templates.campaignId = email_send.campaignId templates.templateId = email_send.templateId
email_send_skip	templates.campaignId = email_send_skip.campaignId templates.templateId = email_send_skip.templateId
email_subscribe	templates.campaignId = email_subscribe.campaignId templates.templateId = email_subscribe.templateId
email_unsubscribe	templates.campaignId = email_unsubscribe.campaignId templates.templateId = email_unsubscribe.templateId
message_types	templates.messageTypeId = message_types.id

templates table schema

campaignId

INTEGER

clientTemplateId

STRING

createdAt

DATE-TIME

creatorUserId

STRING

messageTypeId

INTEGER

name

STRING

templateId

INTEGER

updatedAt

DATE-TIME

users

The users table contains information about all users in your Iterable account.

Replication Method	Key-based Incremental
Primary Key	email
Replication Key	profileUpdatedAt
Useful links	Iterable documentation users schema on GitHub Iterable API method

users table foreign keys

Join users with	on
email_bounce	users.email = email_bounce.email
email_click	users.email = email_click.email
email_complaint	users.email = email_complaint.email
email_open	users.email = email_open.email
email_send	users.email = email_send.email
email_send_skip	users.email = email_send_skip.email
email_subscribe	users.email = email_subscribe.email
email_unsubscribe	users.email = email_unsubscribe.email
list_users	users.email = list_users.email

users table schema

CCProvider

STRING

Industry

STRING

accessIp

STRING

acquisition_source

STRING

actively_seeking

BOOLEAN

age

INTEGER

auctionDigest

OBJECT

ARRAY

auctionDigest.auctionDateLocation

ARRAY

auctionDigest.auctionHouse

ARRAY

auctionDigest.auctionImageUrl

ARRAY

auctionDigest.auctionInfo

ARRAY

auctionDigest.name

ARRAY

averageOrderValue

NUMBER

badgeCount

INTEGER

bestFriend

STRING

booked_activity_before

BOOLEAN

booked_package_before

BOOLEAN

browserTokens

STRING

city

STRING

congressional Districts

STRING

counties

STRING

current_employer

STRING

current_employer_id

STRING

date_last_booked_package

DATE-TIME

daysSinceLastOrder

INTEGER

designation

STRING

devices

OBJECT

ARRAY

devices.applicationName

ARRAY

devices.endpointEnabled

ARRAY

devices.platform

ARRAY

devices.platformEndpoint

ARRAY

devices.token

ARRAY

email

STRING

emailListIds

ARRAY

estimatedSizing

STRING

experience

STRING

favoriteAnimal

STRING

favoriteCategories

OBJECT

ARRAY

favoriteCategories.category

ARRAY

favoriteCategory

STRING

favoriteCuisine

STRING

favoriteItem

STRING

favoriteProduct

STRING

favoriteRestaurant

STRING

favoriteShowCategories

STRING

favorite_category

STRING

favoritedShows

STRING

fb_follow

BOOLEAN

featuredDeal

STRING

firstName

STRING

gender

STRING

hasMobileApp

BOOLEAN

highestBidPrice

STRING

house Districts

STRING

industry

STRING

installedDropbox

BOOLEAN

installed_sync

BOOLEAN

interested_in_detergent

BOOLEAN

interested_in_soap

BOOLEAN

interested_in_toilet_paper

BOOLEAN

invoice

OBJECT

ARRAY

invoice.customAmount

ARRAY

invoice.customSubTotal

ARRAY

invoice.customerEmail

ARRAY

invoice.customerName

ARRAY

invoice.invoiceDate

ARRAY

invoice.invoiceNumber

ARRAY

invoice.merchantName

ARRAY

invoice.totalDue

ARRAY

is_active

BOOLEAN

is_available

BOOLEAN

itblInternal.emailDomain

STRING

jobRecommendations

OBJECT

ARRAY

jobRecommendations.applicationURL

ARRAY

jobRecommendations.description

ARRAY

jobRecommendations.id

ARRAY

jobRecommendations.imageUrl

ARRAY

jobRecommendations.name

ARRAY

job_categories_interested

STRING

job_title

STRING

lastAccessedAgent

STRING

lastKnownLatitude

NUMBER

lastKnownLongitude

NUMBER

lastName

STRING

lastOrderlocation

STRING

lastOrderrestaurant

STRING

last_game_played

STRING

last_purchased

STRING

last_purchased_category

STRING

last_session_date

DATE-TIME

level

INTEGER

lifetime Dontation

STRING

lifetime_Spent

STRING

locale

STRING

location

STRING

loyalty_member

BOOLEAN

loyalty_points

INTEGER

loyalty_program

BOOLEAN

major

STRING

marketSmith_subscription

BOOLEAN

merchantId

INTEGER

name

STRING

newListedVehicles

OBJECT

ARRAY

newListedVehicles.category

ARRAY

newListedVehicles.imageUrl

ARRAY

newListedVehicles.miles

ARRAY

newListedVehicles.name

ARRAY

newListedVehicles.noHagglePrice

ARRAY

newListedVehicles.price

ARRAY

newListedVehicles.sku

ARRAY

offers

OBJECT

ARRAY

offers.Intro APR

ARRAY

offers.categories

ARRAY

offers.description

ARRAY

offers.id

ARRAY

offers.imageUrl

ARRAY

offers.intro APR

ARRAY

offers.name

ARRAY

offers.quantity

ARRAY

offers.sku

ARRAY

offers.url

ARRAY

onboardingCohort

STRING

paid_user

BOOLEAN

passively_seeking

BOOLEAN

phoneNumber

STRING

phoneNumberDetails

OBJECT

ARRAY

phoneNumberDetails.carrier

ARRAY

phoneNumberDetails.countryCodeISO

ARRAY

phoneNumberDetails.lineType

ARRAY

phoneNumberDetails.updatedAt

ARRAY

profileUpdatedAt

DATE-TIME

promoCode

STRING

readingList

OBJECT

ARRAY

readingList.avgRating

ARRAY

readingList.bookAuthor

ARRAY

readingList.bookName

ARRAY

readingList.imageUrl

ARRAY

recommendedVehicles

OBJECT

ARRAY

recommendedVehicles.TrueCar Estimate

ARRAY

recommendedVehicles.category

ARRAY

recommendedVehicles.estimateDescription

ARRAY

recommendedVehicles.imageUrl

ARRAY

recommendedVehicles.name

ARRAY

recommendedVehicles.sku

ARRAY

region

STRING

sat

STRING

scheduled_ride

DATE-TIME

selected_games

STRING

senate Districts

STRING

shoppingCartItems

OBJECT

ARRAY

shoppingCartItems.categories

ARRAY

shoppingCartItems.description

ARRAY

shoppingCartItems.id

ARRAY

shoppingCartItems.imageUrl

ARRAY

shoppingCartItems.name

ARRAY

shoppingCartItems.price

ARRAY

shoppingCartItems.quantity

ARRAY

shoppingCartItems.sku

ARRAY

shoppingCartItems.url

ARRAY

shopppingCartTotal

INTEGER

should_receive_recommendation

BOOLEAN

signupDate

DATE-TIME

signupSource

STRING

state

STRING

streetAddress

STRING

swingTrader_subscription

BOOLEAN

tagline

STRING

timeZone

STRING

times donated

STRING

times_purchased

STRING

totalOrderCount

INTEGER

totalOrders

STRING

totalPurchases

INTEGER

totalSpent

NUMBER

total_playtime

INTEGER

type

STRING

university_interest

STRING

unsubscribedChannelIds

ARRAY

unsubscribedMessageTypeIds

ARRAY

uploaded_resume

BOOLEAN

userId

STRING

user_type

STRING

vegetarian_menu

OBJECT

ARRAY

vegetarian_menu.featured_item_availability

ARRAY

vegetarian_menu.featured_item_description

ARRAY

vegetarian_menu.featured_item_id

ARRAY

vegetarian_menu.featured_item_image_url

ARRAY

vegetarian_menu.featured_item_menu_availability

ARRAY

vegetarian_menu.featured_item_menu_date

ARRAY

vip

BOOLEAN

wishList

OBJECT

ARRAY

wishList.name

ARRAY

wishList.price

ARRAY

zip

STRING

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.

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Third-Party Downtime Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues