Real-Time Data Streaming API

Airship’s Real-Time Data Streaming (RTDS) service exposes an event stream for each user. Events may be behavior-driven, system-driven, or custom. Use the RTDS REST API to consume and integrate Airship user event data.

Libraries

Airship maintains open source server libraries to support your integrations with our APIs in multiple languages. Click below for library documentation.

• Python
• Java
• Node

Introduction

Airship’s Real-Time Data Streaming API exposes a stream of events describing a user’s experience within a mobile app or browser. Events reflect user action, automated device responses to their environment (e.g., encountering a beacon), and experience-changing actions initiated by app/site publishers, such as sending a push notification.

To consume the event stream, you must issue an authenticated request including a starting point for the stream and optional filter and subset specifications.

The event data is delivered as newline-delimited JSON , with each event on its own line. The accept header should be set to application/vnd.urbanairship+x-ndjson; version=3;. Each event contains an offset that denotes its location on the stream. If a client disconnects for any reason, it should reconnect with instructions to start at the last offset it successfully processed, to avoid missing any data. For each app key authorized to use Real-Time Data Streaming, Airship stores 7 days or 100 GB worth of data, whichever comes first.

Base URL

Select the domain associated with your Airship project.

• https://connect.urbanairship.com
  The North American base URL for Airship’s Real-Time Data Streaming API
• https://connect.asnapieu.com
  The European base URL for Airship’s Real-Time Data Streaming API

Authentication

For additional information, including steps for creating bearer tokens and OAuth client credentials, see Airship API Security.

• HTTP Authentication

  Basic Auth (Master)
  Authorization header containing the word Basic followed by a space and a Base64-encoded string generated from your App KeyThe unique identifier for your Airship project. It is used to authenticate the application for API calls. and Master SecretA secret that can be used as the Basic authorization password for any API call. Guard the Master Secret carefully, and never embed it in an application you distribute to users. in appKey:masterSecret format. For example, Basic YXBwX2tleTptYXN0ZXJfc2VjcmV0. This security type is only accepted by the Compliance endpoint.

• HTTP Authentication

  Bearer Token
  Authorization header containing the word Bearer followed by a space and a bearer token, which can be obtained from Airship when configuring a direct integration. Tokens can be revoked at will.

Event Stream

Opens an event stream to your filter specifications.

Open an event stream

POST /api/events HTTP/1.1
Authorization: Bearer <authorization token>
X-UA-Appkey: <appkey>
Accept: application/vnd.urbanairship+x-ndjson; version=3;
Content-Type: application/json

{
    "filters": [
        {
            "device_types": [
                "android",
                "amazon"
            ],
            "devices": [
                {
                    "channel": "5b389366-7caf-43e2-a19c-6159c7ea9936"
                },
                {
                    "channel": "c8044c8a-d5fa-4e58-91d4-54d0f70b7409"
                },
                {
                    "named_user_id": "George"
                }
            ],
            "latency": 20000000
        },
        {
            "notifications": [
                {
                    "group_id": "a30abf06-7878-4096-9535-b50ac0ad6e8e"
                }
            ],
            "types": [
                "OPEN"
            ]
        }
    ],
    "resume_offset": "MTAwMDAwMDAyMjg1NA",
    "subset": {
        "proportion": 0.3,
        "type": "SAMPLE"
    }
}

HTTP/1.1 200 OK
Content-encoding: gzip
Content-Type: application/vnd.urbanairship+json; version=3;

{"id" : "ff76bb85-74bc-4511-a3bf-11b6117784db", "type": "UNINSTALL", "offset": "MTIzNQ", "occurred": "2015-05-03T02:32:12.088Z", "processed": "2015-05-03T12:12:43.180Z", "device": {"channel":"a61448e1-be63-43ee-84eb-19446ba743f0", "device_type":"ANDROID", "android_channel": "a61448e1-be63-43ee-84eb-19446ba743f0"}}
{"id" : "8e50350e-dd9f-41af-b98e-b0e5d4b27dea","type": "SEND","offset": "NTIxMDM1","occurred": "2015-05-02T02:31:22.088Z","processed": "2015-05-02T02:32:43.181Z","device": {"channel":"5117f2a7-ba58-4981-9456-169959511d1a", "device_type":"IOS", "ios_channel": "5117f2a7-ba58-4981-9456-169959511d1a" },"body": {"push_id": "0c173744-dd35-4b5e-9f7f-2b7e0ce0e36e", "alerting": true}}
{"id" : "ff76bb85-74bc-4511-a3bf-11b6117784db", "type": "UNINSTALL", "offset": "MTIzNQ", "occurred": "2015-05-03T02:32:12.088Z", "processed": "2015-05-03T12:12:43.180Z", "device": {"channel":"a61448e1-be63-43ee-84eb-19446ba743f0", "device_type":"ANDROID", "android_channel": "a61448e1-be63-43ee-84eb-19446ba743f0"}}
{"device":{"channel":"820e4493-e4c9-4577-99bc-a98180599f73","delivery_address":"new.user@urbanairship.com","device_type":"EMAIL"},"id":"00000169-4a14-67b2-1ddd-d9e733622c3a","occurred":"2019-03-04T19:00:45.106Z","offset":"1000001260057","processed":"2019-03-04T19:00:47.094Z","type":"FIRST_OPT_IN"}

{
   "id": "8e50350e-dd9f-41af-b98e-b0e5d4b27dea",
   "type": "SEND",
   "offset": "NTIxMDM1",
   "occurred": "2015-05-02T02:31:22.088Z",
   "processed": "2015-05-02T02:32:43.181Z",
   "device": {
      "channel": "5117f2a7-ba58-4981-9456-169959511d1a",
      "device_type": "IOS"
   },
   "body": {
      "push_id": "0c173744-dd35-4b5e-9f7f-2b7e0ce0e36e",
      "alerting": true
   }
}
{
  "device": {
    "channel": "820e4493-e4c9-4577-99bc-a98180599f73",
    "delivery_address": "new.user@urbanairship.com",
    "device_type": "EMAIL"
  },
  "id": "00000169-4a14-67b2-1ddd-d9e733622c3a",
  "occurred": "2019-03-04T19:00:45.106Z",
  "offset": "1000001260057",
  "processed": "2019-03-04T19:00:47.094Z",
  "type": "FIRST_OPT_IN"
}

POST /api/events

Opens a new event stream according to your request filters. Unlike our other APIs, a request to /api/events/ returns a stream of data, where each line is a JSON object. The response body contains all the events in that stream. Since streams by definition go on forever, Real-Time Data Streaming will never end the response without some external reason.

Security:

• HTTP Bearer Token

• X-UA-Appkey : StringREQUIRED

  The App Key for the app you want to return events from.

  The application key.

Request Body

• Content-Type: application/json

  Events request

  The request body defines the events you want to return in the event stream. You can define position, subset and filter specifications in each request submitted to the stream. Filters are positive statements about what events the client should return. The subset specification returns a representative portion of the stream.

Responses

