SDK Metrics Reference

All trackable events and methods available in the Veya Analytics SDK.

Showing 71 of 71 metrics

Event Name	Method	Category	Description
`session_start`	`init()`	Session	Automatically tracked when SDK initializes. Captures landing page and referrer.
`session_end`	`automatic`	Session	Automatically tracked on page unload. Includes total session duration.
`page_hidden`	`automatic`	Session	Tracked when page visibility changes to hidden. Includes time spent on page.
`page_visible`	`automatic`	Session	Tracked when page becomes visible again after being hidden.
`page_view`	`pageView(options)`	Navigation	Track page views with optional page type. Menu pages are tagged as funnel step 1. Params: `pageType?: string`
`scroll_depth`	`automatic`	Navigation	Automatically tracked at 25%, 50%, 75%, and 100% scroll milestones.
`click`	`data-veya-track attribute`	Navigation	Tracks clicks on elements with data-veya-track attribute. Use data-veya-props for custom properties.
`product_view`	`productView(product)`	E-commerce	Track when a user views a product detail page. Params: `id, name, category, price`
`product_click`	`productClick(product)`	E-commerce	Track when a user clicks on a product (e.g., from a list). Params: `id, name, category, price`
`add_to_cart`	`addToCart(product, quantity)`	E-commerce	Track item added to cart. Updates internal cart state. Tagged as funnel step 2. Params: `id, name, category, price, quantity`
`remove_from_cart`	`removeFromCart(product, quantity)`	E-commerce	Track item removed from cart. Updates internal cart state. Params: `id, name, price, quantity`
`update_cart_quantity`	`updateCartQuantity(product, oldQty, newQty)`	E-commerce	Track quantity changes for cart items. Params: `id, name, oldQuantity, newQuantity`
`cart_view`	`viewCart()`	E-commerce	Track when user views their cart. Includes cart value and item count.
`checkout_start`	`checkoutStart()`	E-commerce	Track checkout initiation. Tagged as funnel step 3 (checkout_info).
`checkout_step`	`checkoutStep(step)`	E-commerce	Track progression through checkout steps. Params: `step: string`
`add_payment_info`	`addPaymentInfo(paymentMethod)`	E-commerce	Track payment method selection. Tagged as funnel step 4. Params: `paymentMethod: string`
`purchase`	`checkoutComplete(order)`	E-commerce	Track completed purchase. Tagged as funnel step 5 (confirmation). Clears cart. Params: `id, olo_order_id, total, subtotal, tax, tip, orderType, paymentMethod, items`
`quick_add_attempted`	`quickAddAttempted(options)`	E-commerce	Track when user taps quick add button before API call. Params: `productId, productName, source, modifierCount`
`quick_add_failed`	`quickAddFailed(options)`	E-commerce	Track when quick add API call fails. Params: `productId, errorType, errorMessage, source`
`login_attempt`	`loginAttempt(method)`	Authentication	Track login attempt with method (email, social, etc.). Params: `method: string`
`login_success`	`loginSuccess(method, customerId)`	Authentication	Track successful login. Sets customer ID for future events. Params: `method: string, customerId: string`
`login_failure`	`loginFailure(method, error)`	Authentication	Track failed login attempt with error message. Params: `method: string, error: string`
`logout`	`logout()`	Authentication	Track user logout. Clears customer ID.
`identify`	`identify(customerId, traits)`	Authentication	Associate visitor with customer ID and optional traits. Params: `customerId: string, traits?: object`
`store_selected`	`setStore(store)`	Store	Track initial store selection. Sets store context for all future events. Params: `id, name, orderType, address?`
`store_changed`	`setStore(store)`	Store	Track when user changes to a different store. Includes previous store info. Params: `id, name, orderType, address?`
`order_type_changed`	`setOrderType(orderType)`	Store	Track when user switches between pickup and delivery. Params: `orderType: 'pickup' \| 'delivery'`
`location_modal_opened`	`locationModalOpened(options)`	Location	Track when location selection modal opens. Params: `trigger?, hasRecentLocations?`
`fulfillment_method_selected`	`fulfillmentMethodSelected(options)`	Location	Track when user selects fulfillment method (pickup/delivery). Params: `method, previousMethod?`
`location_permission_requested`	`locationPermissionRequested()`	Location	Track when location permission is requested from browser.
`location_permission_granted`	`locationPermissionResponse(true)`	Location	Track when user grants location permission.
`location_permission_denied`	`locationPermissionResponse(false)`	Location	Track when user denies location permission.
`location_search_started`	`locationSearchStarted()`	Location	Track when user starts typing in location search.
`location_search_results`	`locationSearchResults(options)`	Location	Track location search results returned. Params: `query, resultCount, searchType?`
`location_selected`	`locationSelected(options)`	Location	Track when user selects a location. Params: `locationId, locationName, fulfillmentMethod, resultPosition?, selectionSource?, distance?`
`location_view_toggled`	`locationViewToggled(view)`	Location	Track when user toggles between list and map view. Params: `view: 'list' \| 'map'`
`recent_location_used`	`recentLocationUsed(options)`	Location	Track when returning customer uses a recent location. Params: `locationId, locationName, position, lastOrderDate?`
`location_search_no_results`	`locationSearchNoResults(options)`	Location	Track when location search returns no results. Params: `query, searchType?`
`location_search_error`	`locationSearchError(options)`	Location	Track location search error. Params: `errorType, errorMessage?, query?`
`delivery_unavailable`	`deliveryUnavailable(options)`	Location	Track when delivery is unavailable for an address. Params: `address, reason?, nearestLocationId?, nearestDistance?`
`location_services_disabled`	`locationServicesDisabled()`	Location	Track when user has location services disabled.
`delivery_address_entered`	`deliveryAddressEntered(options)`	Location	Track when user enters delivery address. Params: `addressType?, hasApartment?`
`delivery_address_validated`	`deliveryAddressValidated(options)`	Location	Track when delivery address is validated. Params: `success, validationType?, errorReason?`
`delivery_details_completed`	`deliveryDetailsCompleted(options)`	Location	Track when user completes delivery details form. Params: `hasApartment, hasInstructions, deliveryOption?`
`delivery_fallback_to_pickup`	`deliveryFallbackToPickup(options)`	Location	Track when user switches from delivery to pickup after delivery unavailable. Params: `reason, selectedLocationId?, selectedLocationName?`
`menu_loaded`	`menuLoaded(options)`	Menu	Track menu load performance and content metrics. Params: `loadTime, categoryCount, productCount, hasRecentItems, recentItemsCount`
`category_viewed`	`categoryViewed(category)`	Menu	Track when a category scrolls into viewport. Params: `id, name, position, viewDuration?`
`category_clicked`	`categoryClicked(category)`	Menu	Track when user taps category tab to navigate. Params: `id, name, position`
`menu_scroll`	`menuScroll(options)`	Menu	Track menu scroll depth milestones (25/50/75/100%). Params: `scrollDepth, categoryInView, scrollDirection, scrollVelocity`
`category_scroll`	`categoryScroll(options)`	Menu	Track horizontal scrolling of category tabs. Params: `scrollPosition, categoriesVisible, totalCategories, scrollDirection`
`product_impression`	`productImpression(options)`	Menu	Track when product is visible in viewport for >2 seconds. Params: `productId, viewDuration, scrollPosition, categoryContext, hasQuickAdd`
`menu_session_summary`	`menuSessionSummary(options)`	Menu	Track overall menu browsing session when user leaves menu. Params: `sessionDuration, categoriesVisited, productsViewed, searchUsed, quickAddsAttempted, recentItemsEngaged`
`conveyance_interaction`	`conveyanceInteraction(options)`	Menu	Track engagement with hero image conveyance. Params: `conveyanceType, scrollDepth, imageEngagement`
`recent_items_loaded`	`recentItemsLoaded(options)`	Menu	Track when recent items section is populated from order history. Params: `itemCount, oldestOrderDate, newestOrderDate`
`recent_items_empty`	`recentItemsEmpty()`	Menu	Track when authenticated user has no order history.
`recent_item_viewed`	`recentItemViewed(item)`	Menu	Track when a recent item appears in viewport. Params: `productId, lastOrderDate, hasQuickAdd`
`recent_item_clicked`	`recentItemClicked(item)`	Menu	Track when user taps on a recent item. Params: `productId, lastOrderDate, position, action`
`recent_items_scroll`	`recentItemsScroll(options)`	Menu	Track horizontal scroll of recent items carousel. Params: `itemsVisible, totalItems, scrollPosition`
`search_started`	`searchStarted()`	Search	Track when user activates search mode.
`search`	`search(query, resultCount)`	Search	Track search query and result count (legacy method). Params: `query: string, resultCount: number`
`search_cleared`	`searchCleared(options)`	Search	Track when user clears or cancels search. Params: `query, hadResults, searchDuration`
`search_no_results`	`searchNoResults(options)`	Search	Track when search returns no results. Params: `query, queryLength`
`search_result_clicked`	`searchResultClicked(options)`	Search	Track when user clicks a product from search results. Params: `query, productId, resultPosition, categoryContext`
`promo_apply`	`promoApply(promo)`	Loyalty & Promos	Track promo code application attempt. Params: `code, success, discount, error`
`promo_remove`	`promoRemove(code)`	Loyalty & Promos	Track promo code removal. Params: `code: string`
`reward_view`	`rewardView(reward)`	Loyalty & Promos	Track when user views available rewards. Params: `reward: object`
`reward_apply`	`rewardApply(reward)`	Loyalty & Promos	Track when user applies a reward. Params: `reward: object`
`reward_remove`	`rewardRemove(reward)`	Loyalty & Promos	Track when user removes an applied reward. Params: `reward: object`
`error`	`error(type, message, properties)`	Error	Track application errors with type and message. Params: `type: string, message: string, properties?: object`
`experiment_assigned`	`setExperiment(name, variant)`	Experiments	Track A/B test or experiment assignment. Params: `experimentName: string, variant: string`
`custom`	`track(eventName, properties)`	Navigation	Track any custom event with arbitrary properties. Params: `eventName: string, properties?: object`