Web (JavaScript) record taxonomy

Every field on every Web (JavaScript) record, nested ones included, with the type it carries and whether it is required.

Overview

Records the JavaScript SDK sends once the site snippet is installed.

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.

AnotherUserId

Attribute	Type	Required
`anotherUserId`	String	No

ChangeOn

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.targetTag`	String	No
`data.targetId`	String	No
`data.targetClass`	String	No
`data.targetText`	String	No
`data.hierarchy`	String	No
`userId`	String	No

ClickOn

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.href`	String	No
`data.targetTag`	String	No
`data.targetId`	String	No
`data.targetClass`	String	No
`data.targetText`	String	No
`data.hierarchy`	String	No
`userId`	String	No

clicks

Attribute	Type	Required
`visitorId`	String	Yes
`eventId`	String	Yes
`timestamp`	Long	Yes
`local_time_full`	String	Yes
`tech`	`Tech`	No
`element`	`HtmlElement`	Yes
`page`	`Page`	Yes
`ip_address`	String	No
`location`	`Location`	No
`referrer`	`Referrer`	No
`url`	`Url`	No

ClicksId

Attribute	Type	Required
`eventId`	String	Yes

EventId

Attribute	Type	Required
`eventId`	String	Yes

Form

Attribute	Type	Required
`action`	String	Yes
`fields`	Map of String	Yes
`method`	String	Yes

HtmlElement

Attribute	Type	Required
`class`	String	No
`href`	String	No
`id`	String	No
`name`	String	No
`node_name`	String	No
`selector`	String	No
`text`	String	No
`title`	String	No
`type`	String	No
`x_position`	Integer	No
`y_position`	Integer	No

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

Location

Attribute	Type	Required
`postal`	String	No
`city`	String	No
`subdivision`	String	No
`country`	String	No
`continent`	String	No
`coordinates.accuracyRadius`	Integer	No
`coordinates.latitude`	Decimal	No
`coordinates.longitude`	Decimal	No

Page

Attribute	Type	Required
`title`	String	Yes
`description`	String	Yes
`scroll_state`	`ScrollState`	Yes
`time_on_page`	Integer	Yes
`time_on_page_ms`	Decimal	Yes

PageId

Attribute	Type	Required
`pageId`	String	No

PageLeave

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`timestamp`	Long	Yes
`data.url`	String	No
`data.domain`	String	No
`data.query`	String	No
`data.path`	String	No
`data.windowWidth`	Decimal	No
`data.hash`	String	No
`data.title`	String	No
`data.previousPage`	String	No
`data.timeOnPage`	Decimal	No
`userId`	String	No

PageView

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`timestamp`	Long	Yes
`data.url`	String	No
`data.domain`	String	No
`data.query`	String	No
`data.path`	String	No
`data.windowWidth`	Decimal	No
`data.hash`	String	No
`data.title`	String	No
`data.previousPage`	String	No
`userId`	String	No

pageviews

Attribute	Type	Required
`visitorId`	String	Yes
`eventId`	String	Yes
`timestamp`	Long	Yes
`local_time_full`	String	Yes
`tech`	`Tech`	No
`page`	`Page`	Yes
`ip_address`	String	No
`location`	`Location`	No
`referrer`	`Referrer`	No
`url`	`Url`	No

PageViewsId

Attribute	Type	Required
`eventId`	String	Yes

ProfileId

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

Referrer

Attribute	Type	Required
`initial`	String	No
`full`	String	Yes

Screen

Attribute	Type	Required
`height`	Integer	No
`width`	Integer	No
`colorDepth`	Integer	No
`pixelDepth`	Integer	No
`availHeight`	Integer	No
`availWidth`	Integer	No
`orientation`	`ScreenOrientation`	No

ScreenOrientation

Attribute	Type	Required
`angle`	Integer	No
`type`	String	No

ScrollState

Attribute	Type	Required
`pixel`	Integer	Yes
`pixel_max`	Integer	Yes
`ratio`	Float	No
`ratio_max`	Float	No

Session

