Overview

Airship provides mobile push and location-based messaging services that enable brands to strengthen relationships with their customers.

Connect Airship to Lytics to gain greater insight into your users' activities in your app. Create lists to target in Airship using advanced audience insights and data science from Lytics to drive your conversion rates.

Authorization

If you haven't already done so, you will need to setup an Airship account before you begin the process described below.

  1. Select Airship from the list of providers.

  2. Select the method for authorization. Note that different methods may support different job types. Airship supports the following authorization methods:

    • Event Stream: used for Import Events job
    • Basic Master: used for Import Compliance Events and the Export Audiences jobs
  3. Enter a Label to identify your authorization.

  4. (Optional) Enter a Description for further context on your authorization.

  5. Complete the configuration steps needed for your authorization. These steps will vary by method.

  6. Click Save Authorization.

Event Stream Authorization

This authorization is used for the Import Events job. You will need to create an access token for Lytics to use to authorize with Airship.

πŸ“˜

You will need to add the Direct Connection or the Lytics integration your Airship account to use the event import.

After creating an access token and retrieving your app key, follow these steps configure the authorization between Lytics and Airship.

  1. In the App Key field, enter your Airship app key.
  2. In the Access Token field, enter your Airship Token.
  3. (Optional) From the Airship Project Location dropdown box, select the location of your Airship project location. The default is "US".

Airship-Authorization-event-stream

Basic Master Authorization

This Authorization is used for the Import Compliance Events and the Export Audiences jobs.

  1. In the App Key field, enter your Airship app key.
  2. In the Master Secret field, enter your Airship Master Secret.
  3. (Optional) From the Airship Project Location dropdown box, select the location of your Airship project location. The default is "US".

Airship-Authorization-basic-master

Import Events

By importing your Airship events into Lytics, you'll be able to use Lytics powerful insights into the channels your users use the most.

Integration Details

  • Implementation Type:Server-side Integration.
  • Implementation Technique: Streaming REST API Integration.
  • Frequency: Real-time Integration with one time backfill of events after setup.
  • Resulting Data: User Fields and Raw Events from Airship.

This integration utilizes the Airship APIs to receive event data. On each run of the job, it will:

  1. Open event stream using the configured device and event type filters, and event latancey. After the first run, the request will include the offset of the last event read.
  2. Collect event data into the airship_events stream.

Fields

The following fields are included in the default mapping of the airship_events stream:

