Documentation / Product / Integrations / Iterable

Iterable: Import Users & Activity

Import Iterable users and activity data to add information such as clicks and opens to your Lytics user profiles. Use that data to build behavioral audiences and refine your targeting.

Integration Details

  • Implementation Type: Server-side.
  • Implementation Technique: REST API to download CSV formatted data.
  • Frequency: Data is imported in a batch process imported once, or on an hourly, continuous basis.
  • Resulting Data: Full user profiles for all Iterable users complete with activity/interaction data.

This integration utilizes the Iterable APIs to receive user data. On each run of the workflow, it will:

  1. Query for a CSV of all users in your Iterable account. This CSV is imported to the iterable_users stream in Lytics.
  2. Query for a CSV of all events including email, SMS, custom, push, and in-app events. These events are imported to Lytics streams based on the type of activity, i.e. iterable_activity (email), iterable_push_activity, iterable_sms_activity, and iterable_in_app_activity.

In addition to running this workflow, you can also use webhook for real time event capture of your Iterable events. Follow webhook documentation to learn more about how to configure webhooks in Iterable to send data to Lytics.

Fields

The fields that are included in the default mapping for various streams (user, in-app, push and sms) are shown below in their respective stream tables:

Stream: iterable_users

Source FieldLytics User FieldDescriptionType
emailemail unique idEmailstring
emaildomainemaildomainEmail Domainstring
userIdit_user_idIterable User Idstring
firstNamefirst_nameFirst Namestring
last_namelast_nameLast Namestring
gendergenderGenderstring
citycityCitystring
countrycountryCountrystring
timeZonetimezoneTimezonestring

Lytics will import any and all custom fields from Iterable, however this stream does not automatically map these fields. If you would like to map any custom fields from Iterable as Lytics user fields, contact customer support for assistance.


Stream: iterable_in_app_activity

Source FieldLytics User FieldDescriptionType
emailemail unique idEmailstring
emaildomainemaildomainEmail Domainstring
eventit_eventIterable Eventsstring
max(epochms())last_active_tsLast Activedate
max(epochms())it_last_in_app_open_tsIterable Last In-App Message Opendate
min(epochms())it_first_in_app_open_tsIterable First In-App Message Opendate
inAppOpen event countit_in_app_openctIterable Open In-App Message Open Countint
max(epochms())it_last_in_app_click_tsIterable Last In-App Clickdate
min(epochms())it_first_in_app_click_tsIterable First In-App Clickdate
inAppClick event countit_in_app_clickctIterable In-App Click Countint
campaignIdit_campaignsIterable Campaign Idsstring
campaignNameit_campaign_namesIterable Campaigns Namestring
inAppOpen experience_idit_impressionsReached with Iterable Experiencemap[string]int
inAppClick experience_idit_conversionsConverted on Iterable Experiencemap[string]int

Stream: iterable_push_activity

Source FieldLytics User FieldDescriptionType
emailemail unique idEmailstring
emaildomainemaildomainEmail Domainstring
eventit_eventIterable Eventsstring
max(epochms())last_active_tsLast Activedate
max(epochms())it_last_push_open_tsIterable Last Push Opendate
min(epochms())it_first_push_open_tsIterable First Push Opendate
pushOpen event countit_push_openctIterable Open Push Countint
max(epochms())it_last_push_send_tsIterable Last Push Senddate
min(epochms())it_first_push_send_tsIterable First Push Senddate
pushSend event countit_push_sendctIterable Send Push Countint
max(epochms())it_last_push_bounce_tsIterable Last Push Bouncedate
min(epochms())it_first_push_bounce_tsIterable First Push Bouncedate
pushBounce event countit_push_bouncectIterable Bounce Push Countint
workflowIdit_workflow_idsIterable Workflow IDsstring
workflowNameit_workflow_namesIterable Workflow Namesstring
"deeplink_ios/deeplink_andriod"it_push_deeplinkIterable Push Notification Deeplinkstring
max(epochms())it_unsub_tsIterable Push Uninstall Datedate
hourofday()it_mobile_hourlyopenIterable Hourly Mobile Eventsint
hourofweek()it_mobile_hourofweekIterable Hour of Week Mobile Eventsint
yymm()it_mobile_monthlyIterable Mobile Events By Monthint
campaignIdit_campaignsIterable Campaign Idsstring
campaignNameit_campaign_namesIterable Campaigns Namestring
channelIdit_channelsIterable Channelsstring
messageIdit_messagesIterable Messagesstring
messageTypeIdit_message_typesIterable Message Typesstring
templateIdit_templatesIterable Template IDsstring
templateNameit_template_namesIterable Templatesstring
pushSend experience_idit_impressionsReached with Iterable Experiencemap[string]int
pushOpen experience_idit_conversionsConverted on Iterable Experiencemap[string]int

Stream: iterable_sms_activity

Source FieldLytics User FieldDescriptionType
emailemail unique idEmailstring
emaildomainemaildomainEmail Domainstring
eventit_eventIterable Eventsstring
toPhoneNumberphonePhone Numberstring
max(epochms())last_active_tsLast Activedate
max(epochms())it_last_sms_received_tsIterable Last SMS Receiveddate
min(epochms())it_first_sms_received_tsIterable First SMS Receiveddate
smsReceived event countit_sms_receivedctIterable Open SMS Received Countint
max(epochms())it_last_sms_send_tsIterable Last SMS Senddate
min(epochms())it_first_sms_send_tsIterable First SMS Senddate
smsSend event countit_sms_sendctIterable Send SMS Countint
max(epochms())it_last_sms_bounce_tsIterable Last SMS Bouncedate
min(epochms())it_first_sms_bounce_tsIterable First SMS Bouncedate
smsBounce event countit_sms_bouncectIterable Bounce SMS Countint
workflowIdit_workflow_idsIterable Workflow IDsstring
workflowNameit_workflow_namesIterable Workflow Namesstring
campaignIdit_campaignsIterable Campaign Idsstring
campaignNameit_campaign_namesIterable Campaigns Namestring
channelIdit_channelsIterable Channelsstring
messageTypeIdit_message_typesIterable Message Typesstring
templateIdit_templatesIterable Template IDsstring
templateNameit_template_namesIterable Templatesstring
smsSend experience_idit_impressionsReached with Iterable Experiencemap[string]int
smsReceived experience_idit_conversionsConverted on Iterable Experiencemap[string]int

Configuration

Follow these steps to set up and configure an import of Iterable users in the Lytics platform.

  1. Log into your Lytics account.
  2. Open the Iterable integration or Click Data > Integrations and select Iterable from the integrations list.
  3. Click New Workflow.
  4. Select Import Users & Activity.
  5. Select the authorization you created during the authorization step.
  6. Use the User Fields to Import input to select the Iterable fields you would like to import into Lytics. Fields available to be imported from Iterable are located in the left column. Fields added to the right column will be imported to Lytics.
  7. If you would like users and their activity to be updated continually, check Keep Updated. configure
  8. Click Start Import.

User data will begin to import into Lytics from Iterable and should be available within the hour. If Keep Updated was selected user data and activity will be updated hourly until the import is cancelled.