• 200

  The response to a successful request is an unending stream of newline-delimited JSON . Each non-empty line in the response represents a single event.

  This response body is of arbitrarily large size. As long as the connection is open, Airship will continue to write to the data stream. If no events have been dispatched down a connection for some time, the API will write to the connection to prevent it from being closed for inactivity. By default, only a blank line (a single newline character) will be written. If the enable_offset_updates field in the request is true, then instead of a blank line, an event will be written with type OFFSET_UPDATE. These events have no body or device field, and always have occurred and processed times indicating when they were sent. The offset field will contain the offset of the last event considered for inclusion in the stream whether or not it was actually sent. This may be useful to track position in the stream when using a filter which removes much of it.

  These events should not be stored, and will be different for every connection even if requests are identical. OFFSET_UPDATE events are not subject to filters, and if requested will be delivered regardless of those specified. You should always check the type field before handling any delivered event.

  If you receive no data or new line characters for ninety seconds, close the connection and reconnect.

  RESPONSE BODY

  • Content-Type: application/vnd.urbanairship+x-ndjson; version=3;

    One of

    • Attribute operation event

      Attribute operation events indicate a change in the device’s attributes. Because attribute operations are related to a device, they will have a device field.

      If you set an attribute on a Named User, Airship records events for each device associated with the Named User.

    • Close

      Occurs when a user closes the app. Close events are often latent, as they aren’t sent back to Airship until the user activates the app again.

    • Compliance Event

      Events relating to regulatory compliance for email and SMS channels.

      All of

      • Object

        OBJECT PROPERTIES

        • id : StringREQUIRED

          Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

        • occurred : StringREQUIRED

          When the event occurred.

        • offset : String

          An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

        • processed : StringREQUIRED

          When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

        • type : StringREQUIRED

          Compliance events are the only types of events returned by this event stream.

          Possible values: COMPLIANCE

      • One of

        • Email bounce event

          An event that occurs when an email could not be delivered to a particular address. The bounce_class can provide more information about why the message bounced.

        • Email create-and-send event

          An event that occurs for email addresses used as a part of a create-and-send message.

        • Email registration event

          An event that occurs when users register to receive email messages.

        • Email unsubscribe event

          A compliance event representing a user who unsubscribed from your email notifications.

        • SMS API initiated opt-in event

          Occurs when an SMS user is registered via the SMS Channel Registration API without an opted_in value — indicating that the user has initiated, but not completed, the registration process. While this event contains a channel_id, you cannot send messages to this channel until the associated user completes the opt-in process (indicated by a mobile_opt_in event).

        • SMS carrier deactivation event

          Occurs when an MSISDN is deactivated by a carrier. This event type does not contain additional properties.

        • SMS create-and-send event

          An event that occurs for SMS channels used as a part of a create-and-send message.

        • SMS custom keyword response event

          Occurs when a mobile-originated keyword is matched, and elicits a custom response.

        • SMS mobile create channel event

          If a channel does not exist for the MSISDN/sender combination and your account is configured to create a channel if none exists in such instances, we will emit this event. The resulting channel will necessarily be opted out, awaiting an opt-in action by the user.

        • SMS mobile keyword matched event

          Occurs when a mobile-originated message contains a recognized keyword.

        • SMS mobile keyword unmatched event

          Occurs when a mobile-originated message does not contain a recognized keyword.

        • SMS mobile opt in event

          Occurs when a user opts in to text messages via a keyword.

        • SMS mobile opt out event

          Occurs when a user sends a MO message that matches a keyword with an opt-out action. If present, this event would supplant a mobile_keyword_matched event.

        • SMS opted out event

          Occurs when a user is opted out of an SMS audience via the Airship API, i.e., not via an opt-out keyword. This event type does not contain additional properties.

        • SMS registration event

          Occurs when a user opts in to receive SMS messages from you, via a call to the SMS registration API.

        • SMS update event

          When an SMS event update occurs.

        • SMS uninstalled event

          Occurs when the SMS uninstall API is called.

        • SMS mobile terminated message event

          Occurs when Airship sends an SMS message to a user. The message represented by this event could be a response to an individual mobile-originated (MO) message, or a message initiated from the Airship UI/API.

    • Control

      Occurs when a device is excluded from a push because it was arbitrarily selected as a member of a control group. Membership in a control group indicates what would’ve happened if you did not send a message to a user at all. This occurs for A/B Test-related pushes only.

    • Custom

      Represents Custom Events that are either emitted from the Airship SDK or submitted through the Custom Events API. You can configure Custom Events yourself. There are also several CUSTOM-type events for email and SMS that are defined by Airship.

      In general, you can expect device information if the event source is SDK or if the event is one of the defined email or SMS events (as defined by event_type).

    • First open

      This event occurs when a user opens an Airship-integrated app for the first time.

    • First opt-in

      This event appears in the stream when a channel is first opted in. This event is specific to email (commercial), SMS, and open channels.

    • In-app button tap

      Occurs when a button is tapped within a SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions..

    • In-app message display

      Occurs when an In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. or SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. is displayed to a user. Because the event pertains to a specific device, the device information object will be populated.

    • In-app message expiration

      Occurs when a new In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. or SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. message has taken the place of another message, a message has passed its expiration, or because displaying the message in-app would be redundant. This event type may be latent. It is not emitted until the app becomes active.

    • In-app message resolution

      Occurs when an In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. or SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. is cleared from the display, either by user action or timeout. Because this event pertains to an individual device, the device information object will be present.

    • In-app page swipe

      Occurs when a user swipes to the next or previous page (screen) in a pager (specific to ScenesA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions.).

    • In-app page view

      Occurs when a page (screen) is displayed within a pager (specific to ScenesA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions.).

    • In-app pager completed

      Occurs when the last page (screen) of a pager is viewed for the first time (specific to ScenesA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions.).

    • In-app pager summary

      Describes the full path a user took within a pager (specific to ScenesA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions.), including the order of pages (screens) visited and time spent per page.

    • Location

      An event declaring the device to be at a particular latitude and longitude.

    • Mobile originated event

      Represents a message action that originated from a user — like an inbound SMS or email.

    • Open

      Occurs when a user opens your app.

    • Push body

      Occurs when you initiate a push, automation, or sequence.

      Airship fulfills delivery over a time interval with a number of child pushes, each with a unique Push ID and a common Group ID. There is no guarantee that push body events (defined in Push Body Event) for the child pushes fulfilling a group will appear in the stream.

      Note: When you start, pause, or publish a sequence, Airship emits a push_body event for the sequence itself, and each message contained within the sequence (i.e., messages +1). After you start a sequence, Airship does not issue subsequent push_body events for the sequence unless you pause or publish changes to the sequence.

    • Region event

      Region events are emitted when a device enters or exits a geofence or the range of any of a set of bluetooth beacons. Region events require a Gimbal integration. Events for Gimbal customers include the Gimbal application instance identifier as com.urbanairship.gimbal.aii within the identifiers object.

    • Rich control

      Occurs when a Message CenterA place in your app where you can display persistent rich messages, including HTML, video, etc. Similar to email, Message Center represents both the medium (the in-app inbox) and the message type (the messages you send to the inbox). message is not delivered to a user because they are in a control group.

    • Rich delete

      Occurs when a user deletes a Message CenterA place in your app where you can display persistent rich messages, including HTML, video, etc. Similar to email, Message Center represents both the medium (the in-app inbox) and the message type (the messages you send to the inbox). message from their inbox.

    • Rich delivery

      Occurs when a Message CenterA place in your app where you can display persistent rich messages, including HTML, video, etc. Similar to email, Message Center represents both the medium (the in-app inbox) and the message type (the messages you send to the inbox). message is delivered to a user’s inbox.

      Even though rich push deliveries may or may not cause an alert on the user’s lock screen, they are always associated with a push identifier in the Airship system.

    • Rich read

      Occurs when a user reads a Message CenterA place in your app where you can display persistent rich messages, including HTML, video, etc. Similar to email, Message Center represents both the medium (the in-app inbox) and the message type (the messages you send to the inbox). message in their inbox.

    • Screen viewed

      Occurs when a user has finished viewing a screen. It is up to you to instrument your application with names for each screen. Doing so will allow you to determine the user’s path by filtering on the fields in the table below.

    • Send

      Occurs whenever a push notification is sent to a device identified in the audience selector of a message.

    • Send aborted

      Occurs when a push is dropped from our system before delivery is attempted. This can happen:

      • When using External Data FeedsA connection to an external API. When you send a message, Airship uses a response from that API to personalize messages. to personalize a message and an error was encountered or the feed returned a non-successful response
      • When a Message LimitLimits that cap the number of messages you can send within a specified time frame, preventing you from over-messaging your users. They are set at the project level. is met
      • When a Ban ListAn externally maintained record of users that should not be included in Airship message audiences. Before sending a message, Airship validates the audience members with the Ban List. Any matching recipients are dropped from the audience before sending the message. webhook issues a drop response for a user

      Device information for the device that did not receive the push is included with SEND_ABORTED events.

    • Send rejected

      Occurs when a push fails during communication with a third party, like APNs or GCM. This typically indicates that the user has uninstalled the app or otherwise invalidated the last-registered credentials stored in Airship. The event contains the rejected push and the group, variant, or campaigns the push belonged to.

      Device information for the device that did not receive the push is included with SEND_REJECTED events.

    • Short link click event

      Occurs when a user taps or “clicks” an Airship-shortened link in an SMS or MMS message.

    • Subscription event

      SUBSCRIPTION events reflect changes to users’ subscription preferences — reflected in opt_in and opt_out values. These events help you track a user’s subscription status in the system and the total number of subscribers.

    • Subscription list event

      Occurs when subscription list enrollment changes for a device or user.

    • Tag change

      Occurs when tags change for a device.

    • Uninstall

      Occurs when a user uninstalls an Airship-integrated app in response to a push.

    • Web click event

      Occurs when a user interacts with a web notification, e.g., clicked or tapped it. Web Click events have a device attribute on the event indicating the channel that was the target of the notification. The body of a Web Click Event is an associated push object.

    • Web session event

      Occurs when an opted in user begins interacting with a website. Web Session events have a device attribute, indicating the channel associated with the user.

• 402

  Like other UA applications, Real-Time Data Streaming supports a limited number of simultaneous connections. If you exceed this number, you may receive this response.

• 404

  We do not have data for the specified App key. This is likely because we have yet to ingress or generate any data for your app.

