Under Construction 🚧 These docs are a work in progress.

The following fields real-time attributes can be used in various parts of the platform. These fields cover a wide range of data sources, including page information, marketing tags, customer data, cart details, and geographical attributes.

1. Page Information

  • Page: Path (path): Use this to match against the path of the current page a visitor is viewing. Example: /collections/all-products.
  • Page: Referrer Path (referrer_path): Refers to the page that led the visitor to the current page. Example: /collections/all-products.

2. Marketing Tags (UTM Parameters)

  • UTM: Source (marketing_source): Tracks the origin of your marketing traffic. Example: newsletter.
  • UTM: Medium (marketing_medium): Identifies the medium of the marketing effort. Example: email.
  • UTM: Campaign (marketing_campaign): Matches the campaign identifier for marketing promotions. Example: banner_ad_1.
  • UTM: Term (marketing_term): Captures any paid keywords associated with your campaigns. Example: running+shoes.
  • UTM: Content (marketing_content): Identifies the content used within a campaign. Example: banner_red.

3. Cart Details

  • Cart: Empty (cart_empty): Indicates whether the shopping cart is empty (boolean field).
  • Cart: Value (cart_value): The total value of the items in the cart. Example: 800.
  • Cart: Number of Items (num_cart_items): Number of items in the customer’s cart. Example: 4.
  • Cart: Discount Value Without Coupon (cart_discount_value_without_coupon): The total value of discounts applied without a coupon.
  • Cart: Discount Value With Coupon (cart_discount_value_with_coupon): Total discount value including any coupon codes.

4. Customer Information

  • Customer: Signed In (signed_in): Indicates whether the customer is signed in (boolean field).
  • Customer: Number of Orders (num_orders): Tracks the total number of orders a customer has placed. Example: 4.
  • Customer: Average Order Value (average_order_value): The average value of the customer’s orders. Example: 4.
  • Customer: Average Days Between Orders (days_between_orders): Average time between the customer’s orders in days.
  • Customer: Days Since Last Order (days_since_last_order): Number of days since the customer made their last purchase.
  • Customer: Days Since Oldest Order (days_since_oldest_order): Number of days since the customer’s first order.
  • Customer: Total Spent (All Time) (total_spent): Total amount spent by the customer. Example: 400.
  • Customer: Discount Value Without Coupon (Last 20 orders) (discount_value_without_coupon): The total discount value (excluding coupons) for the customer’s last 20 orders.
  • Customer: Discount Value With Coupon (Last 20 orders) (discount_value_with_coupon): Total discount value, including coupons, for the last 20 orders.

5. Geographical Data

  • Geo: City (geo_city): The city in which the visitor is located. Example: Boston.
  • Geo: State (geo_state): The state in which the visitor is located. Example: MA.
  • Geo: Country (geo_country): The country in which the visitor is located. Example: US.