Urban Airship (v1) | Stitch Documentation

Urban Airship is supported by the Singer community
This integration is powered by Singer's Urban Airship tap. For support, visit the GitHub repo or join the Singer Slack.

Urban Airship integration summary

Stitch’s Urban Airship integration replicates data using the Airship API version 3. Refer to the Schema section for a list of objects available for replication.

Urban Airship feature snapshot

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

STITCH
Release status	Released on April 25, 2017	Supported by	Singer Community
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-urban-airship
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Unsupported	Column selection	Unsupported
Select all	Unsupported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Urban Airship

Urban Airship setup requirements

To set up Urban Airship in Stitch, you need:

To verify your Urban Airship API access. Urban Airship limits API access based on their product plans, meaning some plans have access while others do not.

If you create an Urban Airship integration and Stitch displays a 401 Unauthorized or 403 Forbidden error, you may not have access to Urban Airship’s API.

We recommend reaching out to Urban Airship support to confirm your API access level before beginning the setup in Stitch.

Step 1: Retrieve your Urban Airship app credentials

Connect Multiple Urban Airship Apps
If you want to connect multiple Urban Airship apps to Stitch, you will need to create a separate Urban Airship integration for each app. App credentials are app-specific, meaning only a single app can be connected per Stitch integration.

Sign into your Urban Airship account.
In the dashboard, open the app you want to connect to Stitch.
If the Engage tab doesn’t open, click Engage at the top to open it.
Click the gear icon located near Reports, then select APIs & Integrations.
The APIs & Integrations page will display.

Leave this page open for now - you’ll need it to complete the setup.

Step 2: Add Urban Airship as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Urban Airship 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 Urban Airship” would create a schema called stitch_urban_airship in the destination. Note: Schema names cannot be changed after you save the integration.
In the App Key field, paste your Urban Airship App Key.
In the App Secret field, paste your Urban Airship App Secret.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Urban Airship 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 Urban Airship’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.

Urban Airship 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.

Initial and historical replication jobs

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

Urban Airship 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 Urban Airship 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.

channels

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	created : last_registration
Primary Key :	channel_id	API endpoint :	channelListing

The channels table contains info about the channels - or unique identifiers - used to address applications on iOS, Android, and Amazon devices.

channels table schema

channel_id
INTEGER

The channel ID.

Reference:

channels.channel_id
named_users.channels.value

created
DATE-TIME

The date the channel was created.

last_registration
DATE-TIME

The last registration date of the channel, if known.

device_type
STRING

The platform type of the channel. Possible values:

ios
android
amazon
web

installed
BOOLEAN

Indicates if the channel is installed.

background
BOOLEAN

Indicates if the device associated with the channel has background app refresh enabled.

opt_in
BOOLEAN

Indicates if the channel is opted-in to push.

push_addresses
STRING

The address to send the push.

named_user_id
STRING

A customer-chosen ID that represents the device user.

Reference:

channels.named_user_id
named_users.named_user_id

alias
STRING

The alias associated with the channel. This field has been deprecated by Urban Airship.

tags
ARRAY

A list of tags associated with the channel.

Click to expand tags

value
STRING

The tag associated with the channel.

channels (table), tags (attribute)

tag_groups
ARRAY

Details about the customer-created tag groups and device property tags associated with the channel.

Click to expand tag_groups

name
STRING

The name of the tag group.

tags
ARRAY

Details about the tags associated with the tag group.

Click to expand tags

value
STRING

The tag associated with the tag group.

channels (table), tags (attribute)

channels (table), tag_groups (attribute)

ios
OBJECT

Details about iOs-specific parameters.

Click to expand ios

badge
STRING

The current badge value.

quiettime
OBJECT

Details about quiet time iOS parameters.

Click to expand quiettime

start
STRING

The start of quiet time.

end
STRING

The end of quiet time.

channels (table), quiettime (attribute)

tz
STRING

The timezone associated with the iOS device.

channels (table), ios (attribute)

lists

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	created : last_modified
Primary Key :	name	API endpoint :	allLists

The Urban Airship table contains info about device lists.

lists table schema

name
STRING

The name of the list.

created
DATE-TIME

The time the list was created.

last_modified
DATE-TIME

The time the list was last updated.

description
STRING

A description of the list.

extra
ARRAY

A list of the arbitrary, user-provided JSON values associated with the list.

Click to expand extra

key
STRING

The key to the associated value.

value
STRING

The value associated with the given key.

lists (table), extra (attribute)

channel_count
INTEGER

A count of resolved channels for the last uploaded and successfully processed identifier list.

status
STRING

The status of the list. Possible values:

ready
processing
failure : > * ready - Indicates the list was processed successfully and is ready for sending.

named_users

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	named_user_id
API endpoint :	namedUsersListing

The named_users table contains info about named users, or individual consumers. These identifiers can be used to map CRM data to channels.

named_users table schema

named_user_id
STRING

The named user ID.

Reference:

channels.named_user_id
named_users.named_user_id

tags
ARRAY

The tags applied to the named user.

Click to expand tags

value
STRING

The tag applied to the named user.

named_users (table), tags (attribute)

channels
ARRAY

The channels associated with the named user.

Click to expand channels

value
STRING

The ID of the channel associated with the named user.

Reference:

channels.channel_id
named_users.channels.value

named_users (table), channels (attribute)

segments

Replication Method :	Key-based Incremental	Replication Key :	creation_date : modification_date
Primary Key :	id	API endpoint :	segmentListing

The segments table contains info about segments, or portions of your audience that have arbitrary metadata attached.

segments table schema

id
STRING

The segment ID.

creation_date
DATE-TIME

The date the segment was created.

modification_date
DATE-TIME

The date that the segment was last updated.

display_name
STRING

The display name of the segment.

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