Compliance Event Stream

The compliance event stream provides real-time access to COMPLIANCE type events. This endpoint is open to all Airship users.

Open a compliance event stream

POST /api/events/general HTTP/1.1
Authorization: Basic <master authorization string>
X-UA-Appkey: <appkey>
Accept: application/vnd.urbanairship+x-ndjson; version=3;
Content-Type: application/json

{
  "start":"LATEST",
  "enable_offset_updates": true
}

HTTP/1.1 200 OK
Content-encoding: gzip
Content-Type: application/vnd.urbanairship+json; version=3;

{
  "id": "9781ff2e-fa4a-4fa8-bd9d-41f318c48963",
  "offset": "1000001778910",
  "occurred": "2018-11-28T00:02:41.794Z",
  "processed": "2018-11-28T00:02:45.270Z",
  "device": {
      "channel": "5a39b6d8-0a5a-4c2b-a4a0-3d4a71e5254b",
      "device_type": "EMAIL",
      "delivery_address": "bogus@example.com"
  },
  "body": {
      "event_type": "bounce",
      "properties": {
          "bounce_event_type": "bounce",
          "sender": "msprvs1=17870ayYKWpBI=bounces-179492-4@example.com",
          "subject": "You there?",
          "email": "bogus@example.com",
          "bounce_class": "10"
      }
  },
  "type": "COMPLIANCE"
}

POST /api/events/general

Opens a stream delivering events proving data-safety regulation compliance for email and SMS channel-related events (registration, unsubscription, etc.).

Unlike a standard event stream, a compliance event stream is uses basic authorization (like API calls to https://go.urbanairship.com/api)

Security:

• HTTP Basic Auth (Master)

• X-UA-Appkey : StringREQUIRED

  The App Key for the app you want to return compliance events for.

  The application key.

Request Body

• Content-Type: application/json

  Compliance request

  A request for compliance events is much like a request to /api/events, but has a limited scope.

Responses

• 200

  The response to a successful request is an unending stream of newline-delimited JSON . Each non-empty line in the response represents a single compliance event. Unlike events in a normal event stream, this endpoint returns events of the compliance type, and is open to SMS and email customers. As long as the connection is open, Airship will continue to write to the event stream.

  If a stream records no events for a period of time, the API will write a blank line (a single newline character) to the connection to prevent it from being closed for inactivity. If the enable_offset_updates field in the request is true, then the blank line is replaced with an OFFSET_UPDATE event. These events have no body or device field, and always have occurred and processed times indicating when they were sent. The offset field will contain the offset of the last event considered for inclusion in the stream whether or not it was actually sent. This may be useful to track position in the stream when using a filter which removes much of it.

  You should not store these events; they will be different for every connection even if requests are identical. OFFSET_UPDATE events are not subject to filters, and are delivered even if not specified in the list of events you want to return. You should always check the type field before handling any delivered event.

  If you do not receive data or new line characters for ninety seconds, close the connection and reconnect.

  RESPONSE BODY

  • Content-Type: application/vnd.urbanairship+x-ndjson; version=3;

    Events relating to regulatory compliance for email and SMS channels.

    All of

    • Object

      OBJECT PROPERTIES

      • id : StringREQUIRED

        Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

      • occurred : StringREQUIRED

        When the event occurred.

      • offset : String

        An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

      • processed : StringREQUIRED

        When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

      • type : StringREQUIRED

        Compliance events are the only types of events returned by this event stream.

        Possible values: COMPLIANCE

    • One of

      • Email bounce event

        An event that occurs when an email could not be delivered to a particular address. The bounce_class can provide more information about why the message bounced.

      • Email create-and-send event

        An event that occurs for email addresses used as a part of a create-and-send message.

      • Email registration event

        An event that occurs when users register to receive email messages.

      • Email unsubscribe event

        A compliance event representing a user who unsubscribed from your email notifications.

      • SMS API initiated opt-in event

        Occurs when an SMS user is registered via the SMS Channel Registration API without an opted_in value — indicating that the user has initiated, but not completed, the registration process. While this event contains a channel_id, you cannot send messages to this channel until the associated user completes the opt-in process (indicated by a mobile_opt_in event).

      • SMS carrier deactivation event

        Occurs when an MSISDN is deactivated by a carrier. This event type does not contain additional properties.

      • SMS create-and-send event

        An event that occurs for SMS channels used as a part of a create-and-send message.

      • SMS custom keyword response event

        Occurs when a mobile-originated keyword is matched, and elicits a custom response.

      • SMS mobile create channel event

        If a channel does not exist for the MSISDN/sender combination and your account is configured to create a channel if none exists in such instances, we will emit this event. The resulting channel will necessarily be opted out, awaiting an opt-in action by the user.

      • SMS mobile keyword matched event

        Occurs when a mobile-originated message contains a recognized keyword.

      • SMS mobile keyword unmatched event

        Occurs when a mobile-originated message does not contain a recognized keyword.

      • SMS mobile opt in event

        Occurs when a user opts in to text messages via a keyword.

      • SMS mobile opt out event

        Occurs when a user sends a MO message that matches a keyword with an opt-out action. If present, this event would supplant a mobile_keyword_matched event.

      • SMS opted out event

        Occurs when a user is opted out of an SMS audience via the Airship API, i.e., not via an opt-out keyword. This event type does not contain additional properties.

      • SMS registration event

        Occurs when a user opts in to receive SMS messages from you, via a call to the SMS registration API.

      • SMS update event

        When an SMS event update occurs.

      • SMS uninstalled event

        Occurs when the SMS uninstall API is called.

      • SMS mobile terminated message event

        Occurs when Airship sends an SMS message to a user. The message represented by this event could be a response to an individual mobile-originated (MO) message, or a message initiated from the Airship UI/API.

Data Formats

Events

Contains information about events organized by type. Some events contain additional subtypes or device information.

Attribute operation event

Attribute operation event

{
  "id": "00000173-bb88-8804-b6ec-a40f4ae36648",
  "offset": "1000059326194",
  "occurred": "2020-08-04T22:12:33.924Z",
  "processed": "2020-08-04T22:12:37.672Z",
  "device": {
      "android_channel": "b57f0e3c-da10-4a2b-99d2-5fe2cb30cad3",
      "channel": "b57f0e3c-da10-4a2b-99d2-5fe2cb30cad3",
      "device_type": "ANDROID",
      "named_user_id": "cool_user",
      "attributes": {
        "locale_variant": "",
        "app_version": "2020-02-10T222436-staging",
        "device_model": "Pixel 2 XL",
        "connection_type": "WIFI",
        "app_package_name": "com.company_name.app_name",
        "iana_timezone": "America/Los_Angeles",
        "push_opt_in": "true",
        "locale_country_code": "US",
        "device_os": "10",
        "locale_timezone": "-25200",
        "locale_language_code": "en",
        "location_enabled": "false",
        "background_push_enabled": "true",
        "ua_sdk_version": "12.2.0",
        "location_permission": "NOT_ALLOWED"
      }
  },
  "body": {
      "set": [
        {
            "key": "first_name",
            "value": "Pierre"
        }
      ]
  },
  "type": "ATTRIBUTE_OPERATION"
}

• Attribute operation events indicate a change in the device’s attributes. Because attribute operations are related to a device, they will have a device field.

  If you set an attribute on a Named User, Airship records events for each device associated with the Named User.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    Min properties: 1

    OBJECT PROPERTIES

    • remove : Array [Object]

      The attributes removed from the device in this event. Min items: 1

      ARRAY ITEM
      • OBJECT PROPERTIES

        • key : StringREQUIRED

          The attribute being removed.

    • set : Array [Object]

      Min items: 1

      ARRAY ITEM

      • The attributes set on the device in this event.

        OBJECT PROPERTIES

        • key : StringREQUIRED

          The attribute being set.

        • value : AnyREQUIRED

          The value for the attribute.

          One of

          • String

          • Number

  • device : AnyREQUIRED

    One of

    • App device information

      Information about app users generated by the SDK.

    • Web device information

      Information about web users generated by the SDK.

    • Device information for SMS and email

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

    • Open channel device information

      Information about open channel users.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: ATTRIBUTE_OPERATION

Close

Close

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
    },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
    }
  },
  "body": {
    "session_id": "61acb6c9-527b-4632-b789-a3e6085b094e"
  },
  "type": "CLOSE"
}

• Occurs when a user closes the app. Close events are often latent, as they aren’t sent back to Airship until the user activates the app again.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: CLOSE

Control

Control

