Omnichannel Experiences

Omnichannel Personalized Site Search Action Request

Here is an example of an Engine API request for an Omnichannel Personalized Site Search action.
See Calling the Personalized Search API﻿ for full details about Personalized Site Search requests.
Example Omnichannel Personalized Site Search Action Request
{
  "channel": "a-424w1216/p/example.com",
    "events": [
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "12345"
    }
  ]
}
{
  "channel": "a-424w1216/p/example.com",
    "events": [
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "12345"
    }
  ]
}
﻿
The response to this request appears much like the following example.
Example Omnichannel Personalized Site Search Action Response
{
  "meta": {
    "code": 200,
      "monetateId": "5.1290581234.1733503404082"
  },
  "data": {
    "responses": [
      {
        "requestId": "12345",
        "actions": [
          {
            "actionEvents": [
              "op_click",
              "op_impression"
            ],
            "actionId": {action_id},
            "search_token": "{search_token}",
            "actionType": "monetate:action:SiteSearchApiAction"
          }
        ]
      }
    ]
  }
}
{
  "meta": {
    "code": 200,
      "monetateId": "5.1290581234.1733503404082"
  },
  "data": {
    "responses": [
      {
        "requestId": "12345",
        "actions": [
          {
            "actionEvents": [
              "op_click",
              "op_impression"
            ],
            "actionId": {action_id},
            "search_token": "{search_token}",
            "actionType": "monetate:action:SiteSearchApiAction"
          }
        ]
      }
    ]
  }
}
﻿
Recommendation Strategies and Context Events
The configuration of the recommendation strategy selected in the Personalized Site Search action may require you to send certain context events in the request. If the selected recommendation strategy is configured with the Viewed and Also Viewed or other collaborative recommendation algorithms, then the option selected from Base Recommendation on determines what context events you must include in the request.
The following table contains guidance for which context events you must include in the request when the recommendation strategy uses a collaborative recommendation algorithm, based on the option selected from Base Recommendation on in the strategy configuration.
Base Recommendation on
Event Required
Item(s) viewed on current page
﻿monetate:context:ProductDetailView﻿ or monetate:context:ProductThumbnailView﻿﻿
First item viewed on current page
﻿monetate:context:ProductDetailView﻿ or monetate:context:ProductThumbnailView﻿﻿
Last item viewed in any session
No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item(s) viewed in past sessions
No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item(s) currently in the cart
﻿monetate:context:Cart﻿ 
Abandoned cart items in past sessions
No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Last item carted in any session
No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item(s) purchased in current session
No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item(s) purchased in previous sessions
No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Last item purchased in any session
No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item group ID(s) in custom variable
﻿monetate:context:CustomVariables﻿ 
See User Identity Persistence in Requests﻿ for more information about passing unique identifiers for customers in Engine API requests.
Example Request
Here is an example of an Engine API request for an Omnichannel Personalized Site Search action that's configured with a recommendation strategy powered by the Purchased and Also Purchased recommendation algorithm and with Item(s) viewed on current page selected for Base Recommendation on.
Example Omnichannel Personalized Site Search Action Response
{
  "channel": "a-12345/p/example.com",
  "events": [
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "12345"
    },
    {
      "eventType": "monetate:context:ProductDetailView",
      "products": [
        {
          "productId": "{pid}",
          "sku": "{sku}"
        }
      ]
    }
  ]
}
{
  "channel": "a-12345/p/example.com",
  "events": [
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "12345"
    },
    {
      "eventType": "monetate:context:ProductDetailView",
      "products": [
        {
          "productId": "{pid}",
          "sku": "{sku}"
        }
      ]
    }
  ]
}
﻿
﻿

Base Recommendation on	Event Required
Item(s) viewed on current page	monetate:context:ProductDetailView or monetate:context:ProductThumbnailView
First item viewed on current page	monetate:context:ProductDetailView or monetate:context:ProductThumbnailView
Last item viewed in any session	No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item(s) viewed in past sessions	No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item(s) currently in the cart	monetate:context:Cart
Abandoned cart items in past sessions	No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Last item carted in any session	No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item(s) purchased in current session	No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item(s) purchased in previous sessions	No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Last item purchased in any session	No additional events required so long as the customer's unique identifier is associated with a previous completed purchase
Item group ID(s) in custom variable	monetate:context:CustomVariables

Updated 12 Dec 2024

Omnichannel Recommendations Reporting Requests

Omnichannel Dynamic Bundle Action Request