Get Service Statistics - Get Service Statistics

Reference

Service:: Search Service

API Version:: 2023-11-01

Gets service level statistics for a search service.

GET {endpoint}/servicestats?api-version=2023-11-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The endpoint URL of the search service.
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	ServiceStatistics
Other Status Codes	SearchError	Error response.

Examples

SearchServiceGetServiceStatistics

Sample Request

HTTP

GET https://myservice.search.windows.net/servicestats?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "counters": {
    "documentCount": {
      "usage": 7093,
      "quota": 10000
    },
    "indexesCount": {
      "usage": 3,
      "quota": 3
    },
    "indexersCount": {
      "usage": 3,
      "quota": 3
    },
    "dataSourcesCount": {
      "usage": 1,
      "quota": 3
    },
    "storageSize": {
      "usage": 914529,
      "quota": 52428800
    },
    "synonymMaps": {
      "usage": 2,
      "quota": 3
    },
    "vectorIndexSize": {
      "usage": 123456,
      "quota": 26214400
    }
  },
  "limits": {
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 100,
    "maxComplexObjectsInCollectionsPerDocument": 3000
  }
}

Definitions

Name	Description
ResourceCounter	Represents a resource's usage and quota.
SearchError	Describes an error condition for the API.
ServiceCounters	Represents service-level resource counters and quotas.
ServiceLimits	Represents various service level limits.
ServiceStatistics	Response from a get service statistics request. If successful, it includes service level counters and limits.

ResourceCounter

Represents a resource's usage and quota.

Name	Type	Description
quota	integer	The resource amount quota.
usage	integer	The resource usage amount.

SearchError

Describes an error condition for the API.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	SearchError[]	An array of details about specific errors that led to this reported error.
message	string	A human-readable representation of the error.

ServiceCounters

Represents service-level resource counters and quotas.

Name	Type	Description
dataSourcesCount	ResourceCounter	Total number of data sources.
documentCount	ResourceCounter	Total number of documents across all indexes in the service.
indexersCount	ResourceCounter	Total number of indexers.
indexesCount	ResourceCounter	Total number of indexes.
skillsetCount	ResourceCounter	Total number of skillsets.
storageSize	ResourceCounter	Total size of used storage in bytes.
synonymMaps	ResourceCounter	Total number of synonym maps.
vectorIndexSize	ResourceCounter	Total memory consumption of all vector indexes within the service, in bytes.

ServiceLimits

Represents various service level limits.

Name	Type	Description
maxComplexCollectionFieldsPerIndex	integer	The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.
maxComplexObjectsInCollectionsPerDocument	integer	The maximum number of objects in complex collections allowed per document.
maxFieldNestingDepthPerIndex	integer	The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3.
maxFieldsPerIndex	integer	The maximum allowed fields per index.

ServiceStatistics

Response from a get service statistics request. If successful, it includes service level counters and limits.

Name	Type	Description
counters	ServiceCounters	Service level resource counters.
limits	ServiceLimits	Service level general limits.

Share via