Source FieldConditionalLytics User FieldDescriptionType
count(occurred)IF tolower(type) IN ("screen_viewed") AND tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_screen_viewsAirship App: Screen View Countint
count(occurred)IF tolower(type) IN ("open") AND tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_sessionsAirship App: Session Countint
device.channelIF tolower(device.device_type) IN ("email")airship_email_idAirship Email Channel IDstring
device.named_user_idairship_user_id unique idNamed User IDstring
email(device.delivery_address)IF tolower(device.device_type) IN ("email")email unique idEmail Addressstring
epochms()airship_last_app_event_tsLast App Eventdate
match("body.current.")IF eq(type, "TAG_CHANGE")airship_app_tagsApp Tagsmap[string]value
max(epochms())IF tolower(type) IN ("first_open") AND tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_last_installAirship App: Last Install Datedate
max(epochms())IF tolower(type) IN ("uninstall") AND tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_last_uninstallAirship App: Last Uninstall Datedate
max(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("bounce")airship_email_last_bounceAirship Email: Last Bounce Timestampdate
max(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("click")airship_email_last_clickAirship Email: Last Click Timestampdate
max(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("delivery")airship_email_last_deliveryAirship Email: Last Delivery Timestampdate
max(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("open")airship_email_last_openAirship Email: Last Open Timestampdate
max(epochms())IF tolower(type) IN ("send") AND tolower(device.device_type) IN ("email")airship_email_last_sendAirship Email: Last Send Timestampdate
max(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("unsubscribe")airship_email_last_unsubAirship Email: Last Unsubscribe Timestampdate
min(epochms())IF tolower(type) IN ("first_open") AND tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_first_installAirship App: First Install Datedate
min(epochms())IF tolower(type) IN ("uninstall") AND tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_first_uninstallAirship App: First Uninstall Datedate
min(epochms())airship_created_tsCreated Datedate
min(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("bounce")airship_email_first_bounceAirship Email: First Bounce Timestampdate
min(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("click")airship_email_first_clickAirship Email: First Click Timestampdate
min(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("open")airship_email_first_openAirship Email: First Open Timestampdate
min(epochms())IF tolower(type) IN ("send") AND tolower(device.device_type) IN ("email")airship_email_first_sendAirship Email: First Send Timestampdate
min(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("unsubscribe")airship_email_first_unsubAirship Email: First Unsubscribe Timestampnumber
min(epochms())IF tolower(type) IN ("custom") AND tolower(device.device_type) IN ("email") AND tolower(body.name) IN ("delivery")airship_email_fist_deliveryAirship Email: First Delivery Timestampdate
set(body.viewed\_screen)IF tolower(type) IN ("screen_viewed") AND tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_screens_viewedAirship App: Screens Viewed[]string
set(device.device\_type)airship_device_typesAirship: All Devices used[]string
set(device.amazon_channel)airship_amazon_devicesAmazon Device IDs[]string
set(device.android_channel)airship_android_devicesAndroid Device IDs[]string
set(device.channel)airship_device_channel unique idAirship Channel ID(s)[]string
set(device.ios_channel)airship_apple_devicesApple Device IDs[]string
tobool(device.attributes.push\_opt\_in)IF tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_push_permissionAirship App: Push Notifications Opt-Inbool
valuect(type)IF tolower(device.device_type) IN ("ios", "android", "amazon")airship_app_event_countsAirship App: Event Count per App Eventmap[string]intsum
valuect(type)IF tolower(type) IN ("send") AND tolower(device.device_type) IN ("email")airship_email_event_countsAirship Email: Event Count per Email Eventmap[string]intsum

Configuration

Follow these steps to set up and configure an import job for Airship in the Lytics platform. If you are new to creating jobs in Lytics, see the Data Sources documentation for more information.

  1. Select Airship from the list of providers.

  2. Select the Import Activity Data job type from the list.

  3. Select the Authorization you would like to use or create a new one.

  4. Enter a Label to identify this job you are creating in Lytics.

  5. (Optional) Enter a Description for further context on your job.

  6. Complete the configuration steps for your job.
    Configure Import Airship

  7. (Optional) In the Maximum Event Age (days) text box, enter the maximum age of a message to be imported. If left blank, only new events will be imported.

  8. (Optional) Using the Device Types input, select the types of device you would like events from. Devices on the right will be included. If no Devices are selected, all device types will be imported.

  9. (Optional) Using the Event Types input, select the types of events you would like to import. Event Types on the right will be included. If no Event Types are selected, all event types will be imported.

  10. (Optional) In the Push ID text box, enter the ID of a push message to only import events related to that push. Note: you may only include one of Group ID and Push ID.

  11. (Optional) In the Group ID text box, enter the ID of a group to only import events related to that group. Note: you may only include one of Group ID and Push ID.

  12. Click Start Import.

Export Audiences

Export your Lytics audiences to Airship to use Lytics-powered insights in your mobile campaigns. Use your advanced data science driven audiences in Lytics as your push targets in Airship.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: REST API Integration (File Based Transfer Integration)
  • Frequency: Batch Integration One-time or continuous hourly, daily, weekly, or monthly exports where the time of day can be configured.
  • Resulting Data: A new or existing list in Airship populated with channel identifiers from Lytics users.

This integration utilizes the Airship APIs to create a static list of users. Users without an email channel will be registered and associated with a named user ID if available. Once the user initiates an export, the job will:

  1. On the first run, the export will create a static list in Airship. If an existing list was selected during configuration, this step is skipped.
  2. Scan through the users in the Lytics audience.
  3. For any users with an email address, but no email channel ID, register the email address with Airship.
  4. Associate newly created email channel ID with the named user ID.
  5. Build a CSV containing user channel identifier types and identifiers.
  6. Update the list in Airship with the user CSV.

Note: Large audiences may take longer than an hour to export.

Fields

The following fields can be mapped for export as part of the audience export to Airship.

Lytics User FieldAirship FieldDescriptionType
User configurableamazon_channelAmazon channel UUIDstring
User configurableandroid_channelAndroid channel UUIDstring
User configurableemail_channelEmail channel UUIDstring
User configurableios_channeliOS channel UUIDstring
User configurablenamed_userNamed User channel UUIDstring
User configurableopen_channelOpen channel UUIDstring
User configurablesms_channelSMS channel UUIDstring

Configuration

Follow these steps to set up and configure an export job for Airship in the Lytics platform.

  1. Select Airship from the list of providers.

  2. Select the Export Audiences job type from the list.

  3. Select the Authorization you would like to use or create a new one.

  4. Enter a Label to identify this job you are creating in Lytics.

  5. (Optional) Enter a Description for further context on your job.

  6. (Required) From the Audience drop-down, select the Lytics audience you want to export to Airship.

  7. (Optional) From the List drop-down, select an existing static list to export the audience to. Either a List must be selected or a List Name must be entered below.

  8. (Optional) In the List Name text box, enter the name of a list to create in Airship. Either a List must be selected or a List Name must be entered.

  9. (Optional) From the Email Field drop-down, select the Lytics field that contains Email Address of the user. This Email will be used to register new users in Airship.

  10. (Optional) From the Named User ID Field drop-down, select a field to use when associating a newly registered email with a named user. If a field is selected, its value will be used as the named user id to associate the registered email with the named user. If left blank registered emails will not be associated with a named user.

  11. Use the Identifier Field Mapping input to map the Lytics user field (on the left) to the Airship channel (right). Note: The Lytics field must contain the user's Airship channel UUID.
    airship export 1

  12. (Optional) Select the Commercial Opt-In Field which represents the date-time when the user subscribed to the Commercial emails.

  13. (Optional) Select the Commercial Opt-out Field which represents the date-time when the user unsubscribed from the Commercial emails.

  14. (Optional) Select the Transactional Opt-in Field which represents the date-time when the user subscribed to the Transactional emails.

  15. (Optional) Select the Transactional Opt-out Field which represents the date-time when the user unsubscribed from the Transactional emails.
    airship export 2

  16. (Optional) Select the Keep Updated checkbox to run the export at a configurable frequency. The default is daily at midnight UTC.

  17. (Optional) From the List Update Frequency drop-down, select the frequency you would like the export to run. Note: Large audiences may take more than an hour to export to Airship.

  18. (Optional) From the Time of Day drop-down, select the time of day the export should run for daily, weekly, and monthly exports.

  19. (Optional) From the Timezone drop-down, select the timezone to use for Time of Day.

  20. Click Start Export.
    airship export 3