Calling the Personalized Searc...
Personalized Category Page Queries

﻿A Personalized Category Page request to the Pesonalized Search API is similar to a Personalized Site Search request, but instead of searching for products based on a search term, a Personalized Category Page request searches for products based on products' category path(s). To send this type of request, change the value of the typeOfRequest key to "CATNAV", and then add the categoryPath key to the query object. The value of categoryPath is the search criterion the returned products must meet.
The response is also similar to a Personalized Site Search response, but it also includes the monetate_category key that indicates each record's product category.
All functions available in Personalized Site Search queries—such as pagination﻿ and facets﻿ —are available to use in Personalized Category Page queries.
Refer to Omnichannel Personalized Search Action Request﻿ for the information you must provide in an Engine API request for a Personalized Category Pages experience configured with a Personalized Search action.
POST
Request
Response
Path Params
name
String
required
The client's account (for example, "a-1db61f7a") as it appears in the value of channel used in the Engine API request to obtain the search token.
instance
String
required
The client's account environment. The value must either be "p" for production or "d" for development.
domain
String
required
The client's domain (for example, "product.monetate.me") as it appears in the value of channel used in the Engine API request to obtain the search token.
Header Parameters
Content-type
String
required
The value must be "application/json."
Body Parameters
searchToken
String
required
A token used to authenticate the search request obtained by sending a request to the Engine API. See "Obtaining a Search Token" in "Calling the Personalized Search API" for more information.
recordQueries
Object
required
The set of parameters that define a Personalized Category Pages request.
Example Personalized Category Page Request
{
  "searchToken": "Monetate-67899982122813608004"
  "recordQueries": [    
    {
      "id": "categoryProducts",
      "typeOfRequest": "CATNAV",
      "settings": {
        "query": {
          "categoryPath": "Sporting Goods;Outdoor Recreation;Camping & Hiking"
        },
        "searchPrefs": [
          "enableScores"
        ],
        "limit": 5
        "typeOfRecords": [
          "MONETATE_PRODUCT"
        ]
      }
    }
  ]
}
{
  "searchToken": "Monetate-67899982122813608004"
  "recordQueries": [    
    {
      "id": "categoryProducts",
      "typeOfRequest": "CATNAV",
      "settings": {
        "query": {
          "categoryPath": "Sporting Goods;Outdoor Recreation;Camping & Hiking"
        },
        "searchPrefs": [
          "enableScores"
        ],
        "limit": 5
        "typeOfRecords": [
          "MONETATE_PRODUCT"
        ]
      }
    }
  ]
}
Responses
200
{
  "queryResults": [    
    {
      "id": "categoryProducts",
      "meta": {
        "qTime": 9,
        "noOfResults": 5,
        "totalResultsFound": 68,
        "typeOfSearch": "AND",
        "offset": 0,
        "debuggingInformation": {},
        "notificationCode": 1,
        "searchedTerm": "*",
        "isPersonalised": false
      },
      "records": [        
        {
          "color": "orange",
          "discount": "",
          "hideGroupPrices": "",
          "itemGroupId": "8054252208375",
          "capacity": "2",
          "score": "0.057294395",
          "freeShipping": "",
          "storeBaseCurrency": "USD",
          "price": "1300",
          "toPrice": "",
          "imageUrl": "",
          "currency": "USD",
          "inStock": "yes",
          "id": "tent_006",
          "imageHover": "",
          "sku": "",
          "brand": "Summitate",
          "basePrice": "1300.0",
          "startPrice": "",
          "image": "",
          "deliveryInfo": "",
          "quantity": "23",
          "hideAddToCart": "",
          "salePrice": "1300.0",
          "swatchesInfo": "",
          "weight": "",
          "totalVariants": 0,
          "handle": "tent_006",
          "groupPrices": "",
          "isCustomOptionsAvailable": "",
          "url": "",
          "name": "Stormking tent",
          "shortDesc": "Tents",
          "category": "Tents",
          "monetate_product_boosting": "1.011",
          "monetate_category": "MONETATE_PRODUCT;;Sporting Goods;Outdoor Recreation;Camping & Hiking;Tents  @ku@kuCategory@ku@",
          "monetate_manual_boosting": "0.9",
          "searchClickToken": "Monetate-NiSc2LjE2NjIxM3AuMcNzE3MjExOyNd"
        },
        {
          ... Additional records ...
        }
      ],
      "filters": []
    }
  ]
}
{
  "queryResults": [    
    {
      "id": "categoryProducts",
      "meta": {
        "qTime": 9,
        "noOfResults": 5,
        "totalResultsFound": 68,
        "typeOfSearch": "AND",
        "offset": 0,
        "debuggingInformation": {},
        "notificationCode": 1,
        "searchedTerm": "*",
        "isPersonalised": false
      },
      "records": [        
        {
          "color": "orange",
          "discount": "",
          "hideGroupPrices": "",
          "itemGroupId": "8054252208375",
          "capacity": "2",
          "score": "0.057294395",
          "freeShipping": "",
          "storeBaseCurrency": "USD",
          "price": "1300",
          "toPrice": "",
          "imageUrl": "",
          "currency": "USD",
          "inStock": "yes",
          "id": "tent_006",
          "imageHover": "",
          "sku": "",
          "brand": "Summitate",
          "basePrice": "1300.0",
          "startPrice": "",
          "image": "",
          "deliveryInfo": "",
          "quantity": "23",
          "hideAddToCart": "",
          "salePrice": "1300.0",
          "swatchesInfo": "",
          "weight": "",
          "totalVariants": 0,
          "handle": "tent_006",
          "groupPrices": "",
          "isCustomOptionsAvailable": "",
          "url": "",
          "name": "Stormking tent",
          "shortDesc": "Tents",
          "category": "Tents",
          "monetate_product_boosting": "1.011",
          "monetate_category": "MONETATE_PRODUCT;;Sporting Goods;Outdoor Recreation;Camping & Hiking;Tents  @ku@kuCategory@ku@",
          "monetate_manual_boosting": "0.9",
          "searchClickToken": "Monetate-NiSc2LjE2NjIxM3AuMcNzE3MjExOyNd"
        },
        {
          ... Additional records ...
        }
      ],
      "filters": []
    }
  ]
}
﻿
﻿
Updated 24 Mar 2025
Personalized Site Search Queries
Retrieve and Apply Facets