Device information

Events are ascribed to devices. App, web, SMS, email, and open channel devices return different information.

App device information

Information about app users generated by the SDK.

Jump to examples ↓

OBJECT PROPERTIES

amazon_channel string
The identifier for a Fire OS channel. In general, this is also the same value as the channel.
android_channel string
The identifier for an Android channel. In general, this is also the same value as the channel.
attributes object
Attributes specific to app devices.
OBJECT PROPERTIES
- app_package_name string
  A unique identifier for the app name.
- app_version string
  The version of the app.
- background_push_enabled string
  Indicates whether or not the device has background push notifications enabled.
  Possible values: true, false
- device_model string
  The device model.
- device_os string
  The device operating system.
- iana_timezone string
  The time zone of the device.
- locale_country_code string
  The ISO 3166-1 country code as defined in device settings.
- locale_language_code string
  The ISO 639-1 two-letter language code reflecting the language that the device is set to.
- locale_timezone string
  The device’s time zone offset in seconds from UTC.
- locale_variant string
  The language variant.
- location_enabled string
  Indicates whether or not the device has location services enabled.
  Possible values: true, false
- location_permission string
  - SYSTEM_LOCATION_DISABLED Location is disabled in system settings
  - NOT_ALLOWED Android: missing manifest permissions, iOS: opted out
  - ALWAYS_ALLOWED Android: has manifest permissions, iOS: opted in background and foreground
  - FOREGROUND_ALLOWED iOS only: opted in foreground only
  - UNPROMPTED: iOS only
  Possible values: SYSTEM_LOCATION_DISABLED, NOT_ALLOWED, ALWAYS_ALLOWED, FOREGROUND_ALLOWED, UNPROMPTED
- push_opt_in string
  Indicates whether or not the device is opted into push notifications.
- ua_sdk_version string
  The version of the Airship SDK used in the app.
channel stringREQUIRED
The unique, platform-agnostic channel identifier for a device.
device_type stringREQUIRED
The platform that the channel is on.
Possible values: IOS, ANDROID, AMAZON
identifiers object
Identifying information specific to app devices.
OBJECT PROPERTIES
- com.urbanairship.aaid string
  Android/Fire OS ad identifier
- com.urbanairship.gimbal.aii string
  Gimbal application instance identifier
- com.urbanairship.idfa string
  Apple ad identifier
- com.urbanairship.limited_ad_tracking_enabled string
  If true, the user has enabled limited ad tracking.
  Possible values: true, false
- com.urbanairship.vendor string
  Apple vendor identifier
ios_channel string
The identifier for an iOS channel. In general, this is also the same value as the channel.
named_user_id string
The Named User identifier for the device.

Used in:

Open an event stream

Examples

{
    "channel": "a6b392d6-3b0d-4c00-98ef-5cb91d51268a",
    "device_type": "IOS",
    "named_user_id": "Albert",
    "identifiers": {
      "com.urbanairship.idfa": "fb0d01e0-9e21-4466-9217-8eacfd2b81c7",
      "com.urbanairship.gimbal.aii": "c5720f06-516a-4b91-b7bb-53523fc43a3d",
      "com.urbanairship.limited_ad_tracking_enabled": "false"
    },
    "attributes": {
      "app_package_name": "com.company_name.app_name",
      "app_version": "1.0.0",
      "ua_sdk_version": "7.0.2"
    }
  }

Device information for SMS and email

Information about the SMS or email device related to an event.

OBJECT PROPERTIES

channel stringREQUIRED
The channel identifier.
delivery_address string
- If device_type is SMS, this field shows the MSISDN.
- If device_type is EMAIL, this field shows the email address.
device_type stringREQUIRED
The platform that the channel is on.
Possible values: EMAIL, SMS
named_user_id string
The Named User the channel is associated with.

Used in:

Open an event stream

Named User

User information for events which occur at the user level.

OBJECT PROPERTIES

named_user_id stringREQUIRED
The Named User identifier for the device.

Used in:

Open an event stream

Open channel device information

Information about open channel users.

OBJECT PROPERTIES

channel string
The unique, platform-agnostic channel identifier for a device.
device_type string
The platform that the channel is on.
Possible values: OPEN
named_user_id string
The Named User identifier for the device.
open_platform_name string
If device_type is set to OPEN, this field shows the full name of the platform.

Used in:

Open an event stream

Web device information

Information about web users generated by the SDK.

OBJECT PROPERTIES

attributes object
OBJECT PROPERTIES
- iana_timezone string
  The time zone of the device.
- locale_country_code string
  The ISO 3166-1 country code as defined in device settings.
- locale_language_code string
  The ISO 639-1 two-letter language code reflecting the language that the device is set to.
- locale_timezone string
  The device’s time zone offset in seconds from UTC.
- locale_variant string
  The language variant.
- push_opt_in stringREQUIRED
  Indicates whether or not the device is opted into push notifications.
- ua_sdk_version stringREQUIRED
  The version of the Airship SDK used in the app.
- web_browser_name stringREQUIRED
  The name of the browser running the SDK.
- web_browser_type stringREQUIRED
  Indicates whether the browser was running on a desktop or mobile device.
- web_browser_version stringREQUIRED
  The version of the browser.
- web_user_agent_string stringREQUIRED
  The user agent reported by the browser.
channel stringREQUIRED
The unique, platform-agnostic channel identifier for a device.
device_type stringREQUIRED
The platform that the channel is on.
Possible values: WEB
named_user_id string
The Named User identifier for the device.

Used in:

Open an event stream