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

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

Step 2: Add Iterable 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 Iterable 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 Iterable” would create a schema called stitch_iterable in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Iterable API Key field, paste the API key you copied in step 1.
  6. 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:

  • 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 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

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:

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

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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. 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.

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.


Iterable table reference

Replication Method :

Key-based Incremental

Replication Key :

updatedAt

Primary Key :

id

API endpoint :

Get campaigns

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

id
INTEGER

The campaign ID.

Reference:

updatedAt
DATE-TIME

The time the campaign was updated.

campaignState
STRING

createdAt
DATE-TIME

createdByUserId
STRING

endedAt
DATE-TIME

labels
ARRAY

items

campaigns (table), labels (attribute)

listIds
ARRAY

items
INTEGER

campaigns (table), listIds (attribute)

messageMedium
STRING

name
STRING

recurringCampaignId
INTEGER

sendSize
NUMBER

startAt
DATE-TIME

suppressionListIds
ARRAY

items
INTEGER

campaigns (table), suppressionListIds (attribute)

templateId
INTEGER

The template ID.

Reference:

type
STRING

updatedByUserId
STRING

workflowId
INTEGER


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get channels

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


Replication Method :

Key-based Incremental

Replication Key :

createdAt

Primary Key :

email

API endpoint :

Export data to JSON

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


Replication Method :

Key-based Incremental

Replication Key :

createdAt

Primary Key :

email

API endpoint :

Export data to JSON

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

email
STRING

The user email.

Reference:

createdAt
DATE-TIME

The time the email click was created.

campaignId
INTEGER

The campaign ID.

city
STRING

contentId
INTEGER

country
STRING

eventName
STRING

hrefIndex
INTEGER

ip
STRING

itblInternal
OBJECT

documentCreatedAt
DATE-TIME

documentUpdatedAt
DATE-TIME

email_click (table), itblInternal (attribute)

messageId
STRING

region
STRING

templateId
INTEGER

The template ID.

Reference:

url
STRING

userAgent
STRING

userAgentDevice
STRING


Replication Method :

Key-based Incremental

Replication Key :

createdAt

Primary Key :

email

API endpoint :

Export data to JSON

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


Replication Method :

Key-based Incremental

Replication Key :

createdAt

Primary Key :

email

API endpoint :

Export data to JSON

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


Replication Method :

Key-based Incremental

Replication Key :

createdAt

Primary Key :

email

API endpoint :

Export data to JSON

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

email
STRING

The user email.

Reference:

createdAt
DATE-TIME

The time the email was sent.

campaignId
INTEGER

The campaign ID

Reference:

catalogCollectionCount
INTEGER

catalogLookupCount
INTEGER

channelId
INTEGER

The channel ID.

Reference:

contentId
INTEGER

espName
STRING

itblInternal
OBJECT

documentCreatedAt
DATE-TIME

documentUpdatedAt
DATE-TIME

email_send (table), itblInternal (attribute)

messageBusId
STRING

messageId
STRING

messageTypeId
INTEGER

productRecommendationCount
INTEGER

templateId
INTEGER

The template ID.

Reference:

transactionalData
OBJECT

inventory
INTEGER

eventName
STRING

name
STRING

sku
STRING

email
STRING

url
STRING

description
STRING

price
INTEGER

product_type
STRING

compare_at_price
NUMBER

id
STRING

templateId
INTEGER

product_id
STRING

categories
ARRAY

items

email_send (table), categories (attribute)

createdAt
DATE-TIME

campaignId
INTEGER

vendor
STRING

eventUpdatedAt
DATE-TIME

discount
INTEGER

imageUrl
STRING

itblInternal
OBJECT

documentCreatedAt
DATE-TIME

documentUpdatedAt
DATE-TIME

email_send (table), itblInternal (attribute)

handle
STRING

email_send (table), transactionalData (attribute)

Replication Method :

Key-based Incremental

Replication Key :

createdAt

Primary Key :

email

API endpoint :

Export data to JSON

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

email
STRING

The user email.

Reference:

createdAt
DATE-TIME

The time the skipped email was created.

campaignId
INTEGER

The campaign ID.

Reference:

channelId
INTEGER

The channel ID.

Reference:

contentId
INTEGER

itblInternal
OBJECT

documentCreatedAt
DATE-TIME

documentUpdatedAt
DATE-TIME

