Skip to content

Latest commit

 

History

History
146 lines (121 loc) · 8.71 KB

lifecycle-metrics.md

File metadata and controls

146 lines (121 loc) · 8.71 KB

Lifecycle metrics

Lifecycle data content response metrics

The following metrics are collected on each Lifecycle data content response event.

Install

Metric Key DescriptIon
First Launches a.InstallEvent Triggered at the first run after installation or re-installation.
Install Date a.InstallDate Date of first launch after installation. The format is M/d/yyyy, and an example is 5/3/2017.

Upgrade

Metric Key Description
Upgrades a.UpgradeEvent Triggered at the first run after upgrade or when the version number changes.
Days since last upgrade a.DaysSinceLastUpgrade Number of days since the application version number changed. Important: This metric is not automatically stored in an Analytics metric. You must create a processing rule that sets a custom event to capture this metric.
Launches since last upgrade a.LaunchesSinceUpgrade Number of launches since the application version number changed. Important: This metric is not automatically stored in an Analytics metric. You must create a processing rule that sets a custom event to capture this metric.

Launch

Metric Key Description
Daily Engaged Users a.DailyEngUserEvent Triggered when the application is used on a particular day. Important: This metric is not automatically stored in an Analytics metric. You must create a processing rule that sets a custom event to capture this metric.
Monthly Engaged Users a.MonthlyEngUserEvent Triggered when the application is used during a particular month. Important: This metric is not automatically stored in an Analytics metric. You must create a processing rule that sets a custom event to capture this metric.
Launches a.LaunchEvent Triggered on every run, including crashes and installs. Also triggered when the app is resumed from the background after the lifecycle session timeout is exceeded.
Previous Session Length a.PrevSessionLength Reports the number of seconds that a previous application session lasted based on how long the application was open and in the foreground.
Ignored Session Length a.ignoredSessionLength If the last session is set to last longer than lifecycle.sessionTimeout, that session length is ignored and recorded here.
Launch Number a.Launches Number of times the application was launched or brought out of the background.
Days since first use a.DaysSinceFirstUse Number of days since first run.
Days since last use a.DaysSinceLastUse Number of days since last use.
Hour of Day a.HourOfDay Measures the hour the app was launched and uses the 24-hour numerical format. Used for time parting to determine peak usage times.
Day of Week a.DayOfWeek Measures the day of the week the app was launched.

Crash

Metric Key Description
Crashes a.CrashEvent Triggered when the application crashed before closing. The event is sent when the application is started again after the crash.

Device Information

Metric Key Description
App ID a.AppID Stores the application name and version in the following format: AppName BundleVersion (app version code) . An example of this format is MyAppName 1.1(1).
Device Name a.DeviceName Stores the device name.
Operating System Version a.OSVersion Operating system name and version.
Carrier Name a.CarrierName

Stores the name of the mobile service provider as provided by the device.

Important: This metric is not automatically stored in an Analytics variable. You must create a processing rule to copy this value to an Analytics variable for reporting.
Resolution a.Resolution Width x Height in pixels.
Locale a.locale Locale set for this device, for example, en-US.

Lifecycle Application Foreground metrics

The following metrics are collected on each Lifecycle Application Foreground event. The structure of these metrics is defined in the Experience Data Model (XDM) field group AEP Mobile Lifecycle Details.

Application

Property Type DescriptIon
xdm:id String Identifier of the application.
xdm:name String Name of the application.
xdm:version String Version of the application.
xdm:isLaunch boolean Launch of an application. Every application foreground event sets isLaunch to true.
xdm:isInstall boolean Install of an application. If true, signifies the first launch of the application. The Experience Event's timestamp property can be used as the application's install date.
xdm:isUpgrade boolean Upgrade of an application. If true, signifies the first launch of the application after an upgrade.

Device

Property Type DescriptIon
xdm:type String Type of device being tracked.
xdm:manufacturer String The name of the organization who owns the design and creation of the device.
xdm:model String The name of the model for the device.
xdm:modelNumber String The unique model number designation assigned by the manufacturer for this device.
xdm:screenHeight integer The number of vertical pixels of the device's active display in the default orientation.
xdm:screenWidth integer The number of horizontal pixels of the device's active display in the default orientation.

Environment

Property Type DescriptIon
xdm:type String The type of the application environment.
xdm:carrier String A mobile network carrier or MNO, also known as a wireless service provider, wireless carrier, cellular company, or mobile network carrier.
xdm:operatingSystem String The name of the operating system used when the observation was made.
xdm:operatingSystemVersion String The full version identifier for the operating system used when the observation was made.
dc:language String The language of the environment to represent the user's linguistic, geographical, or cultural preferences for data presentation.

Lifecycle Application Background metrics

The following metrics are collected on each Lifecycle Application Background event. The structure of these metrics is defined in the Experience Data Model (XDM) field group AEP Mobile Lifecycle Details.

Application

Property Type DescriptIon
xdm:isClose boolean Close of an application. Every application background event sets isClose to true.
xdm:closeType String Type of application close, sent on application isClose. Type is "close" on graceful termination of an application, or "unknown" when application termination source is unknown.
xdm:sessionLength integer Length of the application session in seconds. Usually referred as the time the application was in foreground. Will not be less than zero.