Mobile Event Stream Data Sets

The following data sets are available through Mobile Event Stream. To set up your S3 bucket policy, see the Event Stream S3 Bucket Policy documentation.

Mobile event data can be asynchronous. All events are timestamped with the time they occurred, but they may not be available in Sailthru until a later time. This may happen when a user performs a task in your app but then loses connectivity. The event will be logged to Sailthru and included in your stream when the user regains connectivity.

Asynchronous data will include events which happened within the past 48 hours of the stream transferring the data. Any event older than 48 hours will not be included.

Notifications

 

Target Location s3://[bucket_name]/mobile_notifications/dt=[dt]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
client_id int 1234 The Sailthru client ID
app_id string 5872e7b0ecf4a500076b6b79 The app identifier 
event_time string 2020-05-10 23:59:59 Message send time represented in the following format: YYYY-MM-DD HR:MI:SS
type string notification, transactional_notification The type of notification sent.

Possible values:

notification: non-transactional pushes.

Transactional_notification: notification sent from the transactional endpoint.  

status string success, rejected, uninstalled Refer to the delivery status of the notification.

Possible values:

success: the push token was valid at the time of sending. The gateway will deliver the push notification.

rejected: the token has changed or is not valid. The gateway will not deliver the push notification.

uninstalled: the device is reported by the push gateway as unregistered. The gateway will not deliver the push notification.

platform string ios, android The OS used on the device. 

Possible values:

ios: the platform is iOS

android: the platform is Android

profile_id string 5ba9c50e2aa5e60008d116b6 Unique identifier for the Sailthru user profile of the message recipient
device_id string 587583c8fc9ffe000887bac8 A Sailthru Mobile device ID
user_id string fc58b4ea-2dbb-4bd3-b28a-5a4024506141 User identifier sent to Sailthru using the SDK
flow_id string b42cf303-2283-407e-9f06-238a83831bd0 LO lifecycle ID the notification belongs to
step_id string cac6ba22-f28f-45b6-b9b0-14bd00cff293 LO step ID the notification belongs to
group string lo-d3339728b58a12249af923264ca33bee ID of the group used for a transactional notification
message_id string 5dba5fa35fcb13000127370f Message ID of the message the notification belongs to
notification_id string 5eb89580d6b3ad0001abfa03 The ID of the notification as reported from the Notifications API response 
transactional_notification_id string 5eb89580d6b3ad0001abfa03 The Sailthru-assigned transactional ID 
token string APA91bFek1XaKUPNX0ELwEXQ0UAMUERzCvopNqGEY8NhL3y6ztgZ5O3RMzr9bJuZ0-lNS5WdCPtQMPfJuRHaA1OE314nseKupg9EOXFdYF7aYIS56QlIuRJPmIfoSgzsuDemr4qr3ko1 The push token issued by APNS or FCM
title string 🚚 Part of your order has shipped The title of the notification
alert string Your Everyone Meyer Lemon & Mandarin Hand Soap – 12.75… and 1 other item are on their way The body text of the notification 
custom_deeplink string https://www.example.com/mobile/deeplink/trips/ Custom URL added to notification
custom_badge int 1 Current badge count
custom_sound string alert_breakingnews.wav Current sound added to notification

 

Device Events

 

Target Location s3://[bucket_name]/mobile_device_events/dt=[dt]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
client_id int 1234 The Sailthru client ID
app_id string 57d872e83736330009022aaa The app identifier 
type string install, uninstall, linked_with_sailthru, push_status Event type.


Possible values:
install: user opened the app for the first time.

uninstall: the push gateway reported the app is no longer registered.

linked_with_sailtthru: triggered when the device is associated with a particular Sailthru user profile.

push_status: triggered when the push configuration for the device has changed.

event_time string 2020-05-10 23:59:58 The time the event was logged represented in the following format: YYYY-MM-DD HR:MI:SS
profile_id string 5ba9c50e2aa5e60008d116b6 Unique identifier for the Sailthru user profile of the message recipient
device_id string 5eb290205d46350008affd0f A Sailthru Mobile device ID
user_id string 20028345824 User identifier sent to Sailthru using the SDK
platform string ios, android The OS used on the device. 