{
  "id" : "ff76bb85-74bc-4511-a3bf-11b6117784db",
  "type": "CONTROL",
  "offset": "MTIzNQ",
  "occurred": "2015-05-03T02:32:12.088Z",
  "processed": "2015-05-03T12:12:43.180Z",
  "device": {
      "channel":"a61448e1-be63-43ee-84eb-19446ba743f0",
      "device_type":"ANDROID",
      "android_channel": "a61448e1-be63-43ee-84eb-19446ba743f0"
    },
  "body:" {
    "push_id": "c91d9e1b-605f-4bad-a45d-cdf3e6e0773f",
    "group_id": "3eec7de4-4b19-436e-ad15-88278f9ddb82"
    }
  }

• Occurs when a device is excluded from a push because it was arbitrarily selected as a member of a control group. Membership in a control group indicates what would’ve happened if you did not send a message to a user at all. This occurs for A/B Test-related pushes only.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • campaigns : Object

      An object listing the campaigns a push specification is associated with. The campaigns object includes an array of categories that must have between 1 and 10 elements, each of which is a string with a 64-byte and -character limit.

      OBJECT PROPERTIES

      • categories : Array [String]

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

  • device : AnyREQUIRED

    One of

    • App device information

      Information about app users generated by the SDK.

    • Web device information

      Information about web users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: CONTROL

Custom

Custom

{
  "id": "4f42e8d0-a010-11ee-ae53-000000a91ace",
  "offset": "1009810398823",
  "occurred": "2023-12-21T14:50:35.077Z",
  "processed": "2023-12-21T14:50:40.843Z",
  "device": {
    "android_channel": "ac1960b9-24b6-4851-b907-b9e64f071890",
    "channel": "ac1960b9-24b6-4851-b907-b9e64f071890",
    "device_type": "ANDROID",
    "named_user_id": "c2cbc6e5145763ec58a4d85dfa4323aacc40afea",
    "attributes": {
      "locale_variant": "",
      "connection_type": "CELL",
      "device_model": "M2101K9G",
      "app_version": "18.4.2",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "Europe/Paris",
      "push_opt_in": "true",
      "locale_country_code": "FR",
      "device_os": "12",
      "locale_timezone": "3600",
      "carrier": "Orange F",
      "locale_language_code": "fr",
      "background_push_enabled": "true",
      "ua_sdk_version": "16.9.2"
    }
  },
  "body": {
    "name": "purchased",
    "value": 239.85,
    "transaction": "886f53d4-3e0f-46d7-930e-c2792dac6e0a",
    "interaction_id": "your.store/us/en_us/pd/shoe/pid-11046546/pgid-10978234",
    "interaction_type": "url",
    "properties": {
      "description": "Sneaker purchase",
      "brand": "Victory Sneakers",
      "colors": [
        "red",
        "blue"
      ],
      "items": [
        {
          "text": "New Line Sneakers",
          "price": "$ 79.95"
        },
        {
          "text": "Old Line Sneakers",
          "price": "$ 79.95"
        },
        {
          "text": "Blue Line Sneakers",
          "price": "$ 79.95"
        }
      ],
      "name": "Hugh Manbeing",
      "userLocation": {
        "state": "CO",
        "zip": "80202"
      }
    }
  },
  "session_id": "adc0e12e-dfe8-4375-8121-5b21dbab87f4",
  "source": "SDK",
  "type": "CUSTOM"
}

{
  "name" : "shoe-purchase",
  "value" : 239.85,
  "source": "api",
  "transaction" : "Selling all the shoes",
  "session_id": "cfe467a6-ca70-40dd-8c1f-07b2f644935e",
  "properties": {
    "description": "Sneaker purchase",
    "brand": "Victory Sneakers",
    "colors": ["red","blue"],
    "items": [
      {
          "text": "New Line Sneakers",
          "price": "$ 79.95"
      },
      {
          "text": "Old Line Sneakers",
          "price": "$ 79.95"
      },
      {
          "text": "Blue Line Sneakers",
          "price": "$ 79.95"
      }
    ],
    "name": "Hugh Manbeing",
    "userLocation": {
      "state": "CO",
      "zip": "80202"
    }
  }
}

{
  "name" : "shoe-purchase",
  "value" : 60.000000,
  "source": "sdk",
  "interaction_type" : "Landing Page",
  "interaction_id" : "d01d0380-da2e-11e3-8519-90e2ba299b38",
  "customer_id" : "George@example.com",
  "transaction" : "Selling all the shoes",
  "session_id": "cfe467a6-ca70-40dd-8c1f-07b2f644935e",
  "last_delivered": {
    "push_id": "6e3339ce-529c-42e4-a2f6-7546f81c9828"
  },
  "triggering_push": {
    "push_id": "c2f6c5c5-f353-49c0-b5f7-6e87cf9b1a06",
    "group_id": "8ea2abd6-dbc7-475a-9c57-fb31c7e2999b"
  },
  "properties": {
    "coolest-identifier": "123-cool-cat-321",
    "ltv": false,
    "category": "womens_shoes",
    "id": 1267,
    "description": "plaid canvas",
    "brand": "hipster",
    "new_item": true
  }
}

• Represents Custom Events that are either emitted from the Airship SDK or submitted through the Custom Events API. You can configure Custom Events yourself. There are also several CUSTOM-type events for email and SMS that are defined by Airship.

  In general, you can expect device information if the event source is SDK or if the event is one of the defined email or SMS events (as defined by event_type).

  All of

  • Object

    OBJECT PROPERTIES

    • id : StringREQUIRED

      Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

    • occurred : StringREQUIRED

      When the event occurred.

    • offset : StringREQUIRED

      An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

    • processed : StringREQUIRED

      When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

    • type : StringREQUIRED

      Possible values: CUSTOM

  • One of

    • Email delivery event

      Occurs when the remote MTA (email server) acknowledges receipt of a message.

    • Email injection event

      This event occurs when the provider (SparkPost) receives a message — typically when a member of the audience responds to an email.

    • Email open event

      Occurs when a recipient opens an email, rendering a tracking pixel at the bottom of the message. If a message is truncated by a client or email provider, a user may have to open it in a separate window to render the tracking pixel (and register this event).

    • Email delay event

      Occurs when a mailbox provider temporarily rejects an email. In general, this event indicates that the provider will attempt to resend the message.

    • Email bounce event

      Occurs when an email could not be delivered to an address. The bounce_class provides additional information about the reason your message bounced. This event occurs in conjunction with a similar COMPLIANCE event.

    • Email click event

      Occurs when a recipient clicks a tracked link in a message. Tracked links are redirected through the provider’s click-tracking server to record the event. Only HTTP and HTTPS links are tracked. Unsubscribe link clicks do not trigger this event.

    • Email unsubscribe link event

      Occurs when a user clicks an unsubscribe link in an email you sent.

    • SMS delivery report

      Delivery reports are Custom Events sent from our third-party SMS providers. These events report the status of your message between the provider and your audience up to, and including, delivery.

    • General Custom Event : Object

      OBJECT PROPERTIES

      • body : ObjectREQUIRED

        OBJECT PROPERTIES

        • customer_id : String

          An external customer-side ID, such as an email address. Absent if empty.

        • interaction_id : String

          An Airship identifier uniquely identifying the interaction. May be absent.

        • interaction_type : String

          The type of interaction as set by the UA SDK. Values determine whether the interaction triggered an event from the Message Center (ua_mcrap), a landing page (ua_landing_page), an interactive notification (ua_interactive_notification), or a button tap (ua_button_tap).

          Button tap events with custom names are in the format ua_button_tap-<custom name>. For example, for a button action with custom name Cat socks55, the event name is ua_button_tap-Cat socks55. See Buttons and images: App in Actions in the WYSIWYG editor.

          Possible values: ua_mcrap, ua_landing_page, ua_interactive_notification, ua_button_tap, ua_button_tap-<custom name>

        • last_delivered : Object

          Identifies the last push notification the audience received before the event. Absent if the last push occurred more than 12 hours ago.

          OBJECT PROPERTIES

          • campaigns : Object

            An object listing the campaigns a push specification is associated with. The campaigns object includes an array of categories that must have between 1 and 10 elements, each of which is a string with a 64-byte and -character limit.

            OBJECT PROPERTIES

            • categories : Array [String]

          • group_id : String

            Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

            Format: uuid

          • push_id : StringREQUIRED

            A unique identifier for a push operation. Format: uuid

          • time : String

            The UTC time when the push occurred.

          • variant_id : Integer

            The ID of the variant that a push is associated with, if the push was a part of an A/B test (experiment).

        • name : StringREQUIRED

          A plain-text name given to the event.

        • properties : Object

          Supports up to 100 key/value pairs that describe Custom Event properties. If the event has no custom properties, this field is absent. Max properties: 100

        • session_id : String

          Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

        • source : StringREQUIRED

          The event source. SDK indicates an event sent from the UA SDK. API indicates an event created by request against the Custom Events API.

          Possible values: SDK, API

        • transaction : String

          If the event is one in a series representing a single transaction, use the value in this field to tie events together.

        • triggering_push : Associated push

          The push that caused the Custom Event. Absent if a causal relationship to a push cannot be established.

        • value : Number

          Populated if the event is associated with a count or amount. Airship treats this field as a representation of money. The value field respects six digits of precision to the right of the decimal point.

      • device : ObjectREQUIRED

        Device information related to the event. Either the channel or named_user_id is required. The named_user_id is required for Custom Events sent via the API, else channel is required.

        OBJECT PROPERTIES

        • channel : StringREQUIRED

          The unique, platform-agnostic channel identifier for a device.

        • device_type : StringREQUIRED

          The type of device the event was generated from.

          Possible values: OPEN, WEB, ANDROID, IOS, AMAZON, EMAIL, SMS

        • named_user_id : String

          The Named UserA customer-provided identifier used for mapping multiple devices and channels to a specific individual. identifier for a device.

