Events

Promotion Viewed

User viewed promotion.
Suggested source: website front-end
Properties
Name
Type
Description
Required
creative
string
Promotion's creative (for example, top_banner_2)

no
name
string
Promotion's name (for example, "75% store-wide shoe sale")

yes
position
string
Promotion's position (for example, home_banner_top)

no
promotion_id
string
Promotion's ID (for example, promo_1)

yes
bundle
boolean
Product belongs to a bundle

no
description
string
Short description of the product

no
option_values
string[]
Option values of the product variant

no
slug
string
Slug of the product, often used in URLs (for example, "product-red")

no
affiliation
string
Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")

no
brand
string
Brand associated with the product

no
category
string
Product category

no
coupon
string
Coupon code associated with a product (for example, "MAY_DEALS_3")

no
currency
string
Currency code of the transaction (for example, "USD")
Pattern: ^[A-Z]{3}$

no
price
number
Price ($) of the product

no
product_id
string
Database ID of the product

no
quantity
integer
Quantity of the product

no
variant
string
Name of the product variant

no
Example
JSON
{
    "creative": "top_banner_2",
    "name": "15% off spring seeds",
    "position": "home_banner_top",
    "promotion_id": "promo_1",
    "affiliation": "My Plant Store",
    "brand": "Green Thumb Nurseries",
    "bundle": false,
    "category": "Vegetable Seeds",
    "coupon": "SPRING15",
    "currency": "USD",
    "description": "High-quality heirloom carrot seeds that produce sweet and crunchy carrots, perfect for home gardening.",
    "image_url": "https://example.com/images/carrot-seeds.jpg",
    "option_values": [
        "Nantes",
        "Danvers",
        "Imperator"
    ],
    "price": 3.99,
    "product_id": "987654321",
    "quantity": 1,
    "sku": "CARROT-002",
    "slug": "heirloom-carrot-seeds",
    "url": "https://example.com/seeds/carrot",
    "variant": "Nantes"
}
{
    "creative": "top_banner_2",
    "name": "15% off spring seeds",
    "position": "home_banner_top",
    "promotion_id": "promo_1",
    "affiliation": "My Plant Store",
    "brand": "Green Thumb Nurseries",
    "bundle": false,
    "category": "Vegetable Seeds",
    "coupon": "SPRING15",
    "currency": "USD",
    "description": "High-quality heirloom carrot seeds that produce sweet and crunchy carrots, perfect for home gardening.",
    "image_url": "https://example.com/images/carrot-seeds.jpg",
    "option_values": [
        "Nantes",
        "Danvers",
        "Imperator"
    ],
    "price": 3.99,
    "product_id": "987654321",
    "quantity": 1,
    "sku": "CARROT-002",
    "slug": "heirloom-carrot-seeds",
    "url": "https://example.com/seeds/carrot",
    "variant": "Nantes"
}
﻿
  
option_values[] array
Option values of the product variant
Option value (for example, "red")
Item Type: string

Name	Type	Description	Required
creative	string	Promotion's creative (for example, top_banner_2)	no
name	string	Promotion's name (for example, "75% store-wide shoe sale")	yes
position	string	Promotion's position (for example, home_banner_top)	no
promotion_id	string	Promotion's ID (for example, promo_1)	yes
bundle	boolean	Product belongs to a bundle	no
description	string	Short description of the product	no
option_values	string[]	Option values of the product variant	no
slug	string	Slug of the product, often used in URLs (for example, "product-red")	no
affiliation	string	Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")	no
brand	string	Brand associated with the product	no
category	string	Product category	no
coupon	string	Coupon code associated with a product (for example, "MAY_DEALS_3")	no
currency	string	Currency code of the transaction (for example, "USD") Pattern: ^[A-Z]{3}$	no
price	number	Price ($) of the product	no
product_id	string	Database ID of the product	no
quantity	integer	Quantity of the product	no
variant	string	Name of the product variant	no

Promotion Clicked

Shipment Delivered