iOS record taxonomy

Every field on every iOS record, nested ones included, with the type it carries and whether it is required.

Overview

Records the iOS SDK sends.

One section per record, one row per field. A record nested inside another is flattened into a dotted path, so data.targetText is the targetText field carried on that record's data. These schemas hold names and types only, so there are no example values here. A type in backticks names another record in this same source, which has its own section on this page.

Action

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.actionMethod`	String	No
`data.targetText`	String	No
`data.targetViewClass`	String	No
`data.targetViewName`	String	No
`data.targetAccessibilityIdentifier`	String	No
`data.targetAccessibilityLabel`	String	No
`data.hierarchy`	String	No
`data.isUpgrade`	Boolean	No
`data.appVisibilityState`	String	No
`data.previousVersionCode`	Decimal	No
`data.previousBuildType`	String	No
`data.currentVersionCode`	Decimal	No
`data.currentBuildType`	String	No
`userId`	String	No

AnotherUserId

Attribute	Type	Required
`anotherUserId`	String	No

App

Attribute	Type	Required
`name`	String	Yes
`version`	String	Yes

AppInstallUpgrade

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.actionMethod`	String	No
`data.targetText`	String	No
`data.targetViewClass`	String	No
`data.targetViewName`	String	No
`data.targetAccessibilityIdentifier`	String	No
`data.targetAccessibilityLabel`	String	No
`data.hierarchy`	String	No
`data.isUpgrade`	Boolean	No
`data.appVisibilityState`	String	No
`data.previousVersionCode`	Decimal	No
`data.previousBuildType`	String	No
`data.currentVersionCode`	Decimal	No
`data.currentBuildType`	String	No
`userId`	String	No

Device

Attribute	Type	Required
`name`	String	Yes
`type`	String	Yes
`brand`	String	Yes
`osVersion`	String	Yes

EditField

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.actionMethod`	String	No
`data.targetText`	String	No
`data.targetViewClass`	String	No
`data.targetViewName`	String	No
`data.targetAccessibilityIdentifier`	String	No
`data.targetAccessibilityLabel`	String	No
`data.hierarchy`	String	No
`data.isUpgrade`	Boolean	No
`data.appVisibilityState`	String	No
`data.previousVersionCode`	Decimal	No
`data.previousBuildType`	String	No
`data.currentVersionCode`	Decimal	No
`data.currentBuildType`	String	No
`userId`	String	No

EventId

Attribute	Type	Required
`eventId`	String	Yes

Geo

Attribute	Type	Required
`city`	String	Yes
`country`	String	Yes
`region`	String	Yes

Identify

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`userId`	String	No
`anotherUserId`	String	No
`accountId`	String	No
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes

Interaction

Attribute	Type	Required
`profileId`	String	Yes
`parentId`	String	Yes
`eventId`	String	Yes
`timestamp`	Long	Yes
`type`	String	Yes
`element`	`UiElement`	Yes
`userId`	String	No

InteractionId

Attribute	Type	Required
`eventId`	String	Yes

Launch

Attribute	Type	Required
`profileId`	String	Yes
`eventId`	String	Yes
`timestamp`	Long	Yes
`wifi`	Boolean	Yes
`device`	`Device`	Yes
`screen`	`Screen`	Yes
`geo`	`Geo`	Yes
`app`	`App`	Yes
`userId`	String	No

LaunchId

Attribute	Type	Required
`eventId`	String	Yes

LeaveScreen

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`timestamp`	Long	Yes
`data.viewController`	String	No
`data.viewControllerAccessibilityIdentifier`	String	No
`data.viewControllerAccessibilityLabel`	String	No
`data.timeOnScreen`	Decimal	No
`userId`	String	No

PageId

Attribute	Type	Required
`pageId`	String	No

ParentId

Attribute	Type	Required
`parentId`	String	Yes

ProfileId

Attribute	Type	Required
`profileId`	String	Yes
`userId`	String	No

Scene

Attribute	Type	Required
`profileId`	String	Yes
`parentId`	String	Yes
`eventId`	String	Yes
`timestamp`	Long	Yes
`element`	`SceneElement`	Yes
`userId`	String	No

SceneElement

Attribute	Type	Required
`alpha`	String	Yes
`class`	String	Yes
`path`	String	Yes
`tag`	String	Yes
`viewController`	String	Yes

SceneId

Attribute	Type	Required
`eventId`	String	Yes

Screen

Attribute	Type	Required
`height`	Integer	Yes
`width`	Integer	Yes

SessionEnd

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`timestamp`	Long	Yes
`userAttributes.deviceType`	String	No
`userAttributes.platform`	String	No
`userAttributes.country`	String	No
`userAttributes.region`	String	No
`userAttributes.city`	String	No
`data.source`	String	No
`data.device`	String	No
`data.iosVendorId`	String	No
`data.iosAdvertiserId`	String	No
`data.appName`	String	No
`data.appIdentifier`	String	No
`data.appVersion`	String	No
`data.sessionStartEventName`	String	No
`data.sessionEndEventName`	String	No
`data.sessionDuration`	Decimal	No
`data.sessionEventCount`	Decimal	No
`userId`	String	No

SessionId

Attribute	Type	Required
`sessionId`	String	No

SessionStart

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`timestamp`	Long	Yes
`sessionId`	String	No
`userAttributes.deviceType`	String	No
`userAttributes.platform`	String	No
`userAttributes.country`	String	No
`userAttributes.region`	String	No
`userAttributes.city`	String	No
`sessionAttributes.source`	String	No
`sessionAttributes.device`	String	No
`sessionAttributes.iosVendorId`	String	No
`sessionAttributes.iosAdvertiserId`	String	No
`sessionAttributes.appName`	String	No
`sessionAttributes.appIdentifier`	String	No
`sessionAttributes.appVersion`	String	No
`sessionAttributes.sessionStartEventName`	String	No
`userId`	String	No

Touch

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.actionMethod`	String	No
`data.targetText`	String	No
`data.targetViewClass`	String	No
`data.targetViewName`	String	No
`data.targetAccessibilityIdentifier`	String	No
`data.targetAccessibilityLabel`	String	No
`data.hierarchy`	String	No
`data.isUpgrade`	Boolean	No
`data.appVisibilityState`	String	No
`data.previousVersionCode`	Decimal	No
`data.previousBuildType`	String	No
`data.currentVersionCode`	Decimal	No
`data.currentBuildType`	String	No
`userId`	String	No

UiElement

Attribute	Type	Required
`alpha`	String	Yes
`class`	String	Yes
`path`	String	Yes
`tag`	String	Yes
`viewController`	String	Yes
`ActionName`	String	Yes
`text`	String	Yes

UserId

Attribute	Type	Required
`identifier`	String	No

ViewScreen

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`timestamp`	Long	Yes
`data.viewController`	String	No
`data.viewControllerAccessibilityIdentifier`	String	No
`data.viewControllerAccessibilityLabel`	String	No
`userId`	String	No

On this page