Omnichannel Experiences
Omnichannel Social Proof Action Requests

There's only one Omnichannel Social Proof action template, and it works on both product detail pages, which display a single product ID (PID), and on pages that display multiple PIDs, such as product category listings, search results, and cart pages. Therefore, you must specify in the Engine API request if the action's messages should appear on product detail pages or on pages that display multiple PIDs.
If you want Social Proof messages to appear or not to appear on a specific page type, then use one of the Page type action condition options when configuring the action in the Monetate platform. See Action Condition Mapping﻿ in Target, Event, & Condition Mapping﻿ for more information.
Request for Messages on Product Detail Pages
Here is an example of an Engine API request targeting product detail pages. The monetate:context:ProductDetailView﻿ event specifies that the action targets product detail pages.
Example Omnichannel Social Proof Action Request Targeting Product Detail Pages
{
  "channel": "a-927c8120/p/example.com",
  "monetateId": "5.1982474515.1616616018101",
  "events": [
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "sample-unique-request-id-ABC-123",
      "includeReporting": false
    },
    {
      "eventType": "monetate:context:ProductDetailView",
      "products": [
        {
          "sku": "111",
          "productId": "111"
        },
        {
          "productId": "product57"
        }
      ]
    }
  ]
}
{
  "channel": "a-927c8120/p/example.com",
  "monetateId": "5.1982474515.1616616018101",
  "events": [
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "sample-unique-request-id-ABC-123",
      "includeReporting": false
    },
    {
      "eventType": "monetate:context:ProductDetailView",
      "products": [
        {
          "sku": "111",
          "productId": "111"
        },
        {
          "productId": "product57"
        }
      ]
    }
  ]
}
﻿
The response appears much like the following example.
Example Omnichannel Social Proof Action Response
{
  "meta": {
    "code": 200
  },
  "data": {
    "responses": [
      {
        "requestId": "sample-unique-request-id-ABC-123",
        "actions": [
          {
            "actionId": 4185123,
            "actionType": "monetate:action:SocialProofDataV2",
            "socialProofData": {
              "proofType": "view",
              "lookbackMinutes": 180,
              "products": [
                {
                  "productId": "pid1",
                  "count": 10
                },
                {
                  "productId": "pid2",
                  "count": 20
                }
              ]
            },
            "component": "Foo",
            "message": {
              "type": "html",
              "href": "https://{monetate_cdn}/img/1/1094/4339665.htm",
              "data": "<p>My message</p>\n"
            }
          }
        ]
      }
    ]
  }
}
{
  "meta": {
    "code": 200
  },
  "data": {
    "responses": [
      {
        "requestId": "sample-unique-request-id-ABC-123",
        "actions": [
          {
            "actionId": 4185123,
            "actionType": "monetate:action:SocialProofDataV2",
            "socialProofData": {
              "proofType": "view",
              "lookbackMinutes": 180,
              "products": [
                {
                  "productId": "pid1",
                  "count": 10
                },
                {
                  "productId": "pid2",
                  "count": 20
                }
              ]
            },
            "component": "Foo",
            "message": {
              "type": "html",
              "href": "https://{monetate_cdn}/img/1/1094/4339665.htm",
              "data": "<p>My message</p>\n"
            }
          }
        ]
      }
    ]
  }
}
﻿
Request for Messages on Pages Displaying Multiple Product IDs
Here is an example of an Engine API request targeting product category listings, search results pages, cart pages, or other page types that contain multiple product IDs. The monetate:context:ProductThumbnailView﻿  event specifies that the action targets pages displaying multiple PIDs.
Example Omnichannel Social Proof Action Request Targeting Multi-PID Pages
{
  "channel": "a-927c8120/p/example.com",
  "monetateId": "5.1982474515.1616616018101",
  "events": [
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "sample-unique-request-id-ABC-123",
      "includeReporting": false
    },
    {
      "eventType": "monetate:context:ProductThumbnailView",
      "products": [
        "product21",
        "product22",
        "product23"
      ]
    }
  ]
}
{
  "channel": "a-927c8120/p/example.com",
  "monetateId": "5.1982474515.1616616018101",
  "events": [
    {
      "eventType": "monetate:decision:DecisionRequest",
      "requestId": "sample-unique-request-id-ABC-123",
      "includeReporting": false
    },
    {
      "eventType": "monetate:context:ProductThumbnailView",
      "products": [
        "product21",
        "product22",
        "product23"
      ]
    }
  ]
}
﻿
The response appears much like the following example.
Example Omnichannel Social Proof Action Response
{
  "meta": {
    "code": 200
  },
  "data": {
    "responses": [
      {
        "requestId": "sample-unique-request-id-ABC-123",
        "actions": [
          {
            "actionType": "monetate:action:SocialProofDataV2",
            "actionId": 4185123,
            "products": [
              {
                "count": 0,
                "lookbackMinutes": 60,
                "proofType": "view",
                "productId": "product22"
              },
              {
                "count": 0,
                "lookbackMinutes": 60,
                "proofType": "view",
                "productId": "product23"
              },
              {
                "count": 0,
                "lookbackMinutes": 60,
                "proofType": "view",
                "productId": "product21"
              }
            ],
            "component": "Foo",
            "message": {
              "href": "https://{monetate_cdn}/img/1/1094/4339665.htm",
              "data": "<p>My message</p>\n"
            }
          }
        ]
      }
    ]
  }
}
{
  "meta": {
    "code": 200
  },
  "data": {
    "responses": [
      {
        "requestId": "sample-unique-request-id-ABC-123",
        "actions": [
          {
            "actionType": "monetate:action:SocialProofDataV2",
            "actionId": 4185123,
            "products": [
              {
                "count": 0,
                "lookbackMinutes": 60,
                "proofType": "view",
                "productId": "product22"
              },
              {
                "count": 0,
                "lookbackMinutes": 60,
                "proofType": "view",
                "productId": "product23"
              },
              {
                "count": 0,
                "lookbackMinutes": 60,
                "proofType": "view",
                "productId": "product21"
              }
            ],
            "component": "Foo",
            "message": {
              "href": "https://{monetate_cdn}/img/1/1094/4339665.htm",
              "data": "<p>My message</p>\n"
            }
          }
        ]
      }
    ]
  }
}
﻿
﻿
Updated 25 Sep 2024
Omnichannel Product Badging Action Request
Best Practices for Omnichannel Experiences
Docs powered by Archbee
TABLE OF CONTENTS
Request for Messages on Product Detail Pages
Request for Messages on Pages Displaying Multiple Product IDs