Method Calls

Method Calls and Monetate Features Unlocked

Each Monetate JavaScript API method offers benefits you can use in the experiences you build. Furthermore, each method you use unlocks more WHO behavioral targets under each corresponding section. More targeting options become available as you provide the platform with more data through each method.
The following information includes examples of best practices. If you have any questions, submit them using the 
﻿.
Product-Related Methods
Attribute values for products details (addProductDetails﻿), cart, and conversion are stored historically against the customer profile. However, attribute values for products (addProducts﻿), page types, and custom variables are not stored and are page-temporal.
addProducts
Use this method﻿ to add products that the customer views on index or search results pages.
WHO Targets Unlocked
None
Action Conditions Unlocked
Product list page > List page includes thumbnails where PID =
Product list page > List page doesn't include thumbnails where PID =
addProductDetails
With this method﻿ you can create an experience that targets customers who have viewed a certain product during their current visit. Using it also unlocks advanced Product Recommendations features.
The addProducts﻿ and addProductDetails﻿ methods are not limited or tied to product or index page types and can be used to target any page type as long as the relevant product IDs are sent to the platform. These methods are tied to the PID information sent to the platform and are independent on the page type sent via the setPageType﻿ method. In the action conditions listed, you can use conditions that require PIDs on any page type. They aren't tied only to index, search, or product page types.
WHO Targets Unlocked
Product viewed
Product viewed last visit
Product viewed this visit
SKU
Action Conditions Unlocked
Product detail page > Detail page includes products where PID =
Product detail page > Detail page doesn't include products where PID =
addProductDetails with a Product Catalog
﻿This method﻿ allows you to create an experience that targets visitors who have viewed a specific brand or category.
WHO Targets Unlocked
Brand in cart
Brand last purchased
Brand purchased
Brand viewed
Brand viewed last visit
Brand viewed this visit
Category in cart
Category last purchased
Category purchased
Category viewed
Category viewed last visit
Category viewed this visit
Viewed product out of stock
Action Conditions Unlocked
Product detail page > Detail page includes products where category =
Product detail page > Detail page doesn't include products where category =
Site-Related Methods
setPageType
﻿This method﻿ allows you to run an experience on all page types using action conditions.
WHO Targets Unlocked
None
Action Conditions Unlocked
Page type =
Page type ≠
addCartRows
﻿This method﻿ allows you to create an experience that targets customers who have a certain product or amount in their cart.
WHO Targets Unlocked
Abandoned cart
Amount in abandoned cart
Amount in cart
Average order size
Product in abandoned cart
Product in cart
Quantity in cart
Action Conditions Unlocked
Cart value <
Cart value ≤
Cart value >
Cart value ≥
addPurchaseRows
﻿This method﻿ allows you to create an experience that targets customers who have purchased any product in the past.
WHO Targets Unlocked
Days since last purchase
Last order size
Product last purchased
Product purchased
Product purchased in past days
Purchase frequency
Purchased any product
Purchases in past days
Action Conditions Unlocked
None
addConversionRows
﻿This method﻿ allows you to create an experience that targets customers who've completed a non-monetary conversion on your site.
WHO Targets Unlocked
Days since last purchase
Last order size
Product last purchased
Product purchased
Product purchased in past days
Purchase frequency
Purchased any product
Purchases in past days
Action Conditions Unlocked
None
addCategories
﻿This method﻿ adds page categories that the customer views.
WHO Targets Unlocked
None
Action Conditions Unlocked
Page category contains
Page category doesn't contain
Page category =
Page category ≠
Page category starts with
Page category doesn't start with
Page category ends with
Page category doesn't end with
addBreadcrumbs
﻿This method﻿ adds a site navigation breadcrumb trail for the customer.
WHO Targets Unlocked
None
Action Conditions Unlocked
Page breadcrumb contains
Page breadcrumb doesn't contain
Page breadcrumb =
Page breadcrumb ≠
Page breadcrumb starts with
Page breadcrumb doesn't start with
Page breadcrumb ends with
Page breadcrumb doesn't end with
addPollForElement
﻿This method﻿ adds a delay to the trackData﻿ call until some element on the page exists.
WHO Targets Unlocked
None
Action Conditions Unlocked
None
addSearch
The Searched and Also Purchased premium recommendation algorithm requires you to implement one or two addSearch﻿ methods to send customers' search query data for use with a recommendation strategy configured with this recommendation algorithm.
WHO Targets Unlocked
None
Action Conditions Unlocked
None
trackData
﻿This method﻿ sends data that's been pushed to the monetateQ﻿ array.
WHO Targets Unlocked
None
Action Conditions Unlocked
None
trackEvent
﻿This method﻿ indicates an event has occurred on your site.
WHO Targets Unlocked
None
Action Conditions Unlocked
None
setDebug
﻿This method﻿ enables debugging for the Monetate JavaScript API so that you can see console errors.
WHO Targets Unlocked
None
Action Conditions Unlocked
None
removeDebug
﻿This method﻿ disables debugging for the Monetate JavaScript API if you had enabled it with the setDebug﻿ method.
WHO Targets Unlocked
None
Action Conditions Unlocked
None
﻿
﻿

Updated 25 Sep 2024

Code Samples for Third-Party Analytics Integrations

Example Implementations by Page Type

Docs powered by Archbee

TABLE OF CONTENTS

Product-Related Methods

addProducts

addProductDetails

addProductDetails with a Product Catalog