Analytics Dashboard

With the Analytics dashboard, you have access to tables and data visualizations of your users’ search queries and behaviors. Overview The Overview section of the …

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 Query Parameter

A search query parameter is a segment of a search query URL which appears on a separate results page after a question mark (eg. `search.html?addsearch=keyword`). …

Dashboard Ready-made View

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

Update Existing Document

PUT /v2/indices/{index public key}/documents/{document id} Update existing document, or create a new document with predefined URL or ID. PUT /v2/indices/{index public key}/documents/ Omit the document …

API Reference

Create New Document

POST /v2/indices/{index public key}/documents/ Create a new document to the index. By default, the Documents API endpoint creates a random id for each new document. …

API Reference

Get Document Contents

GET /v2/indices/{index public key}/documents/{document id} Retrieve the content of a single document from the index. Response

API Reference