Getting Started with the Indexing API

This tutorial will guide you through the first steps of using the Indexing API. Here you will learn how to add a document in the …

API API Reference Indexing

Report user event

POST /v1/stats/{index public key} Reports search and click events. Payload for a click event Payload for a search event Search event parameters Click event parameters …

API Reference

Analytics Dashboard

With the Analytics Dashboard, you have access to tables and data visualizations of your users’ search queries and behaviors. Below is a glossary of terms …

Analytics Dashboard

Get Search Results

Please note that this page has noindex, nofollow GET /v1/search/{index public key} Retrieve search results from the index. Required Query Parameter Optional Query Parameters Example …

API Reference

Search UI Library Components

AddSearch Search UI Library consists of components you can use to create a search UI for your website. All components are visual with dedicated functionalities …

Search UI Library

Voice Search

Modern web browsers and devices have some built-in support for Speech Recognition. With this functionality, it’s easy to add voice search to your website. Currently, …

Search UI

Delete Batch of Documents

DELETE /v2/indices/{index public key}/documents:batch Remove multiple documents from the index. Payload The payload includes a list of document ids in an array. Response On successful …

API Reference

Delete Document

DELETE /v2/indices/{index public key}/documents/{document id} Remove a document from the index. Response On successful queuing of the delete operation, the endpoint returns an HTTP 202.

API Reference

Batch Update Documents

PUT /v2/indices/{index public key}/documents:batch Update a batch of documents or create new documents with predefined ids. Payload The request body should be a JSON object, …

API Reference