Index Status

Returns index status information.

The Index Status API returns the status of your text indexes.

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.

{
  "total_documents": 10,
  "total_index_size": 671331,
  "24hr_index_updates": 2,
  "component_count": 1
}

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.

Synchronous
https://api.havenondemand.com/1/api/sync/indexstatus/v1
Asynchronous
https://api.havenondemand.com/1/api/async/indexstatus/v1
Authentication

This API requires an authentication token to be supplied in the following parameter:

Parameter Description
apikey The API key to use to authenticate the API request.
Parameters

This API accepts the following parameters:

Required
Name Type Description
index
resource The name of the text index to return the status for.

This API returns a JSON response that is described by the model below. This single model is presented both as an easy to read abstract definition and as the formal JSON schema.

Asynchronous Use

Additional requests are required to get the result if this API is invoked asynchronously.

You can use /1/job/status/<job-id> to get the status of the job, including results if the job is finished.

You can also use /1/job/result/<job-id>, which waits until the job has finished and then returns the result.

Model
This is an abstract definition of the response that describes each of the properties that might be returned.
Index Status Response {
24hr_index_updates ( number ) The total number of document updates in the last 24 hours.
component_count ( number ) The total number of index components contained in the text index (Haven OnDemand creates additional components when a text index grows larger than the component quota size for the flavor).
total_documents ( number ) The total number of documents in the index.
total_index_size ( number ) The total size of the index in bytes.
flavor ( string ) The flavor of the index.
}
Model Schema
This is a JSON schema that describes the syntax of the response. See json-schema.org for a complete reference.
{
    "properties": {
        "24hr_index_updates": {
            "type": "number"
        },
        "component_count": {
            "type": "number"
        },
        "total_documents": {
            "type": "number"
        },
        "total_index_size": {
            "type": "number"
        },
        "flavor": {
            "type": "string"
        }
    },
    "required": [
        "total_documents",
        "total_index_size",
        "24hr_index_updates",
        "component_count",
        "flavor"
    ],
    "type": "object"
}


If you would like to provide us with more information then please use the box below:

We will use your submission to help improve our product.