The API Explorer tab
Describes the API Explorer tab where you can make JSON requests for the Sitecore Search Search and Recommendation API.
The API Explorer tab on the Developer Resources page of Sitecore Search Customer Engagement Console (CEC) is where developers create and run requests against their data. It is a live and interactive way of working with the search and recommendation API. This topic describes some of the many ways you can use this tool.
The API Explorer tab is divided into three panes: the Builder pane, the Request pane, and the Response pane.
In the Builder pane, you can enter or select values for the various objects of a Search and Recommendation REST API request.
Your Sitecore Search implementation is configured for pages where each page has widgets that meet your requirements. The URL or the URL pattern configured for a page in the CEC determines its content. When you select a page, its configured URL or URL pattern is set in the URL input field of the Builder pane.
The API Explorer cannot build API requests made by preview search widgets because they are not contained on pages. The Builder can only build API requests for pages.
To see your REST request, click Build. The request is displayed in the Request pane.
To clear all values in the builder pane, click Reset .
In this pane, your REST request is displayed in JSON format. An error indicates the values you must set or update if the request is missing any values relevant to your query. You can edit the JSON directly in this pane.
Click at the top-right of the pane to increase its size.
To export the request, click Copy to Clipboard and select from the following options:
Copy as cURL using Sitecore host
Copy as cURL using your subdomain
Copy as data object
The API attempts to not fail and returns the next best set of results based on information available. You get results for a request that indicated missing or incorrect values.
To test your request, click Run. The response is displayed in the Response pane.
The JSON response to your request is displayed in this pane. You can scaffold the JSON to see the structure and verify the response. To export the response, click Copy to Clipboard and then click Copy as data object.