Attribute	Type	Required
`visitorId`	String	Yes
`eventId`	String	Yes
`session_start`	Long	Yes
`session_end`	Long	Yes
`duration`	Decimal	Yes
`first_session`	Boolean	Yes

SessionEnd

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`timestamp`	Long	Yes
`userAttributes.browser`	String	No
`userAttributes.deviceType`	String	No
`userAttributes.platform`	String	No
`userAttributes.ipAddress`	String	No
`userAttributes.country`	String	No
`userAttributes.region`	String	No
`userAttributes.city`	String	No
`userAttributes.landingPage`	String	No
`userAttributes.referrer`	String	No
`userAttributes.fullReferrer`	String	No
`userAttributes.utmSource`	String	No
`userAttributes.utmMedium`	String	No
`userAttributes.utmTerm`	String	No
`userAttributes.utmContent`	String	No
`userAttributes.utmCampaign`	String	No
`data.source`	String	No
`data.landingPageQuery`	String	No
`data.landingPageHash`	String	No
`data.sessionStartEventName`	String	No
`data.sessionEndEventName`	String	No
`data.sessionEventCount`	Decimal	No
`data.sessionDuration`	Decimal	No
`userId`	String	No

SessionId

Attribute	Type	Required
`sessionId`	String	No

SessionStart

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`timestamp`	Long	Yes
`userAttributes.browser`	String	No
`userAttributes.deviceType`	String	No
`userAttributes.platform`	String	No
`userAttributes.ipAddress`	String	No
`userAttributes.country`	String	No
`userAttributes.region`	String	No
`userAttributes.city`	String	No
`userAttributes.landingPage`	String	No
`userAttributes.referrer`	String	No
`userAttributes.fullReferrer`	String	No
`userAttributes.utmSource`	String	No
`userAttributes.utmMedium`	String	No
`userAttributes.utmTerm`	String	No
`userAttributes.utmContent`	String	No
`userAttributes.utmCampaign`	String	No
`sessionAttributes.source`	String	No
`sessionAttributes.landingPageQuery`	String	No
`sessionAttributes.landingPageHash`	String	No
`sessionAttributes.sessionStartEventName`	String	No
`userId`	String	No

SubmitOn

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.href`	String	No
`data.targetTag`	String	No
`data.targetId`	String	No
`data.targetClass`	String	No
`data.formDataText.key`	String	No
`data.formDataText.value`	String	No
`data.hierarchy`	String	No
`userId`	String	No

Tech

Attribute	Type	Required
`profile`	`TechProfile`	Yes

TechProfile

Attribute	Type	Required
`cookies`	Boolean	No
`codeName`	String	No
`description`	String	No
`language`	String	No
`name`	String	No
`online`	Boolean	No
`platform`	String	No
`useragent`	String	No
`version`	String	No
`screen`	`Screen`	No
`window`	`Window`	No

Url

Attribute	Type	Required
`full`	String	Yes

UrlDetails

Attribute	Type	Required
`scheme`	String	No
`userInfo`	String	No
`host`	String	No
`port`	Integer	No
`path`	String	No
`query`	String	No
`fragment`	String	No

UserId

Attribute	Type	Required
`userId`	String	No

VisitorId

Attribute	Type	Required
`visitorId`	String	Yes

Window

Attribute	Type	Required
`height`	Integer	No
`width`	Integer	No
`scrollHeight`	Integer	No
`ratio`	`WindowRatio`	No

WindowRatio

Attribute	Type	Required
`height`	Float	No
`width`	Float	No

addedToCart

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`userId`	String	No
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.productId`	String	No
`data.quantity`	Decimal	No

productOrdered

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`userId`	String	No
`sessionId`	String	No
`pageId`	String	No
`anotherUserId`	String	No
`timestamp`	Long	Yes
`data.productId`	String	No
`data.quantity`	Decimal	No

productViewed

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`userId`	String	No
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.productId`	String	No

removedFromCart

Attribute	Type	Required
`eventId`	String	Yes
`profileId`	String	Yes
`userId`	String	No
`sessionId`	String	No
`pageId`	String	No
`timestamp`	Long	Yes
`data.productId`	String	No
`data.quantity`	Decimal	No

On this page