1 min read
Events
Last Updated - Platform v21All platform events are forwarded to Firebase. The below list is not exhaustive but contains events that have been modified for Firebase.
Account
Sent when the user registers a new account.
sign_up: userId: user_id # 123e4567-e89b-12d3-a456-426614174000 (usually PoqUserId) marketingOptIn: newsletter_accept? # 1 (true) / 0 (false) dataOptIn: privacy_accept? # 1 (true, data-dependent) / 0 (false)
Cart
Sent when the user adds a product to the Cart.
add_to_cart: productId: product_id # PRD28104D externalId: listing_id / variant_id # PRD28104D-RED sku: variant_id # PRD28104D-RED-M productTitle: product_name # Red Dress price: product_price # 12.99 total: total # 25.98 (quantity * price) currency: currency # USD quantity: quantity # 2
Checkout
Sent when the user taps Checkout (at the start of the checkout journey).
begin_checkout: value: total # 15.48 currency: currency # USD voucher: voucher_code # ALL20OFF / '' method: checkout_method # web / applePay / expressApplePay / card
Sent every time the Web Checkout webpage changes the URL (even when not directly visible to the user). The URL is split into max 10 chunks of max 100 characters each. This is useful as an analytics fallback for websites with complex loading.
checkoutUrlChange: url0: url_chunk_one # https://some...?id=29 url1: url_chunk_two # 9323&total=1... ... url9: url_chunk_ten # ...
Sent when the user successfully purchases the items.
purchase: transactionId: order_id # ORD12948183402 userId: user_id # 123e4567-e89b-12d3-a456-426614174000 (usually PoqUserId) rrp: subtotal_rrp # 18.00 / 0 (data-dependent) delivery: subtotal_delivery # 1.99 / 0 (data-dependent) tax: subtotal_tax # 2.19 / 0 (data-dependent) value: total # 20.96 currency: currency # USD quantity: quantity # 3 (total quantity of items) items: - item_id: sku # PRD28104D-RED-M item_name: product_name # Red Dress price: price # 12.99 quantity: quantity # 1 - item_id: sku # PRD0492S-B item_name: product_name # Socks price: price # 2.49 quantity: quantity # 2 voucher: voucher_code # ALL20OFF / '' method: checkout_method # web / applePay / expressApplePay / card
Onboarding
Sent when the user begins Onboarding.
tutorial_begin:
Sent when the user completes or skips Onboarding.
tutorial_complete:
Product Details
Sent when the user navigates to a Product Details screen.
view_item: productId: product_id # PRD28104D externalId: listing_id / variant_id # PRD28104D-RED productTitle: product_name # Red Dress price: product_price # 12.99 currency: currency # USD # source: source # This is deprecated.
Product List
Sent when the user navigates to the Product List, via a category, from the Shop screen or a category search suggestion.
view_item_list: categoryId: category_id # new-in categoryTree: category_tree # dresses>petite>new-in categoryTitle: category_name # New In parentCategoryId: category_parent_id # petite / '' (data-dependent)
Sent when the user navigates to the Product List from a search result.
view_search_results: query: search_query # summer type: result_type # search / viewPlp (category result) result: any_products? # successful (true) / unsuccessful (false)
Wishlist
Sent when the user adds a product to the Wishlist.
add_to_wishlist: productId: product_id # PRD28104D listingId: listing_id # PRD28104D-RED externalId: listing_id / variant_id # PRD28104D-RED productTitle: product_name # Dress price: product_price # 12.99 total: total # 25.98 (quantity * price) currency: currency # USD quantity: quantity # 2
Other
Sent when the user navigates to a new screen.
screen_view: screen_name: screen_name # Cart Screen (code-dependent) screen_class: screen_class # PoqCartViewController