email_send_skip (table), itblInternal (attribute)

messageId
STRING

messageTypeId
INTEGER

reason
STRING

templateId
INTEGER

The template ID.

Reference:

transactionalData
OBJECT

inventory
INTEGER

eventName
STRING

name
STRING

sku
STRING

email
STRING

url
STRING

description
STRING

price
INTEGER

product_type
STRING

compare_at_price
NUMBER

id
STRING

templateId
INTEGER

product_id
STRING

categories
ARRAY

items

email_send_skip (table), categories (attribute)

createdAt
DATE-TIME

campaignId
INTEGER

vendor
STRING

eventUpdatedAt
DATE-TIME

discount
INTEGER

imageUrl
STRING

itblInternal
OBJECT

documentCreatedAt
DATE-TIME

documentUpdatedAt
DATE-TIME

email_send_skip (table), itblInternal (attribute)

handle
STRING

email_send_skip (table), transactionalData (attribute)

Replication Method :

Key-based Incremental

Replication Key :

createdAt

Primary Key :

email

API endpoint :

Export data to JSON

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

email
STRING

The user email.

Reference:

createdAt
DATE-TIME

The time the subscription was created.

campaignId
INTEGER

The campaign ID.

Reference:

channelIds
ARRAY

The channel IDs the email is subscribed to.

emailListId
INTEGER

emailListIds
ARRAY

items
INTEGER

email_subscribe (table), emailListIds (attribute)

eventName
STRING

itblInternal
OBJECT

documentCreatedAt
DATE-TIME

documentUpdatedAt
DATE-TIME

email_subscribe (table), itblInternal (attribute)

profileUpdatedAt
DATE-TIME

signupSource
STRING

templateId
INTEGER

The template ID.

Reference:

userId
STRING

workflowId
INTEGER


email_unsubscribe

Replication Method :

Key-based Incremental

Replication Key :

createdAt

Primary Key :

email

API endpoint :

Export data to JSON

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

email
STRING

The user email.

Reference:

createdAt
DATE-TIME

The time the email unsubscribed.

bounceMessage
STRING

campaignId
INTEGER

The campaign ID

Reference:

channelId
INTEGER

The channel ID.

Reference:

channelIds
ARRAY

The channel IDs the email unsubscribed from.

emailListId
INTEGER

emailListIds
ARRAY

items
INTEGER

email_unsubscribe (table), emailListIds (attribute)

eventName
STRING

itblInternal
OBJECT

documentCreatedAt
DATE-TIME

documentUpdatedAt
DATE-TIME

email_unsubscribe (table), itblInternal (attribute)

messageId
STRING

recipientState
STRING

status
STRING

templateId
INTEGER

The templateId

Reference:

unsubSource
STRING

workflowId
INTEGER


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get lists

The lists tablecontains information about lists within your Iterable project.

id
INTEGER

The list ID.

Reference:

createdAt
DATE-TIME

description
STRING

listType
STRING

name
STRING


Replication Method :

Full Table

Primary Key :

email : listId

API endpoint :

Get users in a list

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


Replication Method :

Full Table

Primary Key :

id

API endpoint :

List message types

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

id
INTEGER

The message type ID.

Reference:

channelId
INTEGER

The channel ID.

Reference:

createdAt
DATE-TIME

name
STRING

subscriptionPolicy
STRING

updatedAt
DATE-TIME


Replication Method :

Full Table

Primary Key :

key

API endpoint :

Get the metadata value of a single key

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

key
STRING

They metadata key.

lastModified
DATE-TIME

size
INTEGER

table
STRING

value
OBJECT

inventory
INTEGER

name
STRING

sku
STRING

url
STRING

description
STRING

price
INTEGER

product_type
STRING

compare_at_price
NUMBER

id
STRING

product_id
STRING

categories
ARRAY

items

metadata (table), categories (attribute)

vendor
STRING

discount
INTEGER

imageUrl
STRING

handle
STRING

metadata (table), value (attribute)

Replication Method :

Key-based Incremental

Replication Key :

updatedAt

Primary Key :

templateId

API endpoint :

Get project templates

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


Replication Method :

Key-based Incremental

Replication Key :

profileUpdatedAt

Primary Key :

email

API endpoint :

Export data to JSON

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

email
STRING

The user email.

Reference:

profileUpdatedAt
DATE-TIME

The time the profile was updated.

CCProvider
STRING

