Omnichannel Experiences
Omnichannel Recommendations Action Requests

When selecting recommendation strategies for this type of action, be aware of the following conditions related to the recommendation algorithm configured as part of the recommendation strategy:
When using the Most Viewed (Product Detail Page), Top Selling by Purchase Count, and Top Selling by Gross Revenue recommendation algorithms, you don't need to send any product-specific information in the requests.
When using the Viewed and Also Viewed recommendation algorithm with the recommendation based on the first item viewed on the current page or on the last item viewed in any session, send the monetate:context:ProductDetailView﻿ event in the request.
When using the Viewed and Also Viewed recommendation algorithm with the recommendation based on item(s) viewed on the current page, send all product IDs in the monetate:context:ProductThumbnailView﻿ event.
Request Examples for Noncollaborative Standard Algorithms
This request example is for an Omnichannel recommendations action configured with recommendation strategies that use the Most Viewed (Product Detail Page), Top Selling by Purchase Count, or Top Selling by Gross Revenue recommendation algorithms.
Example Request for Omnichannel Recs Action Using a Noncollaborative Algorithm
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "Index"
    }
  ]
}
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "Index"
    }
  ]
}
﻿
Request Examples for Viewed and Also Viewed Algorithm
This example is for recommendation strategies that use the Viewed and Also Viewed recommendation algorithm with recommendations based on the first item viewed on the current page or the last item viewed in any session.
Example Request for Omnichannel Recs Action Using Viewed and Also Viewed Algorithm
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:ProductDetailView",
      "products": 
      [        
        {
          "productId": "product72",
          "sku": "product72-large-green"
        }
      ]
    },   
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "ProductPage"
    }
  ]
}
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:ProductDetailView",
      "products": 
      [        
        {
          "productId": "product72",
          "sku": "product72-large-green"
        }
      ]
    },   
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "ProductPage"
    }
  ]
}
﻿
This example is for recommendation strategies that use the Viewed and Also Viewed recommendation algorithm based on item(s) viewed on the current page.
Example Request for Omnichannel Recs Action Using Viewed and Also Viewed Algorithm
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:ProductThumbnailView",
      "products": 
      [
        "123",
        "456",
        "789"
      ]
    }, 
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "Index"
    }
  ]
}
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:ProductThumbnailView",
      "products": 
      [
        "123",
        "456",
        "789"
      ]
    }, 
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "Index"
    }
  ]
}
﻿
Request Examples for Viewed and Also Viewed, Viewed and Later Purchased Algorithms
This example is for recommendation strategies that use the Viewed and Also Viewed and the Viewed and Later Purchased recommendation algorithms based on the last item purchased in any session.
You must send the product ID of the last purchase.
Example Request for Omnichannel Recs Action Using Viewed and Also Viewed, Viewed and Later Purchased Algorithms
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:Purchase",
      "productId": "product43",
      "purchaseId": "123456789",
      "purchaseLines": 
      [        
        {
          "sku": "product72colour2",
          "pid": "product72",
          "quantity": 2,
          "currency": "GBP",
          "value": "24.00"
        }
      ]
    },
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "Index"
    }
  ]
}
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:Purchase",
      "productId": "product43",
      "purchaseId": "123456789",
      "purchaseLines": 
      [        
        {
          "sku": "product72colour2",
          "pid": "product72",
          "quantity": 2,
          "currency": "GBP",
          "value": "24.00"
        }
      ]
    },
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "Index"
    }
  ]
}
﻿
This example is for recommendation strategies that use the Viewed and Also Viewed and the Viewed and Later Purchased recommendation algorithms based on the last item carted in any session.
You must send the product ID of the last item added to the cart.
Example Request for Omnichannel Recs Action Using Viewed and Also Viewed, Viewed and Later Purchased Algorithms
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:Cart",
      "cartLines": 
      [        
        {
          "sku": "product72colour2",
          "pid": "product72",
          "quantity": 2,
          "currency": "GBP",
          "value": "24.00"
        }
      ]
    },
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "Index"
    }
  ]
}
{
  "channel": "a-927c8120/p/example.com",
  "events": 
  [    
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "11111",
      "includeReporting": true
    },    
    {
      "eventType": "monetate:context:IpAddress",
      "ipAddress": "188.221.179.186"
    },    
    {
      "eventType": "monetate:context:Cart",
      "cartLines": 
      [        
        {
          "sku": "product72colour2",
          "pid": "product72",
          "quantity": 2,
          "currency": "GBP",
          "value": "24.00"
        }
      ]
    },
    {
      "eventType": "monetate:context:PageView",
      "url": "https://www.example.com",
      "pageType": "Index"
    }
  ]
}
﻿
Request Best Practices by Implementation Type
If your site uses a hybrid implementation﻿, keep in mind these best practices when configuring an Omnichannel Product Recommendation action:
You only have to send product IDs if you base recommendations on a specific product (for example, a recommendation strategy configured with the Viewed and Also Viewed recommendation algorithm based on the last item viewed in any session or the first item viewed on the current page).
﻿monetate:context:ProductDetailView﻿, CartLine﻿, and PurchaseLine﻿ events are obtained from the Monetate tag. You're not required to send these.
If your site uses a pure Engine API implementation﻿, keep in mind that you must send all ProductDetailView, cartLine, and purchaseLine events.
Updated 17 Sep 2024
Preview an Omnichannel Experience
Omnichannel Recommendations Reporting Requests
Docs powered by Archbee
TABLE OF CONTENTS
Request Examples for Noncollaborative Standard Algorithms
Request Examples for Viewed and Also Viewed Algorithm
Request Examples for Viewed and Also Viewed, Viewed and Later Purchased Algorithms
Request Best Practices by Implementation Type