Get Index Statistics (Azure Search Service REST API)

The Get Index Statistics operation returns from Azure Search a document count for the current index, plus storage usage. You can also get this information from the portal.

Note

Statistics on document count and storage size are collected every few minutes, not in real time. Therefore, the statistics returned by this API may not reflect changes caused by recent indexing operations.

Request

HTTPS is required for all services requests. The Get Index Statistics request can be constructed using the GET method.

GET https://[service name].search.windows.net/indexes/[index name]/stats?api-version=[api-version]  
api-key: [admin key]  

The [index name] in the request URI tells the service to return index statistics for the specified index.

The [api-version] is required. The current version is 2019-05-06. See API versions in Azure Search for details.

Request Headers

The following list describes the required and optional request headers.

Request Header Description
Content-Type: Required. Set this to application/json.
api-key: Required. The api-key is used to authenticate the request to your Search service. It is a string value, unique to your service. The Get Index Statistics request must include an api-key header set to your admin key (as opposed to a query key).

You will also need the service name to construct the request URL. You can get both the service name and api-key from your service dashboard in the Azure portal. See Create an Azure Search services for details.

Request Body

None.

Response

Status Code: "200 OK" is returned for a successful response.The response body is in the following format:

{  
  "documentCount": number,  
  "storageSize": number (size of the index in bytes)  
}  

See also

Azure Search Service REST
API versions in Azure Search