Industry
STRING

accessIp
STRING

acquisition_source
STRING

actively_seeking
BOOLEAN

age
INTEGER

auctionDigest
OBJECT

auctionDigest
ARRAY

items
OBJECT

users (table), auctionDigest (attribute)

auctionDigest.auctionDateLocation
ARRAY

items
STRING

users (table), auctionDigest.auctionDateLocation (attribute)

auctionDigest.auctionHouse
ARRAY

items
STRING

users (table), auctionDigest.auctionHouse (attribute)

auctionDigest.auctionImageUrl
ARRAY

items
STRING

users (table), auctionDigest.auctionImageUrl (attribute)

auctionDigest.auctionInfo
ARRAY

items
STRING

users (table), auctionDigest.auctionInfo (attribute)

auctionDigest.name
ARRAY

items
STRING

users (table), auctionDigest.name (attribute)

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

devices
ARRAY

items
OBJECT

users (table), devices (attribute)

devices.applicationName
ARRAY

items
STRING

users (table), devices.applicationName (attribute)

devices.endpointEnabled
ARRAY

items
BOOLEAN

users (table), devices.endpointEnabled (attribute)

devices.platform
ARRAY

items
STRING

users (table), devices.platform (attribute)

devices.platformEndpoint
ARRAY

items
STRING

users (table), devices.platformEndpoint (attribute)

devices.token
ARRAY

items
STRING

users (table), devices.token (attribute)

emailListIds
ARRAY

items
INTEGER

users (table), emailListIds (attribute)

estimatedSizing
STRING

experience
STRING

favoriteAnimal
STRING

favoriteCategories
OBJECT

favoriteCategories
ARRAY

items
OBJECT

users (table), favoriteCategories (attribute)

favoriteCategories.category
ARRAY

items
STRING

users (table), favoriteCategories.category (attribute)

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

invoice
ARRAY

items
OBJECT

users (table), invoice (attribute)

invoice.customAmount
ARRAY

items
INTEGER

users (table), invoice.customAmount (attribute)

invoice.customSubTotal
ARRAY

items
INTEGER

users (table), invoice.customSubTotal (attribute)

invoice.customerEmail
ARRAY

items
STRING

users (table), invoice.customerEmail (attribute)

invoice.customerName
ARRAY

items
STRING

users (table), invoice.customerName (attribute)

invoice.invoiceDate
ARRAY

items
STRING

users (table), invoice.invoiceDate (attribute)

invoice.invoiceNumber
ARRAY

items
STRING

users (table), invoice.invoiceNumber (attribute)

invoice.merchantName
ARRAY

items
STRING

users (table), invoice.merchantName (attribute)

invoice.totalDue
ARRAY

items
INTEGER

users (table), invoice.totalDue (attribute)

is_active
BOOLEAN

is_available
BOOLEAN

itblInternal.emailDomain
STRING

jobRecommendations
OBJECT

jobRecommendations
ARRAY

items
OBJECT

users (table), jobRecommendations (attribute)

jobRecommendations.applicationURL
ARRAY

items
STRING

users (table), jobRecommendations.applicationURL (attribute)

jobRecommendations.description
ARRAY

items
STRING

users (table), jobRecommendations.description (attribute)

jobRecommendations.id
ARRAY

items
STRING

users (table), jobRecommendations.id (attribute)

jobRecommendations.imageUrl
ARRAY

items
STRING

users (table), jobRecommendations.imageUrl (attribute)

jobRecommendations.name
ARRAY

items
STRING

users (table), jobRecommendations.name (attribute)

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

newListedVehicles
ARRAY

items
OBJECT

users (table), newListedVehicles (attribute)

newListedVehicles.category
ARRAY

items
STRING

users (table), newListedVehicles.category (attribute)

newListedVehicles.imageUrl
ARRAY

items
STRING

users (table), newListedVehicles.imageUrl (attribute)

newListedVehicles.miles
ARRAY

items
STRING

users (table), newListedVehicles.miles (attribute)

newListedVehicles.name
ARRAY

items
STRING

users (table), newListedVehicles.name (attribute)

newListedVehicles.noHagglePrice
ARRAY

items
STRING

users (table), newListedVehicles.noHagglePrice (attribute)

newListedVehicles.price
ARRAY

items
STRING

users (table), newListedVehicles.price (attribute)

newListedVehicles.sku
ARRAY

