Querying with a keyphrase
Add a widget.items.search.query object and pass the keyphrase key in your request to show results that are relevant to a keyphrase.
For the data model of this object, see the Search and Recommendation API reference.
The following is an example request for a query with the keyphrase symposium:
RequestResponse
{
"widget": {
"items": [
{
"rfk_id": "rfkid_7",
"entity": "content",
"search": {
"content": {},
"query": {
"keyphrase": "symposium"
}
}
}
]
},
"context": {
"locale": {
"country": "us",
"language": "en"
}
}
}The following is a sample response to the request:
RequestResponse
{
"widgets": [
{
"rfk_id": "rfkid_7",
"entity": "content",
"content": [
{
"description": "This event is now over. \nPlease visit News and Events to catch up with the latest from Sitecore. \nOr, visit our Knowledge Center for our blog, articles, and more helpful resources. Are you looking to grow revenue, drive customer experience and lead digital innovation? Marketing Symposium/Xpo offers a destination to interact with Gartner research experts, fellow marketers, and technology and solution providers to help you explore new thinking and answer tough questions. The rigorous methodologies and objective point of view cut through the hype to dive deeper into the areas that matter most to you.Read More: https://www.gartner.com/en/conferences/na/marketing-symposium-usWhen\n\n\n\n \n Monday, April 29, 2019 3:00 PM\n \nto \n Thursday, May 2, 2019 12:00 AM\n Where\nSan Diego, CA",
"id": "https___www_sitecore_com_company_news-events_events_2019_04_gartner-marketing-symposium-xpo",
"image_type": "Image",
"last_modified": "2022-01-24 21:55:23Z",
"source_id": "407033",
"subtitle": null,
"title": "Gartner Marketing Symposium/Xpo",
"type": "Events",
"url": "https://www.sitecore.com/company/news-events/events/2019/04/gartner-marketing-symposium-xpo"
},
{
"description": "This event is now over. \nPlease visit News and Events to catch up with the latest from Sitecore. \nOr, visit our Knowledge Center for our blog, articles, and more helpful resources. Join over 250 energy professionals to discuss the latest industry trends and best practices in corporate and customer services. The diverse mix of presentations, Q&A panels, roundtable discussions and networking allow attendees to share their experiences and develop contacts throughout the industry.Read More: https://www.westernenergy.org/programs/customer-corporate-symposium-3/When\n\n\n\n \n Wednesday, March 13, 2019 6:00 PM\n \nto \n Saturday, March 16, 2019 12:00 AM\n Where\nHollywood, CA",
"id": "https___www_sitecore_com_company_news-events_events_2019_03_western-energy-institute-symposium",
"image_type": "Image",
"last_modified": "2022-01-24 21:55:22Z",
"source_id": "407033",
"subtitle": null,
"title": "Western Energy Institute Symposium",
"type": "Events",
"url": "https://www.sitecore.com/company/news-events/events/2019/03/western-energy-institute-symposium"
},
{
"description": "Unforgettable Digital Connections...",
"id": "https___www_sitecore_com_landing_uk_2022_wt-london-2022",
"image": "https://wwwsitecorecom.azureedge.net/-/media/sitecoresite/images/home/landing/uk/2022/london-wt/croplondonwt.png?md=20220609T131910Z",
"image_url": "https://wwwsitecorecom.azureedge.net/-/media/sitecoresite/images/home/landing/uk/2022/london-wt/croplondonwt.png?mw=800&md=20220609T131910Z&hash=4B4E3F5E608A3CB3D14BA0C46FC22C4C&t=544x310",
"last_modified": "2022-06-10 11:57:00Z",
"source_id": "407033",
"subtitle": "Here’s your chance to recap the sessions and hear from our real-world visionaries, industry rule-breakers, and thought-mavericks – for a limited time only.",
"title": "Symposium World Tour – London",
"type": "Others",
"url": "https://www.sitecore.com/landing/uk/2022/wt-london-2022"
}
...
],
"total_item": 157,
"limit": 10,
"offset": 0
}
],
"dt": 55,
"ts": 1669435639321
}In the response content array, you see content that is relevant to the symposium keyword.