Index Status

Returns index status information.

You can use this API to understand your data set contents, and to check whether you are approaching the maximum values for a given flavor.

Quick Start

For any index created using the Create Text Index API, the Index Status API returns information about the index.

/1/api/[async|sync]/indexstatus/v1?index=myindex

The JSON response includes details of the number of documents in the index, the total size of the index (in bytes), and the number of documents that have been added or updated in the last 24 hours. It also includes information about the number of index components that make up the index.

Note: An index component is a segment of the whole text index. The size of an index component is determined by the flavor of the text index. For more information about the different flavors, see Index Flavors. When a text index exceeds the quota size for the index component flavor, Haven OnDemand creates a new component for that text index, as long as you have sufficient available units available for your account. For more information about text index quotas, see Rate Limiting, Quotas, Data Expiry, and Maximums.

Note: It can take up to 60 seconds for the Index Status results to reflect changes to your text index, such as new or deleted documents.

Haven OnDemand uses cookies to enhance and improve the experience it provides. By continuing to use this site or pressing Continue,
we will assume that you accept receiving all cookies. If you would like to change which cookies are set, you can change your settings.