Possible values:

ios: the platform is iOS

android: the platform is Android

token string bfab6aabab727976ab2985e697609dd846c7d35568fb3422d0d658532f472cb0 The push token issued by APNS or FCM
installed_at string 2019-11-29 22:41:28 The date and time of install represented in the following format: YYYY-MM-DD HR:MI:SS
deactivated_token string a2ab9183c408e03bdaed35e984f029db76f63143873b310842552fcf01d45fb0 The deactivated push token
reason string duplicate_token, gateway_feedback Refers to the reason why the app is no longer registered. This is only set when type is uninstall.

Possible values:

duplicate_token: a duplicate token was found.

gateway_feedback: systems have attempted to send a push and either FCM or APNS return “invalid token”.

notification_status string unknown, enabled,  disabled, quiet Current notification status. Only present for push_status event type.

Possible values (iOS): unknown: push notification authorisation has not been requested.

enabled: banners, sounds, badges and/or lock screen enabled.

disabled: notifications off or all settings turned off

quiet: Notification Center only enabled. 

Possible values (Android):

unknown: N/A

enabled: at least one notification channel enabled with interrupting importance.

disabled: notifications off/no channels enabled

quiet: all channels set to non-interrupting importance.

For more information visit https://docs.mobile.sailthru.com/docs/push-enabled-state.

previous_notification_status string unknown, enabled, disabled, quiet Previous notification status (if this has changed). Only present for push_status event type.

For possible values, refer to notification_status.

For more information visit https://docs.mobile.sailthru.com/docs/push-enabled-state.

latitude double 53.7573 The latitudinal location of the device
longitude double -2.7236 The longitudinal location of the device
city string Preston The city in which the device is located
country string United Kingdom The country in which the device is located

 

Sessions

 

Target Location s3://[bucket_name]/mobile_sessions/dt=[dt]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
client_id int 1234 The Sailthru client ID
app_id string 57d872e83736330009022aaa The app identifier 
event_time string 2020-05-10 23:59:58 Message send time represented in the following format YYYY-MM-DD HR:MI:SS
profile_id string 5ba9c50e2aa5e60008d116b6 Unique identifier for the Sailthru user profile of the message recipient
device_id string 5d93ee5ac8b91a000ad85121 A Sailthru Mobile device ID
user_id string 56570857 User identifier sent to Sailthru using the SDK
session_duration int 187 Session duration in seconds.

Only present for session_close events.

type string app_open, session_close App lifecycle event type. 

Possible values: app_open: the app started.

session_close: the app was put in the background or the user switched app.

platform string ios, android The OS used on the device. 

Possible values:

ios: the platform is iOS

android: the platform is Android

notification_id string 5eb1afb7ea35890001f44da3 Notification identification, only present for app_open events. Not present when the open was not directly or indirectly influenced. It could also be a Transactional Push Group identifier provided when using the Transactional Push API.
notification_attribution string direct, indirect The type of interaction the user has had with the push notification. Only present for app_open events. Not present when the open was not directly or indirectly influenced.

Possible values:

direct: the app was started by tapping on the notification (notification_id).

indirect: the app was started within the open attribution window (12 hours) after the device received the notification.

More information can be found here.

notification_action string notification_tapped, Breaking News\u0026notification_tapped Only set when a push notification action has been performed (push with custom buttons). 

These values are customisable by the customer.

latitude double 53.7573 The latitudinal location of the device
longitude double -2.7236 The longitudinal location of the device
city string Preston The city in which the device is located
country string United Kingdom The country in which the device is located

 

Custom Events

 

Target Location s3://[bucket_name]/mobile_custom_events/dt=[dt]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
client_id int 1234 The Sailthru client ID
app_id string 5c2e4b00bc86fd00019ee332 The app identifier 
event_time string 2020-05-11 00:02:03 Message send time represented in the following format YYYY-MM-DD HR:MI:SS
name string app_open_launch_relaunch, viewed_coupon Event name provided via Mobile SDK or API.

These values are customisable by the customer.