Feature Flag interaction event

Feature Flag interaction event

{
  "id":"c3d0543b-c8cd-4eaa-8fda-5dbfa70257ae",
  "offset":"1000197715722",
  "occurred":"2023-09-15T19:12:56.000Z",
  "processed":"2023-09-21T23:02:39.419Z",
  "device": {
    "channel":"8c36e8c7-5a73-47c0-9716-99fd3d4197d5",
    "device_type":"WEB"
  },
  "body": {
    "flag_id":"27f26d85-0550-4df5-85f0-7022fa7a5925",
    "flag_name":"rad_flag_name",
    "eligible":true
  },
  "type":"FEATURE_FLAG_INTERACTION"
}

• Occurs when a user interacts with a tracked flagged feature. See Feature Flags. The events have a flag ID and flag name, which identify which flagged feature a user interacted with. They also have a boolean eligible field, which indicates whether or not the user was in the Feature Flag audience and had access to the feature.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • eligible : BooleanREQUIRED

      Indicates whether or not the user was in the Feature Flag audience and had access to the feature. true means the user was in the Feature Flag audience and had access to the feature.

    • flag_id : StringREQUIRED

      A UUID that is associated with a feature flag.

    • flag_name : StringREQUIRED

      The name of a feature flag.

  • device : AnyREQUIRED

    One of

    • App device information

      Information about app users generated by the SDK.

    • Web device information

      Information about web users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: FEATURE_FLAG_INTERACTION

First open

First open

{
  "device": {
    "ios_channel": "1ef235f0-03d5-1384-893e-a19b5cd0d110",
    "channel": "1ef235f0-03d5-1384-893e-a19b5cd0d110",
    "device_type": "IOS",
  },
  "id": "00000169-4a14-67b2-1ddd-d9e733622c3a",
  "occurred": "2019-03-04T19:00:45.106Z",
  "offset": "1000001260057",
  "processed": "2019-03-04T19:00:47.094Z",
  "type": "FIRST_OPEN"
}

• This event occurs when a user opens an Airship-integrated app for the first time.

  OBJECT PROPERTIES

  • device : AnyREQUIRED

    One of

    • App device information

      Information about app users generated by the SDK.

    • Web device information

      Information about web users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: FIRST_OPEN

First opt-in

First opt-in

{
  "device": {
    "channel": "820e4493-e4c9-4577-99bc-a98180599f73",
    "delivery_address": "new.user@urbanairship.com",
    "device_type": "EMAIL"
  },
  "id": "00000169-4a14-67b2-1ddd-d9e733622c3a",
  "occurred": "2019-03-04T19:00:45.106Z",
  "offset": "1000001260057",
  "processed": "2019-03-04T19:00:47.094Z",
  "type": "FIRST_OPT_IN"
}

• This event appears in the stream when a channel is first opted in. This event is specific to email (commercial), SMS, and open channels.

  OBJECT PROPERTIES

  • device : AnyREQUIRED

    One of

    • Device information for SMS and email

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

    • Open channel device information

      Information about open channel users.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: FIRST_OPT_IN

In-app button tap

In-app button tap

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "a9a5912c-2526-4383-b516-711c58aff900",
      "group_id": "a9a5912c-2526-4383-b516-711c58aff900",
      "session_id": "94e8caed-9b82-4166-b585-a01eed933855",
      "triggering_push": {
        "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
        "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      },
      "context": {
        "reporting_context": {
          "content_types": [
            "survey"
          ]
        },
        "state": {
          "form": {
            "form_identifier": "870db95f-3715-4c98-8047-2871c175d003",
            "submitted": true,
            "type": "nps",
            "response_type": "nps"
          },
          "pager": {
            "identifier": "9e051354-185b-4d4d-888a-885def2e6b7a",
            "page_identifier": "32f4fc47-74ee-41c6-8e16-c9e0aa364101",
            "page_index": 1,
            "page_count": 2,
            "completed": true
          }
        }
      },
      "button_id": "dismiss_button"
    },
  "type": "IN_APP_BUTTON_TAP"
}

• Occurs when a button is tapped within a SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions..

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app button tap was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • button_id : String

      A unique identifier for the button.

    • context : In-app context

      The context provides the view state when a button, pager, or form interaction occurs.

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • locale : String

      Optional string that defines the country and language this in-app-automation was localized as by remote-config-api. country - (String) An ISO 3166-1 country code, set by device settings. language - (String) The ISO 639-1 two-letter language code reflecting the language the phone is set to.

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      An ISO 8601 date-time indicating when the payload defining the in-app message was sent to the device. May be absent.

    • triggering_push : Associated push

      Appears if the user began the current session by opening a push notification.

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_BUTTON_TAP

In-app experiences

In-app experiences

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "event_name": "scene_displayed",
      "time_sent": "2022-03-11T08:40:56.592Z",
      "session_id": "20162c5f-36c8-1808-6fc6-8eb836d7f7f2",
      "push_id": "2e12bc7b-04f2-3487-1480-44269b04c131",
      "group_id": "2e12bc7b-04f2-3487-1480-44269b04c131",
      "triggering_push": {
        "push_id": "5cc872d5-708d-dffb-0959-991b014dcd2d",
        "time": "2022-03-11T08:40:56.692Z",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      }
    },
  "type": "IN_APP_EXPERIENCES"
}

• Events that occur related to the display and completion behavior of a SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions.. These events are derived from source events generated by the SDK, so a single user action may generate two events: one for the SDK event, one representing the user action as it relates to their actual activity within the app or website.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app message was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • campaigns : Object

      An object listing the campaigns a push specification is associated with. The campaigns object includes an array of categories that must have between 1 and 10 elements, each of which is a string with a 64-byte and -character limit.

      OBJECT PROPERTIES

      • categories : Array [String]

    • event_name : String

      The name of the event.

      Possible values: scene_displayed, scene_completed, scene_incomplete, survey_displayed, survey_submitted, survey_not_submitted

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • survey_type : String

      Only present for survey events.

      Possible values: nps, user_feedback

    • time_sent : String

      An ISO 8601 date-time, in UTC, when the event occurred. May be absent.

    • triggering_push : Associated push

      Present if the user started the current session by opening a push notification.

    • variant_id : Integer

      The ID of the variant that a push is associated with, if the push was a part of an A/B test (experiment).

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_EXPERIENCES

In-app form display

In-app form display

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "56d72d43-5567-4c94-887a-05b46ca9ef3e",
      "group_id": "56d72d43-5567-4c94-887a-05b46ca9ef3e",
      "session_id": "1347589f-0608-4198-b170-bfb46271877a",
      "triggering_push": {
        "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
        "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      },
      "context": {
        "reporting_context": {
          "content_types": [
            "survey"
          ]
        },
        "state": {
          "form": {
            "form_identifier": "434b918f-6a00-496f-963c-f54923a67abf",
            "submitted": false,
            "type": "nps",
            "response_type": "nps"
          }
        }
      },
      "type": "DISPLAY",
      "forms": [
        {
          "form_id": "434b918f-6a00-496f-963c-f54923a67abf"
        }
      ]
    },
  "type": "IN_APP_FORM_DISPLAY"
}

• Occurs when a survey form in a SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. is displayed.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app form was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • context : In-app context

      The context provides the view state when a button, pager, or form interaction occurs.

    • forms : Object

      OBJECT PROPERTIES

      • form_id : String

        The identifier of the form controller (required). Format: uuid

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      An ISO 8601 date-time indicating when the payload defining the in-app message was sent to the device. May be absent.

    • triggering_push : Associated push

      Present if the user started the current session by opening a push notification.

    • type : String

      Required for this type, the value is always DISPLAY.

      Possible values: DISPLAY

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_FORM_DISPLAY