items
STRING

users (table), newListedVehicles.sku (attribute)

offers
OBJECT

offers
ARRAY

items
OBJECT

users (table), offers (attribute)

offers.Intro APR
ARRAY

items
INTEGER

users (table), offers.Intro APR (attribute)

offers.categories
ARRAY

items
STRING

users (table), offers.categories (attribute)

offers.description
ARRAY

items
STRING

users (table), offers.description (attribute)

offers.id
ARRAY

items
STRING

users (table), offers.id (attribute)

offers.imageUrl
ARRAY

items
STRING

users (table), offers.imageUrl (attribute)

offers.intro APR
ARRAY

items
INTEGER

users (table), offers.intro APR (attribute)

offers.name
ARRAY

items
STRING

users (table), offers.name (attribute)

offers.quantity
ARRAY

items
INTEGER

users (table), offers.quantity (attribute)

offers.sku
ARRAY

items
STRING

users (table), offers.sku (attribute)

offers.url
ARRAY

items
STRING

users (table), offers.url (attribute)

onboardingCohort
STRING

paid_user
BOOLEAN

passively_seeking
BOOLEAN

phoneNumber
STRING

phoneNumberDetails
OBJECT

phoneNumberDetails
ARRAY

items
OBJECT

users (table), phoneNumberDetails (attribute)

phoneNumberDetails.carrier
ARRAY

items
STRING

users (table), phoneNumberDetails.carrier (attribute)

phoneNumberDetails.countryCodeISO
ARRAY

items
STRING

users (table), phoneNumberDetails.countryCodeISO (attribute)

phoneNumberDetails.lineType
ARRAY

items
STRING

users (table), phoneNumberDetails.lineType (attribute)

phoneNumberDetails.updatedAt
ARRAY

items
STRING

users (table), phoneNumberDetails.updatedAt (attribute)

promoCode
STRING

readingList
OBJECT

readingList
ARRAY

items
OBJECT

users (table), readingList (attribute)

readingList.avgRating
ARRAY

items
STRING

users (table), readingList.avgRating (attribute)

readingList.bookAuthor
ARRAY

items
STRING

users (table), readingList.bookAuthor (attribute)

readingList.bookName
ARRAY

items
STRING

users (table), readingList.bookName (attribute)

readingList.imageUrl
ARRAY

items
STRING

users (table), readingList.imageUrl (attribute)

recommendedVehicles
OBJECT

recommendedVehicles
ARRAY

items
OBJECT

users (table), recommendedVehicles (attribute)

recommendedVehicles.TrueCar Estimate
ARRAY

items
STRING

users (table), recommendedVehicles.TrueCar Estimate (attribute)

recommendedVehicles.category
ARRAY

items
STRING

users (table), recommendedVehicles.category (attribute)

recommendedVehicles.estimateDescription
ARRAY

items
STRING

users (table), recommendedVehicles.estimateDescription (attribute)

recommendedVehicles.imageUrl
ARRAY

items
STRING

users (table), recommendedVehicles.imageUrl (attribute)

recommendedVehicles.name
ARRAY

items
STRING

users (table), recommendedVehicles.name (attribute)

recommendedVehicles.sku
ARRAY

items
STRING

users (table), recommendedVehicles.sku (attribute)

region
STRING

sat
STRING

scheduled_ride
DATE-TIME

selected_games
STRING

senate Districts
STRING

shoppingCartItems
OBJECT

shoppingCartItems
ARRAY

items
OBJECT

users (table), shoppingCartItems (attribute)

shoppingCartItems.categories
ARRAY

items
STRING

users (table), shoppingCartItems.categories (attribute)

shoppingCartItems.description
ARRAY

items
STRING

users (table), shoppingCartItems.description (attribute)

shoppingCartItems.id
ARRAY

items
STRING

users (table), shoppingCartItems.id (attribute)

shoppingCartItems.imageUrl
ARRAY

items
STRING

users (table), shoppingCartItems.imageUrl (attribute)

shoppingCartItems.name
ARRAY

items
STRING

users (table), shoppingCartItems.name (attribute)

shoppingCartItems.price
ARRAY

items
NUMBER

users (table), shoppingCartItems.price (attribute)

shoppingCartItems.quantity
ARRAY

items
INTEGER

users (table), shoppingCartItems.quantity (attribute)

shoppingCartItems.sku
ARRAY