Instant Engage
Overview
Instant Engage is a feature that leverages the Autocomplete API to provide immediate search suggestions before the user start typing. When an Autocomplete API request is made with an empty keyword parameter, the system automatically returns Instant Engage results, which may include trending categories, products, and keywords based on your configuration.
Request
The Instant Engage uses the same endpoint and parameters as the Autocomplete API. To get results for Instant Engage, make an request with an Autocomplete request with and empty keyword. For all the parameters including in Autocomplete request, please refer to this documentation.
{
"ClientGuid" : "xxxxxxxxxxxxxx",
"Keyword" : "",
}
Response
The response structure matches the Autocomplete API format but focusses and Instant Engage results rather than keyword-matched results. Key sections could include:
{
"Count": 0,
"ContentCount": 0,
"ProductCount": 0,
"Categories": [
{
"Value": "3-in-1 Jackets",
"Url": "https://preview-dev.hawksearch.net/elasticdemo?category=3-in-1%20Jackets&prv=1",
"FieldQSName": "category",
"FieldQSValue": "3-in-1%20Jackets",
"IsRecommended": true
},
{
"Value": "Accessories",
"Url": "https://preview-dev.hawksearch.net/elasticdemo?category=Accessories&prv=1",
"FieldQSName": "category",
"FieldQSValue": "Accessories",
"IsRecommended": true
}
{
"Value": "Backpacking",
"Url": "https://preview-dev.hawksearch.net/elasticdemo?category=Backpacking&prv=1",
"FieldQSName": "category",
"FieldQSValue": "Backpacking",
"IsRecommended": true
}
],
"Products": [
{
"ProductName": "Thermax Headliner",
"Sku": "",
"Thumb": {
"Url": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/{3E10155A-571E-474D-A18E-F52528D5AC5A}.jpg",
"AltText": ""
},
"Url": "https://preview-dev.hawksearch.net/elasticdemo/details?itemid=Item_77478",
"Html": "<div class=\"hawk-sqItemImage\" ><img class='hawk-sqItemImage-thumb' src='https://dev.hawksearch.net/assets/1/14/DimThumbnail/{3E10155A-571E-474D-A18E-F52528D5AC5A}.jpg' alt='' /></div>\r\n<div class=\"hawk-sqItemContent\">\r\n<h1 class=\"hawk-sqItemName\">Thermax Headliner</h1>",
"Results": {
"Score": 0.0,
"Document": {
"brand": [
"Seirus"
],
"image": [
"https://dev.hawksearch.net/assets/1/14/DimThumbnail/{3E10155A-571E-474D-A18E-F52528D5AC5A}.jpg"
],
"it": [
"item"
],
"url": [
"/details?itemid=Item_77478"
],
"itemname": [
"Thermax Headliner"
],
"isonsale": [
"No"
],
"itemtypeid": [
"3"
],
"saleprice": [
"+0000000000000015.9900"
],
"rating": [
"+0000000000000001.0000"
],
"color-property": [
"Black"
],
"createdate": [
"2024-04-21T06:27:10"
],
"type": [
"Item"
],
"category": [
"Hats & Headwear",
"Accessories ",
"Hats & headwear",
"Kids",
"Headbands",
"Balaclavas"
],
"ratingrange": [
"+0000000000000001.0000"
],
"content": [
"thermax headliner <div class="descwrpr"><div class="descsubwrpr"><h2>product description</h2><br><p>this ultra-thin balaclava fits easily under a helmet and is easy to pack along as a lightweight insulating layer.&nbsp;the thin wicking head, face, neck warmer has&nbsp;ultra-thin thermax® wicking, warmth dryness, and the wicking comfort seals out the cold.<br>&nbsp;</p></div></div> summer sale summer sale women summer sale women hats & headwear summer sale women accessories summer sale men hats & headwear balaclavas men accessories hats & headwear women accessories hats & headwear specials sat dec 15th kids men hats & headwear headbands men hats & headwear balaclavas women hats & headwear balaclavas seirus youth black "
],
"id": [
"Item_77478"
],
"price": [
"+0000000000000015.9900"
],
"size-property": [
"Youth"
],
"titlecopy": [
"Thermax Headliner"
],
"imagealttag": [
"14554"
],
"department_nest": [
"1|Women",
"2|Women/Hats & Headwear",
"3|Women/Hats & Headwear/Balaclavas",
"1|Men",
"2|Men/Hats & Headwear",
"3|Men/Hats & Headwear/Balaclavas",
"3|Men/Hats & Headwear/Headbands",
"1|Specials",
"2|Specials/Sat Dec 15th",
"3|Specials/Sat Dec 15th/Kids",
"2|Women/Accessories",
"3|Women/Accessories/Hats & Headwear",
"2|Men/Accessories",
"3|Men/Accessories/Hats & headwear",
"1|Summer Sale",
"2|Summer Sale/Men",
"3|Summer Sale/Men/Hats & Headwear",
"2|Summer Sale/Women",
"3|Summer Sale/Women/Accessories ",
"3|Summer Sale/Women/Hats & Headwear"
],
"longdescription": [
" Product Description This ultra-thin balaclava fits easily under a helmet and is easy to pack along as a lightweight insulating layer. The thin wicking head, face, neck warmer has Ultra-thin THERMAX® wicking, warmth dryness, and the wicking comfort seals out the cold. "
],
"sku": [
"\r\n "
],
"subdepartmentpath": [
"1|Summer Sale",
"1|Men",
"1|Women",
"1|Specials"
]
},
"IsPin": false
},
"IsRecommended": true
},
{
"ProductName": "Girls NosiLife Nisa T-Shirt",
"Sku": "",
"Thumb": {
"Url": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Craghoppers-Girls-Nosilife-Nisa-T-Shirt-Blue.jpg",
"AltText": ""
},
"Url": "https://preview-dev.hawksearch.net/elasticdemo/details?itemid=Item_161786",
"Html": "<div class=\"hawk-sqItemImage\" ><img class='hawk-sqItemImage-thumb' src='https://dev.hawksearch.net/assets/1/14/DimThumbnail/Craghoppers-Girls-Nosilife-Nisa-T-Shirt-Blue.jpg' alt='' /></div>\r\n<div class=\"hawk-sqItemContent\">\r\n<h1 class=\"hawk-sqItemName\">Girls NosiLife Nisa T-Shirt</h1>",
"Results": {
"Score": 0.0,
"Document": {
"brand": [
"Craghoppers"
],
"image": [
"https://dev.hawksearch.net/assets/1/14/DimThumbnail/Craghoppers-Girls-Nosilife-Nisa-T-Shirt-Blue.jpg"
],
"it": [
"item"
],
"url": [
"/details?itemid=Item_161786"
],
"itemname": [
"Girls NosiLife Nisa T-Shirt"
],
"isonsale": [
"Yes"
],
"itemtypeid": [
"3"
],
"saleprice": [
"+0000000000000020.9700"
],
"rating": [
"+0000000000000004.0000"
],
"createdate": [
"2024-10-17T22:14:37"
],
"type": [
"Item"
],
"category": [
"Girls 5-20",
"Kids",
"Shirts"
],
"ratingrange": [
"+0000000000000004.0000"
],
"content": [
"girls nosilife nisa t-shirt <div class="descwrpr"><div class="descsubwrpr"><h2>product description</h2><br><p>gorgeous long-sleeved tee in pretty pastels for a summer of outdoor fun.<br><br>with built-in sun protection and permanent insect repellent, nisa t-shirt offers outstanding performance in hot, humid conditions.<br><br>these hot-climate tees are ready for the trail. uncompromising performance from nosilife insect-repellent and sun-protective fabric, wonderful t-shirts, designed for humid conditions.</p></div></div> sale summer sale summer sale kids summer sale kids girls 5-20 summer sale kids girls 5-20 shirts bug repellent clothing & gear summer clearance specials sat dec 15th kids specials sun dec 23rd girls 5-20 shirts kids girls 5-20 kids girls 5-20 shirts craghoppers 9-10 yr 13-14 yr "
],
"id": [
"Item_161786"
],
"price": [
"+0000000000000035.0000"
],
"size-property": [
"9-10 YR",
"13-14 YR"
],
"titlecopy": [
"Girls NosiLife Nisa T-Shirt"
],
"imagealttag": [
"Craghoppers-Girls-Nosilife-Nisa-T-Shirt-Blue"
],
"department_nest": [
"1|Kids",
"2|Kids/Girls 5-20",
"3|Kids/Girls 5-20/Shirts",
"1|Specials",
"2|Specials/Sun Dec 23rd",
"3|Specials/Sun Dec 23rd/Girls 5-20",
"2|Specials/Sat Dec 15th",
"3|Specials/Sat Dec 15th/Kids",
"1|Summer Sale",
"2|Summer Sale/Kids",
"3|Summer Sale/Kids/Girls 5-20"
],
"longdescription": [
" Product Description Gorgeous long-sleeved tee in pretty pastels for a summer of outdoor fun. With built-in sun protection and permanent insect repellent, Nisa T-shirt offers outstanding performance in hot, humid conditions. These hot-climate tees are ready for the trail. Uncompromising performance from NosiLife insect-repellent and sun-protective fabric, wonderful t-shirts, designed for humid conditions. "
],
"sku": [
"\r\n "
],
"subdepartmentpath": [
"1|Sale",
"1|Summer Sale",
"1|Bug Repellent Clothing & Gear",
"1|Summer Clearance",
"1|Specials",
"1|Kids"
]
},
"IsPin": false
},
"IsRecommended": true
},
{
"ProductName": "Boys Crave The Waves Easy SS Tee Junior 42099",
"Sku": "",
"Thumb": {
"Url": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/LIG-Boys-Easy-Tee-Crave-The-Waves_42099_1_lg1.jpg",
"AltText": ""
},
"Url": "https://preview-dev.hawksearch.net/elasticdemo/details?itemid=Item_161646",
"Html": "<div class=\"hawk-sqItemImage\" ><img class='hawk-sqItemImage-thumb' src='https://dev.hawksearch.net/assets/1/14/DimThumbnail/LIG-Boys-Easy-Tee-Crave-The-Waves_42099_1_lg1.jpg' alt='' /></div>\r\n<div class=\"hawk-sqItemContent\">\r\n<h1 class=\"hawk-sqItemName\">Boys Crave The Waves Easy SS Tee Junior 42099</h1>",
"Results": {
"Score": 0.0,
"Document": {
"brand": [
"Life is Good"
],
"image": [
"https://dev.hawksearch.net/assets/1/14/DimThumbnail/LIG-Boys-Easy-Tee-Crave-The-Waves_42099_1_lg1.jpg"
],
"it": [
"item"
],
"url": [
"/details?itemid=Item_161646"
],
"itemname": [
"Boys Crave The Waves Easy SS Tee Junior 42099"
],
"isonsale": [
"Yes"
],
"itemtypeid": [
"3"
],
"saleprice": [
"+0000000000000007.9700"
],
"rating": [
"+0000000000000004.5000"
],
"color-property": [
"Green"
],
"createdate": [
"2024-02-27T12:22:28"
],
"type": [
"Item"
],
"category": [
"Shirts",
"Boys 5-20",
"Casual Shirts",
"Kids"
],
"ratingrange": [
"+0000000000000004.5000"
],
"content": [
"boys crave the waves easy ss tee junior 42099 <div class="descwrpr"><div class="descsubwrpr"><h2>product description</h2><br><p>surfs up!!!&nbsp; have to wear the latest life is good tee. great alll around t-shirt for boys.<br><br>wear-with-anything tees that make a statement, life is good boys' apparel is the very picture of pint-sized positivity.<br><br>from wear-with-anything tees to socks that make a statement, life is good boys' apparel is the very picture of pint-sized positivity.</p></div></div> kids kids boys 5-20 kids boys 5-20 shirts sale summer sale summer sale kids summer sale kids boys 5-20 summer sale kids boys 5-20 shirts men shirts casual shirts short sleeve-test specials sat dec 15th kids specials sun dec 23rd boys 5-20 shirts summer clearance life is good l green "
],
"id": [
"Item_161646"
],
"price": [
"+0000000000000016.0000"
],
"size-property": [
"L"
],
"titlecopy": [
"Boys Crave The Waves Easy SS Tee Junior 42099"
],
"imagealttag": [
"LIIG-Boys-Easy-Tee-Crave-The-Waves_42099"
],
"department_nest": [
"1|Specials",
"2|Specials/Sun Dec 23rd",
"3|Specials/Sun Dec 23rd/Boys 5-20",
"2|Specials/Sat Dec 15th",
"3|Specials/Sat Dec 15th/Kids",
"1|Men",
"2|Men/Shirts",
"3|Men/Shirts/Casual Shirts",
"1|Summer Sale",
"2|Summer Sale/Kids",
"3|Summer Sale/Kids/Boys 5-20",
"1|Kids",
"2|Kids/Boys 5-20",
"3|Kids/Boys 5-20/Shirts"
],
"longdescription": [
" Product Description Surfs up!!! Have to wear the latest LIfe Is Good tee. Great alll around t-shirt for boys. Wear-with-anything tees that make a statement, Life Is Good boys' apparel is the very picture of pint-sized positivity. From wear-with-anything tees to socks that make a statement, Life Is Good boys' apparel is the very picture of pint-sized positivity. "
],
"sku": [
"\r\n "
],
"subdepartmentpath": [
"1|Kids",
"1|Sale",
"1|Summer Sale",
"1|Men",
"1|Specials",
"1|Summer Clearance"
]
},
"IsPin": false
},
"IsRecommended": true
}
],
"Content": [],
"Popular": [],
"SearchWebsiteUrl": "https://preview-dev.hawksearch.net/elasticdemo",
"KeywordField": "keyword",
"CategoryHeading": "Top Product Categories",
"ContentHeading": "Top Content Match",
"ProductHeading": "Top 3 Matches",
"PopularHeading": "Popular Searches",
"ViewAllButtonLabel": "View All Matches",
"DymProductsSearch": [],
"DYMProductHeading": "Did You Mean?",
"DYMContentHeading": "Did You Mean?"
}
Updated 4 months ago