Target, Event, & Condition Mapping

If your site leverages the Engine API, you must ensure to include in Engine API requests the information necessary for WHO targets and action conditions.

Complete technical documentation for the Engine API is available in the Monetate platform. Click the settings cog and then select API Documentation.

Target Type Mapping

This table contains the target types and their respective associated Engine API events.

Target TypeTargetEngine API EventNotes
LocationAllmonetate:context:IpAddress
monetate:context:Coordinates
Send coordinates for greater precision; the same request can contain both IP address and coordinates
WeatherAllmonetate:context:IpAddress
monetate:context:Coordinates
Send coordinates for greater precision; the same request can contain both IP address and coordinates
US DemographicsAllmonetate:context:IpAddress
monetate:context:Coordinates
Send coordinates for greater precision; the same request can contain both IP address and coordinates
Technographics
  • Browser
  • Device Type
  • Operating System
  • HTML5 Capable
monetate:context:UserAgent
  • Screen Height
  • Screen Width
  • Screen Resolution
monetate:context:ScreenSize
Landing
  • Custom variable visitors
  • Custom variable visitors with multiple values
monetate:context:CustomVariablesAlso used in place of custom targets
New visitorsMatches when a Monetate ID or device ID isn't present in the request
Returning visitorsMatches when a Monetate ID or device ID is present in the request
  • Referrer
  • Last external referrer in past hours contains
monetate:context:Referrer
Direct navigation visitorsMatches with the absence of monetate:context:Referrer
  • Initial URL query string
  • Landing page match
  • Last external landing in past hours contains
monetate:context:PageViewReferences the URL parameter for evaluation
Behavior
  • Abandoned cart
  • Amount in abandoned cart
  • Amount in cart
  • Attribute of product in cart
  • Product in abandoned cart
  • Product in cart
  • Quantity in cart
monetate:context:CartAlso requires passing a known Monetate ID or device ID to sync past session behavior
  • Attribute of product purchased
  • Average order size
  • Days since last purchase
  • Last order size
  • Product last purchased
  • Product purchased
  • Products purchased in past days
  • Purchase frequency
  • Purchased any product
  • Purchases in past days
  • Purchased on or after specified date
monetate:context:PurchaseAlso requires passing a known Monetate ID or device ID to sync past session behavior
  • Attribute of product viewed
  • Product viewed
  • Product viewed last visit
  • Product viewed this visit
monetate:context:ProductDetailViewAlso requires passing a known Monetate ID or device ID to sync past session behavior; a product catalog is required for attribute-based targeting
  • Days since last visit
  • Experiences seen by user
  • Sessions in past days
  • Time on site
  • Visited on or after specified date
Based on the Monetate sessionAlso requires passing a known Monetate ID or device ID to sync past session behavior
DatasetsAllLookup is based on the customerId field in the Engine API request

The Engine API does not support custom targets, which are client-side targets based on cookies, JavaScript variables, and HTML elements. The Engine API doesn't have access to this information, so you must pass this information using monetate:context:CustomVariables instead.

Action Condition Mapping

This table contains the action conditions and their respective associated Engine API events.

Action ConditionEngine API EventNotes
Page typemonetate:context:PageViewReferences the pageType parameter
URLmonetate:context:PageViewReferences the URL parameter
TimeBased on request evaluation time
Cart valuemonetate:context:Cart
Page categorymonetate:context:PageViewReferences the categories parameter
Page breadcrumbmonetate:context:PageViewReferences the breadcrumbs parameter
Landing pageNot currently supported
On product page...monetate:context:ProductDetailView
On index page...monetate:context:ProductThumbnailView

Event/Metric Mapping

Events, such as product views, are counted individually. If this information is recorded by both the Monetate tag and the Engine API, which is possible in a hybrid integration, the event could be counted twice in the experience analytics. See Retracks and the Average Page View Metric in AJAX Site Updates for more information.

For non-hybrid implementations, all event reporting must be passed via Engine API requests. This table contains the default metrics and their respective associated Engine API events.

MetricEngine API Event
Conversion rate
New customer acquisition rate
Revenue per session
Average order value
monetate:context:Purchase
Add to cart rate
Cart abandonment rate
monetate:context:Cart
Bounce rate
Average page views
Not currently supported
Average time on siteBased on the Monetate session
API eventsmonetate:record:PageEvents
Recommendations impressionsmonetate:record:RecImpressions
Recommendations clicksmonetate:record:RecClicks