Implementing a Search Interface

Search integrations with the Coveo Cloud platform typically rely on the Coveo JavaScript Search Framework. This open-source, component-based framework allows developers to easily customize and deploy feature-rich, client-side search interfaces in any web page, site, or application. The Coveo for Salesforce, Coveo for Sitecore, and Coveo for Microsoft Dynamics integrations all rely heavily on the Coveo JavaScript Search Framework.

If, for some legitimate reason, you cannot use the Coveo JavaScript Search Framework in your custom search integration with the Coveo Cloud platform, you must ensure that your own search interface implementation uses the Search API and Usage Analytics Write API services correctly (i.e., in a similar fashion to what the Coveo JavaScript Search Framework does). Otherwise, usage analytics reports may become inconsistent/incoherent across your Coveo Cloud organization, the Coveo Machine Learning service may not be able to learn and function properly, and the overall end user experience may be unsatisfactory.

The articles in this section provide guidelines for properly implementing your own search interface, assuming that you cannot use the Coveo JavaScript Search Framework in your custom search integration with the Coveo Cloud platform.

These topics contain examples of search queries where the POST endpoint is used instead of the GET one, contrary to convention. We do so entirely for readability purposes, as the POST endpoint enables users to send a body parameter containing the required properties. If GET was used, those properties would have to be sent as distinct query parameters, which would make for very clumsy documentation.

People also viewed