In-app form result

In-app form result

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "683b395d-7abf-40f9-be49-4b64debfbd22",
      "group_id": "683b395d-7abf-40f9-be49-4b64debfbd22",
      "session_id": "d05323b3-8176-406d-aff5-5194341f4a5c",
      "triggering_push": {
        "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
        "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      },
      "context": {
        "reporting_context": {
          "content_types": [
            "survey"
          ]
        },
        "state": {
          "form": {
            "form_identifier": "316e8ed4-277e-408b-9c47-a6bd7a4251c5",
            "submitted": false,
            "type": "nps",
            "response_type": "nps"
          }
        }
      },
      "type": "RESULT",
      "forms": [
        {
          "form_id": "316e8ed4-277e-408b-9c47-a6bd7a4251c5",
          "type": "nps",
          "response_type": "nps",
          "nps": {
            "question_id": "b6563a26-a927-4ff2-af8a-08d94d8b84a3",
            "score": 9,
            "audience_category": "PROMOTER"
          },
          "responses": [
            {
              "question_id": "b6563a26-a927-4ff2-af8a-08d94d8b84a3",
              "type": "score",
              "value": "9"
            },
            {
              "question_id": "c867cf61-398f-443c-b991-443fa8aff4b9",
              "type": "text_input",
              "value": "Hello, world"
            }
          ]
        }
      ]
    },
  "type": "IN_APP_FORM_RESULT"
}

• Occurs when a survey form in a SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. is submitted.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app form was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • context : In-app context

      The context provides the view state when a button, pager, or form interaction occurs.

    • forms : Object

      OBJECT PROPERTIES

      • form_id : String

        The identifier of the form controller (required). Format: uuid

      • nps : Object

        OBJECT PROPERTIES

        • audience_category : StringREQUIRED

          The NPS category.

          Possible values: PROMOTER, PASSIVE, DETRACTOR

        • question_id : StringREQUIRED

          The question identifier. Format: uuid

        • score : NumberREQUIRED

          A number between 0 and 10.

      • response_type : String

        The survey response type.

        Possible values: nps, user_feedback

      • responses : Object

        OBJECT PROPERTIES

        • question_id : StringREQUIRED

          The question identifier. Format: uuid

        • type : StringREQUIRED

          The question type.

          Possible values: single_choice, text_input, multiple_choice

        • value : ObjectREQUIRED

          Can be UUID if its a single_choice or multiple_choice question, and text if it’s an input text.

      • type : String

        The form type.

        Possible values: nps, form

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      An ISO 8601 date-time indicating when the payload defining the in-app message was sent to the device. May be absent.

    • triggering_push : Associated push

      Present if the user started the current session by opening a push notification.

    • type : String

      Required for this type, the value is always RESULT.

      Possible values: RESULT

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_FORM_RESULT

In-app message control

In-app message control

{
  "id": "e9e281d0-2b39-11ee-ac42-00000a91ace1",
  "offset": "1000194023208",
  "occurred": "2023-07-25T22:22:40.262Z",
  "processed": "2023-07-25T22:23:43.464Z",
  "device": {
    "ios_channel": "414a7c7c-c3c5-4a9f-b1de-ebd5a85104e0",
    "channel": "414a7c7c-c3c5-4a9f-b1de-ebd5a85104e0",
    "device_type": "IOS",
    "attributes": {
      "locale_variant": "",
      "connection_type": "WIFI",
      "device_model": "arm64",
      "app_version": "1.0",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "17.0",
      "locale_timezone": "-25200",
      "locale_language_code": "en",
      "background_push_enabled": "true",
      "ua_sdk_version": "17.1.0"
    }
  },
  "body": {
    "push_id": "6fc3b3a7-d860-4acd-b80d-82af02b5b0fa",
    "group_id": "6fc3b3a7-d860-4acd-b80d-82af02b5b0fa",
    "session_id": "f31c3769-8517-402a-8ae6-cdb323f5ec22",
    "context": {
      "reporting_context": {
        "content_types": [
          "scene"
        ]
      }
    },
    "type": "CONTROL"
  },
  "type": "IN_APP_MESSAGE_CONTROL"
}

• Occurs when an In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. or SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. is not delivered because the targeted user’s contact or Channel ID was part of a control group.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app message was created by the application logic, not the Airship system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      The date-time when the in-app message payload was sent to the device.

    • triggering_push : Associated push

      Appears if the user began the current session by opening a push notification.

    • type : String

      Indicates that the in-app message was never delivered because the user was part of an experiment control group.

      CONTROL indicates that the message was not displayed because the channel or contact was hashed into the experiment control group.

      Possible values: CONTROL

    • variant_id : Integer

      The ID of the variant that a push is associated with, if the push was a part of an A/B test (experiment).

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_MESSAGE_CONTROL

In-app message display

In-app message display

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "68be9eba-3f3e-4763-bbd1-c921a164af1b",
      "group_id": "49e59f68-d58c-4a2f-86ab-112f52e3c5d2",
      "variant_id": 5,
      "session_id": "cfe467a6-ca70-40dd-8c1f-07b2f644935e",
      "triggering_push": {
        "push_id": "18c0f649-2330-4fb0-a9fa-ad029f5f4e0e",
        "group_id": "c4c89025-0d25-434c-8040-283990585f01",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      }
    },
  "type": "IN_APP_MESSAGE_DISPLAY"
}

{
    "id": "c7b97941-5d1d-11ee-b7be-00000a91ace6",
    "offset": "1004335885834",
    "occurred": "2023-09-27T10:08:14.965Z",
    "processed": "2023-09-27T10:08:18.230Z",
    "device":
    {
        "android_channel": "3e75f0be-f312-413f-90c0-81d628410514",
        "channel": "3e75f0be-f312-413f-90c0-81d628410514",
        "device_type": "ANDROID",
        "named_user_id": "exampleuser",
        "attributes":
        {
            "locale_variant": "",
            "connection_type": "CELL",
            "device_model": "SM-G981B",
            "app_version": "13.13.3",
            "app_package_name": "com.company_name.app_name",
            "iana_timezone": "Europe/Paris",
            "push_opt_in": "true",
            "locale_country_code": "FR",
            "device_os": "13",
            "locale_timezone": "7200",
            "carrier": "F-Bouygues Telecom",
            "locale_language_code": "fr",
            "background_push_enabled": "true",
            "ua_sdk_version": "16.4.0"
        }
    },
    "body":
    {
        "push_id": "0390bd82-c28f-44cb-98d9-3f9b7eef939d",
        "group_id": "0390bd82-c28f-44cb-98d9-3f9b7eef939d",
        "campaigns":
        {
            "categories":
            [
                "WELCOME_SERIES"
            ]
        },
        "context": {
          "reporting_context": {
            "content_types": [
              "scene"
            ]
          }
        },
        "session_id": "6e11b019-4da0-4c66-8063-92ec2ce4ee36"
    },
    "type": "IN_APP_MESSAGE_DISPLAY"
}

• Occurs when an In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. or SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. is displayed to a user. Because the event pertains to a specific device, the device information object will be populated.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app message was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • campaigns : Object

      An object listing the campaigns a push specification is associated with. The campaigns object includes an array of categories that must have between 1 and 10 elements, each of which is a string with a 64-byte and -character limit.

      OBJECT PROPERTIES

      • categories : Array [String]

    • context : In-app context

      The context provides the view state when a button, pager, or form interaction occurs.

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • triggering_push : Associated push

      Appears if the user began the current session by opening a push notification.

    • variant_id : Integer

      The ID of the variant that a push is associated with, if the push was a part of an A/B test (experiment).

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_MESSAGE_DISPLAY

In-app message exclusion

In-app message exclusion

{
  "id": "7fff2560-1d33-11ef-b484-0000a91acec5",
  "offset":"1000215341033",
  "occurred":"2024-05-28T20:47:20.183Z",
  "processed":"2024-05-28T20:47:31.090Z",
  "device": {
    "android_channel": "88663749-a19d-4daf-8d4c-09fc4cf03a12",
    "channel":"87663620-a99d-4daf-8f4c-88fc4cf03af4",
    "device_type": "ANDROID",
    "named_user_id": "cool_named_user",
    "attributes": {
      "locale_variant": "",
      "connection_type": "WIFI",
      "device_model": "DE2123",
      "app_version": "2024-05-25T040548",
      "app_package_name": "com.package.example",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "120",
      "locale_timezone": "-27000",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "background_push_enabled": "false",
      "ua_sdk_version":"18.0.0"
    }
  },
  "body": {
    "push_id": "be711edb-d16d-465e-8091-a831041e2e53",
    "group_id":"be711edb-d16d-465e-8091-a831041e2e53",
    "session_id":"e8e72fa2-bfbc-405d-af85-8b428c8e38d9",
    "context": {
    },
    "type":"AUDIENCE_CHECK_EXCLUDED"
  },
  "type":"IN_APP_MESSAGE_EXCLUSION"
}

