Use the REST APIs to build a search UI

This is for:

Developer

Search integrations with the Coveo Platform typically rely on the Coveo JavaScript Search Framework or the Atomic or Headless libraries.

If, for some legitimate reason, you can’t use the Coveo JavaScript Search Framework or the Atomic or Headless libraries in your custom search integration with the Coveo Platform, you must ensure that your own search interface implementation uses the Search API and usage analytics (UA) Write API services correctly (that is, in a similar fashion to what the Coveo JavaScript Search Framework or the Atomic or Headless libraries do). Otherwise, Coveo Usage Analytics reports may become inconsistent or incoherent across your Coveo organization, the Coveo Machine Learning service may not be able to learn and function properly, and the overall user experience may be unsatisfactory.

The articles in this section provide guidelines for implementing your own search interface, assuming that you can’t use the Coveo JavaScript Search Framework or the Atomic or Headless libraries in your custom search integration with the Coveo Platform.

Note

Contrary to convention, the search queries in these articles use the POST endpoint instead of GET. This is only done to make the documentation more readable. The POST endpoint lets users send a body parameter which contains the required properties. If GET was used for this documentation, these properties would have to be sent as distinct query parameters instead.