Object type mapping for Web Analytics Object
| Field | Type | Description |
|---|---|---|
|
Event Attributes |
||
|
EventId |
String |
Unique identifier for a web analytics event. |
|
EventType |
String |
Type of the web analytics event, like - Page View, form submission, button click, s Pull up mainline\u0000 earch bar interaction, app error prompts, cart interactions, purchases, scrolls, etc. |
|
EventTimestamp |
Number |
Epoch millisecond timestamp of the event. |
|
EventDuration |
Number |
EventDuration represents the amount of time a user spent during a particular interaction, measured in seconds. Common use cases include: Time spent viewing a product, Length of a browsing session on a particular page, Time spent on a feature, etc. |
|
EventValue |
Number |
EventValue is a numerical attribute that represents the value or importance of an interaction event. Common use cases include: Purchase amount for transaction events, Rating values for product ratings, Percentage completion for video views, etc. |
|
Session Attributes |
||
|
Session.Id |
String |
Unique identifier for the session. |
|
Session.StartTimestamp |
Number |
Epoch millisecond indicating the start timestamp of the session. |
|
Page/Screen Attributes |
||
|
Page.Title |
String |
Title of a Web App/Screen Name for a mobile app. |
|
Page.Location |
String |
URL of a Web page. For mobile, it could be deep link or route to the screen. |
|
Page.Referrer |
String |
Previous screen/page. |
|
Page.Category |
String |
Logical grouping of a screen/page. Might be useful to group nested URLs/app locations. |
|
HTML/DOM Elements |
||
|
Element.Id |
String |
HTML Element Id |
|
Element.Type |
String |
Element Type - Button, Anchor Links, Etc. |
|
Element.Classes |
String |
CSS Styling Classes of the Element |
|
Element.Text |
String |
Element text (Useful for buttons, input fields placeholders, etc). |
|
Element.AltText |
String |
AltText of a HTML element (generally used for images). |
|
Element.Source |
String |
Source of an video, image, etc. |
|
Form |
||
|
Form.Id |
String |
Unique Identifier for an input form |
|
Form.Name |
String |
Name of the Form |
|
Form.Length |
String |
Number of input fields in a form. |
|
Form.ValidationErrors |
Number |
Number of validation errors in the form. |
|
Form.FieldsCompleted |
Number |
Number of fields completed. |
|
Form.FieldsRequired |
Number |
Number of fields required. |
|
Search |
||
|
Search.Query |
String |
Query string used in the input |
|
Search.TotalMatchingResults |
Number |
Total number of search results. |
|
Search.ResultsPerPage |
Number |
Number of results shown per page. |
|
Search.CurrentResultsPage |
Number |
Current results page that the user is viewing. |
|
Search.FilterExpression |
String |
Any additional filter expressions used. |
|
Search.SortCriteria |
String |
Criteria for sorting the search result. For example - Relevance, Price, etc. |
|
Search.SortOrder |
String |
Sort order for Search results - Ascending/Descending. |
|
Item/Item List |
||
|
Item |
Item |
Focused item in an event, indicating, the item added to a cart, item viewed, etc. |
|
ItemsList |
List<Item> |
Focused list of items in an event, indicating, items purchased, items in a cart, item search results, etc. |
|
Item Impressions |
||
|
AdditionalItemImpressions |
List<Item> |
Additional Item impressions list |
|
Cart |
||
|
Cart.Id |
String |
Unique identifier for a cart. |
|
Cart.ItemsCount |
Number |
Number of items in the cart. |
|
Cart.Currency |
String |
Currency for cart value. |
|
Cart.Value |
Number |
Monetary value of items in the cart. |
|
Order Information |
||
|
OrderId |
String |
Unique identifier for a order. We will only store the order identifier here, other information related to the order will be stored in the standard order object. |
|
Device |
||
|
DeviceId |
String |
Unique identifier of the user's device. |
|
Scroll Attributes |
||
|
Scroll.DepthPercentage |
String |
Vertical Scroll depth percentage. This helps understand how far a users scroll through a web page. |
|
Scroll.PositionX |
Number |
Horizontal Scroll position in pixels from the left. |
|
Scroll.PositionY |
Number |
Vertical Scroll position in pixels from the top. |
|
Error |
||
|
Error.Description |
String |
A short description of the error. |
|
Error.Type |
String |
User Input Error/Server Error. |
|
User |
||
|
User.Id |
String |
Unique identifier of the user |
|
User.AnonymousId |
String |
Anonymous UserId. This would be a uniqueId assigned to a user when they are not logged in. |
|
User.IsReturning |
String |
A Boolean value indicating if a user is revisiting. |
|
User.IsLoggedIn |
String |
A Boolean value indicating if a user is logged in. |
|
Activity Location |
||
|
Location.Country |
String |
User activity country. |
|
Location.State |
String |
User activity state. |
|
Location.Province |
String |
User activity province. |
|
Location.County |
String |
User activity county. |
|
Location.City |
String |
User activity city. |
|
Location.Latitude |
String |
User activity location coordinates |
|
Location.Longitude |
String |
User activity location coordinates |
|
Application Attributes |
||
|
Application.Name |
String |
The name of the application. |
|
Application.Version |
String |
If the device is Mobile, we can capture the Application Version here. User could also consider using this for population A/B testing or experimentation attributes. |
|
Application.Environment |
String |
Application environments, like - Beta, Gamma, Prod. |
|
Custom Attributes |
||
|
Attributes |
Map<String, String> |
Any custom attributes or metadata to add to the event. |
| Field | Type | Description |
|---|---|---|
|
Id |
String |
Unique Identifier for the item. |
|
Title |
String |
Title of the Item. |
|
Category |
String |
Category of the item. |
|
Value |
String |
Monetary value of the item. |
|
Currency |
String |
Currency of the item. |
|
Quantity |
Number |
Quantity of the item. |
|
ImpressionType |
String |
String identifying the impression type for an event. For example - Featured, Sponsored, Top picks, etc. |
|
ImpressionId |
String |
A string identifier for uniquely identifying an impression. |
| Field | Type | Description |
|---|---|---|
|
DeviceId |
String |
A unique identifier for the device. |
|
Type |
String |
Type of device (e.g., desktop, mobile) |
|
Model |
String |
Device model, like - Macbook Pro/Air, IPhone 16, etc. |
|
Manufacturer |
String |
Manufacturer of the device. |
|
OperatingSystem |
String |
Indicates Windows, MacOs, IOS, Android. |
|
OperatingSystemVersion |
String |
OS Version |
|
ScreenWidth |
Number |
Width of the Screen ViewPort |
|
ScreenHeight |
Number |
Height of the Screen ViewPort |
|
Browser |
String |
Name of the Browser the user is interacting with. |
|
BrowserVersion |
String |
Version of the Browser |
|
Locale |
String |
Device or App locale. |
|
Attributes |
Map<String, String> |
Any Custom Attributes for a Device. |