Product View (Opti-X)
Event Key
ootb_product_view
This event should be sent when a user views a product (or variant/SKU) page on your ecommerce site.
Event Key | Event Name | Type |
---|---|---|
ootb_product_view | Product View | Simple event |
Event Structure
The mandatory properties (tenant
, timestamp
, event
, and customer
) are required for all events and documented in detail on the Mandatory Properties page. Below is the JSON structure for the context-specific properties of the Product View event:
{
"context": {
"ootb_session_id": "248rhdbuw2her1",
"ootb_userid": "ExampleUser1234",
"ootb_eventdatetime": "2024-03-09T07:00:14.000Z",
"ootb_product_id": "SkMensSlipIn238745",
"ootb_variant_id": "SkMensSlipIn238745-912",
"ootb_sku_id": "SkMensSlipIn238745-912-S6",
"ootb_brand": "ExampleBrand",
"ootb_category": "C-9iu032",
"ootb_department": "D-290ijos",
"ootb_url": "https://www.example.com/products/SkMensSlipIn238745",
"ootb_page_title": "Men's Slip In - Brand New",
"ootb_page_category": "Products - Shoes",
"ootb_currency": "GBP",
"ootb_item_name": "Men's Slip In",
"ootb_price": 35.99
}
Parameters
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
ootb_session_id | Session ID | String | User’s browser session identifier. |
ootb_userid | User ID | String | Unique key identifying the user. |
ootb_eventdatetime | Event Date Time | Timestamp | Date and time of the view. |
ootb_product_id | Product ID | String | Unique key for the product viewed. |
ootb_variant_id | Variant ID | String | Key identifying the variant of the product. |
ootb_sku_id | SKU ID | String | Key identifying the SKU of the variant. |
ootb_brand | Brand | String | Brand of the item. |
ootb_category | Category | String | Key identifying the lowest level of product category. |
ootb_department | Department | String | Key identifying the department or highest-level category. |
ootb_url | URL | String | Link to the product page. |
ootb_page_title | Page Title | String | Title of the product’s page. |
ootb_page_category | Page Category | String | Category label of the product’s page. |
ootb_currency | Currency | String | Currency code of the price (e.g., GBP). |
ootb_item_name | Item Name | String | Name of the item viewed. |
ootb_price | Price | Number | Price shown on the product page at time of view. |
Explanation
- event: Set to
ootb_product_view
to indicate a user viewed a product (or variant/SKU) page. - context:
ootb_session_id
,ootb_userid
: Link the view to the user’s session and identity.ootb_eventdatetime
: Timestamp when the product view occurred.ootb_product_id
,ootb_variant_id
,ootb_sku_id
,ootb_brand
: Identify the product, variant, SKU, and brand of the item viewed.ootb_category
,ootb_department
,ootb_url
,ootb_page_title
,ootb_page_category
: Provide product taxonomy and page context.ootb_currency
,ootb_item_name
,ootb_price
: Capture the displayed price information for the item.
Updated 3 days ago