profile_id string 5ba9c50e2aa5e60008d116b6 Unique identifier for the Sailthru user profile of the message recipient
device_id string 5eb4cd3893cb7700082518ee A Sailthru Mobile device ID
user_id string 2a6f681efaa44ffe8085bbcfa349bf6a User identifier sent to Sailthru using the SDK
platform string ios, android The OS used on the device. 

Possible values:

ios: the platform is iOS

android: the platform is Android

notification_id string 5eb5b94baec25e000155a624 Notification identifier as reported from the Notifications API response. It could also be a Transactional Push Group identifier provided when using the Transactional Push API in the following format group:mygroup.Not present when the custom event was not directly or indirectly influenced by a notification.
notification_attribution string direct, indirect The type of interaction the user has had with the push notification. Only present for app_open events. Not present when the open was not directly or indirectly influence by a notification.

Possible values:

direct: the app was started by tapping on the notification (notification_id).

indirect: the app was started within the open attribution window (12 hours) after the device received the notification.

More information can be found here.

message_id string 5eb5b94aaec25e000155a623 The Sailthru-assigned ID for the message.

Not present when the custom event was not directly or indirectly influenced by a notification. Also not present for events influenced by notifications sent using the Transactional Push API.

source string STMAutoAnalyticsSourceGoogleAnalytics, STMAutoAnalyticsSourceAdobe, STMAutoAnalyticsSourceMixpanel, STMAutoAnalyticsSourceLocalytics, STMAutoAnalyticsSourceFlurry, STMAutoAnalyticsSourceAmplitude Source sent via Mobile SDK when using Auto Analytics Tracking. Events collected by the SDK do not have a source.

Possible values:

STMAutoAnalyticsSourceGoogleAnalytics: events collected by Google Analytics

STMAutoAnalyticsSourceAdobe: events collected by Adobe Analytics

STMAutoAnalyticsSourceMixpanel: events collected by Mixpanel

STMAutoAnalyticsSourceLocalytics: events collected by Localytics

STMAutoAnalyticsSourceFlurry: events collected by Flurry Analytics

STMAutoAnalyticsSourceAmplitude: events collected by Amplitude

vars string {“Search results”:5,”Source”:”Mobile App”,”Search query”:”taupe top”} Sailthru variables
latitude double 53.7573 The latitudinal location of the device
longitude double -2.7236 The longitudinal location of the device
city string Preston The city in which the device is located
country string United Kingdom The country in which the device is located

 

Impressions

 

Target Location s3://[bucket_name]/mobile_impressions/dt=[dt]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
client_id int 1234 The Sailthru client ID
app_id string 57ffe493653734000900b1ed The app identifier 
event_time string 2020-05-11 00:00:11 Message send time represented in the following format YYYY-MM-DD HR:MI:SS
type string inapp_view, stream_view, detail_view Where the impression event occurred. 

Possible values:

inapp_view: in-app message impression (for example, in-app notification).

stream_view: an impression from the message stream.

detail_view: the user displayed an expanded view of the message.

profile_id string 5ba9c50e2aa5e60008d116b6 Unique identifier for the Sailthru user profile of the message recipient
device_id string 5e5e769e1de3ea000a526cc0 A Sailthru Mobile device ID
user_id string 0B7F666A-3E63-4AFD-96F8-64333FD0A330 User identifier sent to Sailthru using the SDK
platform string ios, android The OS used on the device. 

Possible values:

ios: the platform is iOS

android: the platform is Android

notification_id string 5eb58b8df4bd650001fe777d The ID of the notification as reported from the Notifications API response
notification_attribution string direct, indirect The type of interaction the user has had with the push notification. Only present for app_open events. Not present when the open was not directly or indirectly influenced.

Possible values:

direct: the app was started by tapping on the notification.

indirect: the app was started within the open attribution window (12 hours) after the device received the notification.

More information can be found here.

message_id string 5eb028b8d3ec220001aa79b6 The Sailthru-assigned ID for the message
latitude double 53.7573 The latitudinal location of the device
longitude double -2.7236 The longitudinal location of the device
city string Preston The city in which the device is located
country string United Kingdom The country in which the device is located

 

Top