Indexes - Get Statistics

Returns statistics for the given index, including a document count and storage usage.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2024-07-01

URI Parameters

Name In Required Type Description
endpoint
path True

string

The endpoint URL of the search service.

indexName
path True

string

The name of the index for which to retrieve statistics.

api-version
query True

string

Client Api Version.

Request Header

Name Required Type Description
x-ms-client-request-id

string

uuid

The tracking ID sent with the request to help with debugging.

Responses

Name Type Description
200 OK

GetIndexStatisticsResult

Other Status Codes

ErrorResponse

Error response.

Examples

SearchServiceGetIndexStatistics

Sample request

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2024-07-01

Sample response

{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

GetIndexStatisticsResult

Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

GetIndexStatisticsResult

Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.

Name Type Description
documentCount

integer

The number of documents in the index.

storageSize

integer

The amount of storage in bytes consumed by the index.

vectorIndexSize

integer

The amount of memory in bytes consumed by vectors in the index.