Skip to main content Skip to complementary content

Iterable 

Iterable is a customer engagement platform that enables brands to create, execute, and optimize cross-channel campaigns.

Iterable integration replicates data using the Iterable API 1.8.

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

Preparing for authentication

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

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

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

To generate the API key:

  1. Log into your 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 the key.

Creating the connection

For more information, see Connecting to SaaS applications.

  1. Fill in the required connection properties.
  2. Provide a name for the connection in Connection name.

  3. Select Open connection metadata to define metadata for the connection when it has been created.

  4. Click Create.

Connection settings
SettingDescription
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.

Iterable API KeyIterable API key.
Window in DaysWindow in days. 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.

Schema

Information note

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.

campaigns

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

Replication Method

CDC

Primary Key

id

Replication Key

updatedAt

Useful links

Iterable API method

channels

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

Replication Method

Full Table

Primary Key

id

Useful links

Iterable API method

email_bounce

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

Replication Method

CDC

Primary Key

email

Replication Key

createdAt

Useful links

Iterable API method

email_click

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

Replication Method

CDC

Primary Key

email

Replication Key

createdAt

Useful links

Iterable API method

email_complaint

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

Replication Method

CDC

Primary Key

email

Replication Key

createdAt

Useful links

Iterable API method

email_open

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

Replication Method

CDC

Primary Key

email

Replication Key

createdAt

Useful links

Iterable API method

email_send

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

Replication Method

CDC

Primary Key

email

Replication Key

createdAt

Useful links

Iterable API method

email_send_skip

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

Replication Method

CDC

Primary Key

email

Replication Key

createdAt

Useful links

Iterable API method

email_subscribe

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

Replication Method

CDC

Primary Key

email

Replication Key

createdAt

Useful links

Iterable API method

email_unsubscribe

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

Replication Method

CDC

Primary Key

email

Replication Key

createdAt

Useful links

Iterable API method

list_users

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

Replication Method

Full Table

Primary Keys

email

listId

Useful links

Iterable API method

lists

The lists tablecontains information about lists within your Iterable project.

Replication Method

Full Table

Primary Key

id

Useful links

Iterable API method

message_types

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

Replication Method

Full Table

Primary Key

id

Useful links

Iterable API method

metadata

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

Replication Method

Full Table

Primary Key

key

Useful links

Iterable API method

templates

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

Replication Method

CDC

Primary Key

templateId

Replication Key

updatedAt

Useful links

Iterable API method

users

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

Replication Method

CDC

Primary Key

email

Replication Key

profileUpdatedAt

Useful links

Iterable documentation

Iterable API method

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!