• Occurs when an In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. or SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. is not displayed on a device because the user was banned. See Ban ListAn externally maintained record of users that should not be included in Airship message audiences. Before sending a message, Airship validates the audience members with the Ban List. Any matching recipients are dropped from the audience before sending the message..

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app message was created by the application logic, not the Airship system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      The date-time when the in-app message payload was sent to the device.

    • triggering_push : Associated push

      Appears if the user began the current session by opening a push notification.

    • type : String

      Indicates that the in-app message was not displayed on a device because the channel or Named User was excluded from the push. The only possible value is AUDIENCE_CHECK_EXCLUDED, which indicates that the message was not displayed because the channel or Named User is on a project’s Ban ListAn externally maintained record of users that should not be included in Airship message audiences. Before sending a message, Airship validates the audience members with the Ban List. Any matching recipients are dropped from the audience before sending the message.. This is also reported when a 400- or 500-level error resolving the user’s status on a Ban List occurs.

      Possible values: AUDIENCE_CHECK_EXCLUDED

    • variant_id : Integer

      The ID of the variant that a push is associated with, if the push was a part of an A/B test (experiment).

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_MESSAGE_EXCLUSION

In-app message expiration

In-app message expiration

{
  "id": "910fea50-5d42-1159-b702-024288f4e1d3",
  "offset": "1000022468589",
  "occurred": "2019-04-03T18:59:02.246Z",
  "processed": "2019-04-03T19:10:26.301Z",
  "device": {
    "android_channel": "364a4e3f-170a-4f26-b0a1-11b280377dfe",
    "channel": "364a4e3f-170a-4f26-b0a1-11b280377dfe",
    "device_type": "ANDROID",
    "identifiers": {
      "com.urbanairship.gimbal.aii": "2471037d-71d8-4229-a40f-df719f1af914",
      "session_id": "54204a73-7a95-4ffc-8051-bf230d086e19",
      "GA_CID": "90d56c80-f31f-49fd-87b0-20deb3d2602a"
    },
    "attributes": {
      "locale_variant": "",
      "app_version": "dev",
      "device_model": "Android SDK built for x86",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "9",
      "locale_timezone": "-25200",
      "carrier": "Android",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "9.7.0",
      "location_permission": "NOT_ALLOWED"
    }
  },
  "body": {
    "push_id": "a1fe5f2a-1d51-4f3a-a77b-35018031741d",
    "session_id": "3514bd74-bfa8-149e-9c12-a44794994ca8",
    "triggering_push": {
      "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
      "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
      "campaigns": {
        "categories": [
          "welcome_series"
        ]
      }
    },
    "type": "EXPIRED",
    "time_expired": "1970-01-01T00:00:00.000Z"
  },
  "type": "IN_APP_MESSAGE_EXPIRATION"
}

• Occurs when a new In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. or SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. message has taken the place of another message, a message has passed its expiration, or because displaying the message in-app would be redundant. This event type may be latent. It is not emitted until the app becomes active.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app message was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • replacing_push : Associated push

      An associated push object for the in-app message that replaced the message. Present if type is REPLACED.

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_expired : String

      The date-time when the message was set to expire.

    • time_sent : String

      The date-time when the in-app message payload was sent to the device.

    • triggering_push : Associated push

      Appears if the user began the current session by opening a push notification.

    • type : String

      Indicates how the in-app message expired.

      • REPLACED: The in-app message was replaced by a more current one. If type is REPLACED, the replacing_push key will be present.
      • EXPIRED: The in-app message exceeded its expiration date. If type is EXPIRED, then the time key will be present.
      • ALREADY_DISPLAYED: The message was opened directly (either from the lock screen or notification center). The Airship SDK will NOT display it again in the app, because the user is guaranteed to have seen it.

      Possible values: REPLACED, EXPIRED, ALREADY_DISPLAYED

    • variant_id : Integer

      The ID of the variant that a push is associated with, if the push was a part of an A/B test (experiment).

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_MESSAGE_EXPIRATION

In-app message resolution

In-app message resolution

{
  "id": "910fea50-5d42-1159-b702-024288f4e1d3",
  "offset": "1000022468589",
  "occurred": "2019-04-03T18:59:02.246Z",
  "processed": "2019-04-03T19:10:26.301Z",
  "device": {
    "android_channel": "364a4e3f-170a-4f26-b0a1-11b280377dfe",
    "channel": "364a4e3f-170a-4f26-b0a1-11b280377dfe",
    "device_type": "ANDROID",
    "identifiers": {
      "com.urbanairship.gimbal.aii": "2471037d-71d8-4229-a40f-df719f1af914",
      "session_id": "54204a73-7a95-4ffc-8051-bf230d086e19",
      "GA_CID": "90d56c80-f31f-49fd-87b0-20deb3d2602a"
    },
    "attributes": {
      "locale_variant": "",
      "app_version": "dev",
      "device_model": "Android SDK built for x86",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "9",
      "locale_timezone": "-25200",
      "carrier": "Android",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "9.7.0",
      "location_permission": "NOT_ALLOWED"
    }
  },
  "body": {
    "push_id": "86ee0a6e-a46a-4bbe-a3d1-804891baaee4",
    "group_id": "68991b8d-0d6b-4e05-bc62-2cdec2085c18",
    "triggering_push": {
      "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
      "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
      "campaigns": {
        "categories": [
          "welcome_series"
        ]
      }
    },
    "time_sent": "2019-03-03T19:10:26.301Z",
    "type": "BUTTON_CLICK",
    "button_id": "yes",
    "button_group": "",
    "button_description": "Yes",
    "duration": 10000000000
  },
  "type": "IN_APP_MESSAGE_RESOLUTION"
}

{
    "id": "a0bc5c50-6d34-11ee-95dc-0000a91aced1",
    "offset": "1064988067725",
    "occurred": "2023-10-17T21:32:01.243Z",
    "processed": "2023-10-17T21:32:10.638Z",
    "device":
    {
        "ios_channel": "870c200f-d0e7-4e45-bd99-5b290c80b6a7",
        "channel": "870c200f-d0e7-4e45-bd99-5b290c80b6a7",
        "device_type": "IOS",
        "named_user_id": "exampleuser",
        "attributes":
        {
            "locale_variant": "",
            "connection_type": "WIFI",
            "device_model": "iPhone15,2",
            "app_version": "15.8.1",
            "app_package_name": "com.company_name.app_name",
            "iana_timezone": "America/New_York",
            "push_opt_in": "false",
            "locale_country_code": "US",
            "device_os": "16.6.1",
            "locale_timezone": "-14400",
            "carrier": "AT&T",
            "locale_language_code": "en",
            "background_push_enabled": "true",
            "ua_sdk_version": "16.12.0"
        }
    },
    "body":
    {
        "push_id": "4015241b-2e71-43d8-85a0-cd500e97c15d",
        "group_id": "4015241b-2e71-43d8-85a0-cd500e97c15d",
        "campaigns":
        {
            "categories":
            [
                "OfferLevel45",
                "VIP_OFFER"
            ]
        },
        "context": {
          "reporting_context": {
            "content_types": [
              "scene"
            ]
          }
        },
        "session_id": "832e65de-453e-426d-a4a3-bd70ab0f827e",
        "type": "USER_DISMISSED",
        "duration": 2503
    },
    "type": "IN_APP_MESSAGE_RESOLUTION"
}

• Occurs when an In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. or SceneA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions. is cleared from the display, either by user action or timeout. Because this event pertains to an individual device, the device information object will be present.

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app message was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • button_description : String

      The title of the button the user interacted with. Present if type is set to BUTTON_CLICK.

    • button_group : String

      A category associated with the in-app message button. It may be predefined or custom defined, or blank if there is no association with a category.

    • button_id : String

      A unique identifier for the button. Present if type is set to BUTTON_CLICK.

    • campaigns : Object

      An object listing the campaigns a push specification is associated with. The campaigns object includes an array of categories that must have between 1 and 10 elements, each of which is a string with a 64-byte and -character limit.

      OBJECT PROPERTIES

      • categories : Array [String]

    • context : In-app context

      The context provides the view state when a button, pager, or form interaction occurs.

    • duration : Integer

      The number of milliseconds that the user was on the screen. Format: milliseconds

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      The date-time when the in-app message payload was sent to the device.

    • triggering_push : Associated push

      Appears if the user began the current session by opening a push notification.

    • type : String

      Indicates how the in-app message was resolved.

      • BUTTON_CLICK: The user clicked/tapped a button in the message. This type is accompanied by additional fields.
      • MESSAGE_CLICK: The user clicked/tapped a part of the message, but not a button.
      • TIMED_OUT: The user ignored the notification, and it dismissed itself after an interval of time.
      • USER_DISMISSED: The user clicked/tapped X to close the message or closed it using the swipe gesture.

      Possible values: BUTTON_CLICK, MESSAGE_CLICK, TIMED_OUT, USER_DISMISSED

    • variant_id : Integer

      The ID of the variant that a push is associated with, if the push was a part of an A/B test (experiment).

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_MESSAGE_RESOLUTION

