# Urban Airship (v1) Information note **Urban Airship is supported by the Singer community** This integration is powered by [Singer's](https://www.singer.io/) Urban Airship tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-urban-airship) or [join the Singer Slack](https://singer-slackin.herokuapp.com/). ## Urban Airship integration summary Stitch’s Urban Airship integration replicates data using the [Airship API version 3](https://docs.airship.com/api/ua/). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/urban-airship#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](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on April 25, 2017 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.

Available | | **Singer GitHub repository** | [singer-io/tap-urban-airship](https://github.com/singer-io/tap-urban-airship) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.

Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon

This feature is supported for this version of the integration.

Supported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.

Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.

Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Remove icon

Table selection is not supported for this integration. All available table and fields will be automatically selected for replication.

Unsupported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Remove icon

Column selection is not supported for this integration. All available columns in tables set to replicate will be selected.

Unsupported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Remove icon

As this integration doesn't support table or column selection, all available tables and columns are automatically replicated.

Unsupported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.

Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.

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 Information note **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. 1. Sign into your Urban Airship account. 2. In the dashboard, open the app you want to connect to Stitch. 3. If the Engage tab doesn’t open, click **Engage** at the top to open it. 4. Click the **gear icon** located near **Reports**, then select **APIs & Integrations**. 5. 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 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **Urban Airship** 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 Urban Airship” would create a schema called `stitch_urban_airship` in the destination. **Note**: Schema names cannot be changed after you save the integration. 5. In the **App Key** field, paste your Urban Airship App Key. 6. 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 data **equal to or newer than this date** will be replicated to your data warehouse. 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](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 4: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). 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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) * [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling) * [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (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](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) 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.** Information note **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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) 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. Information note **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 Information note **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. Information note **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](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### channels The `channels` table contains info about the channels - or unique identifiers - used to address applications on iOS, Android, and Amazon devices. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | channel\_id | | **Replication Keys ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | created

last\_registration | | **Useful links** | [Urban Airship documentation](http://docs.urbanairship.com/api/ua.html#channels "Opens in new tab: Urban Airship documentation")

[channels schema on GitHub](https://github.com/singer-io/tap-urban-airship/blob/master/tap_urban_airship/schemas/channels.json "Opens in new tab: channels schema on GitHub")

[Urban Airship API method](https://docs.urbanairship.com/api/ua/#channel-list-api "Opens in new tab: Urban Airship API method") | channels table foreign keys | Join channels with | on | | --- | --- | | [named_users](https://help.qlik.com/en-US/stitch/integrations/saas/urban-airship#named-users) | ```
channels.channel_id = named_users.channels
```

```
channels.named_user_id = named_users.named_user_id
``` | channels table schema | **alias**

STRING | | --- | | **background**

BOOLEAN | | **channel\_id**

STRING | | **created**

DATE-TIME | | **device\_type**

STRING | | **installed**

BOOLEAN | | **ios**

OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand ios

badge

INTEGER

quiettime

OBJECT

end

STRING

start

STRING

| | **last\_registration**

DATE-TIME | | **named\_user\_id**

STRING | | **opt\_in**

BOOLEAN | | **push\_address**

STRING | | **tag\_groups**

OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand tag\_groups

timezone

ARRAY

ua_android_app_version

ARRAY

ua_android_sdk_version

ARRAY

ua_android_version

ARRAY

ua_background_enabled

ARRAY

ua_ios_app_version

ARRAY

ua_ios_model

ARRAY

ua_ios_sdk_version

ARRAY

ua_ios_version

ARRAY

ua_locale_country

ARRAY

ua_locale_language

ARRAY

ua_location_enabled

ARRAY

ua_opt_in

ARRAY

| | **tags**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | ### lists The `Urban Airship` table contains info about device lists. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | name | | **Replication Keys ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | created

last\_modified | | **Useful links** | [Urban Airship documentation](http://docs.urbanairship.com/api/ua.html#static-lists "Opens in new tab: Urban Airship documentation")

[lists schema on GitHub](https://github.com/singer-io/tap-urban-airship/blob/master/tap_urban_airship/schemas/lists.json "Opens in new tab: lists schema on GitHub")

[Urban Airship API method](https://docs.urbanairship.com/api/ua/#all-lists "Opens in new tab: Urban Airship API method") | lists table schema | **channel\_count**

INTEGER | | --- | | **created**

DATE-TIME | | **description**

STRING | | **extra**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand extra

key

STRING

value

STRING

| | **last\_modified**

DATE-TIME | | **name**

STRING | | **status**

STRING | ### named\_users The `named_users` table contains info about named users, or individual consumers. These identifiers can be used to map CRM data to channels. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | named\_user\_id | | **Useful links** | [Urban Airship documentation](http://docs.urbanairship.com/api/ua.html#named-users "Opens in new tab: Urban Airship documentation")

[named_users schema on GitHub](https://github.com/singer-io/tap-urban-airship/blob/master/tap_urban_airship/schemas/named_users.json "Opens in new tab: named_users schema on GitHub")

[Urban Airship API method](https://docs.urbanairship.com/api/ua/#api-named-users-listing "Opens in new tab: Urban Airship API method") | named\_users table foreign keys | Join named\_users with | on | | --- | --- | | [channels](https://help.qlik.com/en-US/stitch/integrations/saas/urban-airship#channels) | ```
named_users.channels = channels.channel_id
```

```
named_users.named_user_id = channels.named_user_id
``` | named\_users table schema | **channels**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | --- | | **named\_user\_id**

STRING | | **tags**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | ### segments The `segments` table contains info about segments, or portions of your audience that have arbitrary metadata attached. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Keys ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | creation\_date

modification\_date | | **Useful links** | [Urban Airship documentation](http://docs.urbanairship.com/api/ua.html#segments "Opens in new tab: Urban Airship documentation")

[Urban Airship API method](https://docs.urbanairship.com/api/ua/#segment-listing "Opens in new tab: Urban Airship API method") | segments table schema | **creation\_date**

DATE-TIME | | --- | | **display\_name**

STRING | | **id**

STRING | | **modification\_date**

DATE-TIME |