In-app page swipe

In-app page swipe

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "91baacc8-1ebf-411d-a77a-ee036c44e7ce",
      "group_id": "91baacc8-1ebf-411d-a77a-ee036c44e7ce",
      "session_id": "a135087c-ba97-4b87-ac1d-a216f2cccb7c",
      "triggering_push": {
        "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
        "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      },
      "context": {
        "reporting_context": {
          "content_types": [
            "scene"
          ]
        },
        "state": {
          "pager": {
            "identifier": "302e80f2-1f9d-4e0d-890d-ff54196189d9",
            "page_identifier": "c3c6fe17-1c47-4f52-bff9-f95ed8a14072",
            "page_index": 1,
            "page_count": 3,
            "completed": true
          }
        }
      },
      "pager_identifier": "302e80f2-1f9d-4e0d-890d-ff54196189d9",
      "from_page_identifier": "c3c6fe17-1c47-4f52-bff9-f95ed8a14072",
      "from_page_index": 1,
      "to_page_identifier": "2ecb1788-30b9-4d8f-a267-38f687fc6e8b",
      "to_page_index": 0
    },
  "type": "IN_APP_PAGE_SWIPE"
}

• Occurs when a user swipes to the next or previous page (screen) in a pager (specific to ScenesA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions.).

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app pager was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • context : In-app context

      The context provides the view state when a button, pager, or form interaction occurs.

    • from_page_index : Number

      Is the previous page index.

    • from_pager_identifier : String

      Is the previous page identifier. Format: uuid

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • locale : String

      Optional string that defines the country and language this in-app-automation was localized as by remote-config-api. country - (String) An ISO 3166-1 country code, set by device settings. language - (String) The ISO 639-1 two-letter language code reflecting the language the phone is set to.

    • pager_identifier : String

      Is the pager controller identifier. Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      An ISO 8601 date-time indicating when the payload defining the in-app pager was sent to the device. May be absent.

    • to_page_identifier : String

      Is the current page identifier. Format: uuid

    • to_page_index : Number

      Is the current page index.

    • triggering_push : Associated push

      Present if the user started the current session by opening a push notification.

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_PAGE_SWIPE

In-app page view

In-app page view

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "d2482092-a0f5-4ec0-bf0a-f17a1657d1b0",
      "group_id": "d2482092-a0f5-4ec0-bf0a-f17a1657d1b0",
      "session_id": "65be61ee-dc60-47ec-b9d3-ebc469e0523b",
      "triggering_push": {
        "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
        "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      },
      "context": {
        "reporting_context": {
          "content_types": [
            "scene"
          ]
        },
        "state": {
          "pager": {
            "identifier": "f4d3d085-010b-4c2b-9e4d-574112b892ed",
            "page_identifier": "e55e6d8e-f04d-43f1-939c-822a1dd5a5e3",
            "page_index": 0,
            "page_count": 1,
            "completed": true
          }
        }
      },
      "pager_identifier": "f4d3d085-010b-4c2b-9e4d-574112b892ed",
      "page_identifier": "e55e6d8e-f04d-43f1-939c-822a1dd5a5e3",
      "page_index": 0,
      "page_count": 1,
      "viewed_count": 1,
      "completed": true
    },
  "type": "IN_APP_PAGE_VIEW"
}

• Occurs when a page (screen) is displayed within a pager (specific to ScenesA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions.).

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app pager was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • completed : Boolean

      True if the user reached the end of the pager.

    • context : In-app context

      The context provides the view state when a button, pager, or form interaction occurs.

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • locale : String

      Optional string that defines the country and language this in-app-automation was localized as by remote-config-api. country - (String) An ISO 3166-1 country code, set by device settings. language - (String) The ISO 639-1 two-letter language code reflecting the language the phone is set to.

    • page_count : Number

      Total number of pages.

    • page_identifier : String

      The current page identifier. Format: uuid

    • page_index : Number

      Is the current pager index.

    • pager_identifier : String

      Is the pager controller identifier. Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      An ISO 8601 date-time indicating when the payload defining the in-app message was sent to the device. May be absent.

    • triggering_push : Associated push

      Present if the user started the current session by opening a push notification.

    • viewed_count : Number

      Number of times the current page has been viewed.

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_PAGE_VIEW

In-app pager completed

In-app pager completed

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "a9a5912c-2526-4383-b516-711c58aff900",
      "group_id": "a9a5912c-2526-4383-b516-711c58aff900",
      "session_id": "94e8caed-9b82-4166-b585-a01eed933855",
      "triggering_push": {
        "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
        "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      },
      "context": {
        "reporting_context": {
          "content_types": [
            "survey"
          ]
        },
        "state": {
          "form": {
            "form_identifier": "870db95f-3715-4c98-8047-2871c175d003",
            "submitted": true,
            "type": "nps",
            "response_type": "nps"
          },
          "pager": {
            "identifier": "9e051354-185b-4d4d-888a-885def2e6b7a",
            "page_identifier": "32f4fc47-74ee-41c6-8e16-c9e0aa364101",
            "page_index": 1,
            "page_count": 2,
            "completed": true
          }
        }
      },
      "pager_identifier": "9e051354-185b-4d4d-888a-885def2e6b7a",
      "page_identifier": "32f4fc47-74ee-41c6-8e16-c9e0aa364101",
      "page_index": 1,
      "page_count": 2
    },
  "type": "IN_APP_PAGER_COMPLETED"
}

• Occurs when the last page (screen) of a pager is viewed for the first time (specific to ScenesA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions.).

  OBJECT PROPERTIES

  • body : ObjectREQUIRED

    OBJECT PROPERTIES

    • app_defined_id : String

      An identifier defined by the application if the in-app pager was created by the application logic, not the UA system. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

    • context : In-app context

      The context provides the view state when a button, pager, or form interaction occurs.

    • group_id : String

      Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

      Format: uuid

    • locale : String

      Optional string that defines the country and language this in-app-automation was localized as by remote-config-api. country - (String) An ISO 3166-1 country code, set by device settings. language - (String) The ISO 639-1 two-letter language code reflecting the language the phone is set to.

    • page_count : Number

      Total number of pages.

    • page_identifier : String

      The current page identifier. Format: uuid

    • page_index : Number

      Is the current pager index.

    • pager_identifier : String

      Is the pager controller identifier. Format: uuid

    • push_id : String

      A unique identifier for a push operation. Format: uuid

    • session_id : String

      Represents the “session” of user activity. Absent if the application was initialized while backgrounded. Format: uuid

    • time_sent : String

      An ISO 8601 date-time indicating when the payload defining the in-app message was sent to the device. May be absent.

    • triggering_push : Associated push

      Present if the user started the current session by opening a push notification.

  • device : App device informationREQUIRED

    Information about app users generated by the SDK.

  • id : StringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred : StringREQUIRED

    When the event occurred.

  • offset : String

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed : StringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type : StringREQUIRED

    Possible values: IN_APP_PAGER_COMPLETED

In-app pager summary

In-app pager summary

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "connection_type": "WIFI",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "carrier": "AT&T",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "898c0cde-02d8-4674-8c3a-91183aab8b7b",
      "group_id": "898c0cde-02d8-4674-8c3a-91183aab8b7b",
      "session_id": "393ae595-bb43-48a2-9878-996e11581754",
      "triggering_push": {
        "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
        "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      },                    
      "context": {
        "reporting_context": {
          "content_types": [
            "scene"
          ]
        },
        "state": {
          "pager": {
            "identifier": "7cb3bd21-060c-46d6-9e88-fb0b5376897e",
            "page_identifier": "7888b6dd-0a33-420d-a596-1342dca84fcf",
            "page_index": 0,
            "page_count": 1,
            "completed": false
          }
        }
      },
      "pager_identifier": "7cb3bd21-060c-46d6-9e88-fb0b5376897e",
      "page_count": 1,
      "completed": false,
      "viewed_pages": [
        {
          "page_identifier": "7888b6dd-0a33-420d-a596-1342dca84fcf",
          "page_index": 0,
          "display_time_ms": 33019
        }
      ]
    },
  "type": "IN_APP_PAGER_SUMMARY"
}