Get Service Statistics - Get Service Statistics

Service:

Search Service

API Version:

2025-11-01-preview

Gets service level statistics for a search service.

GET https:///servicestats?api-version=2025-11-01-preview

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
Accept	True	Accept	The Accept header.
x-ms-client-request-id		string (uuid)	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
200 OK	SearchServiceStatistics	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://search.azure.com/.default

Examples

SearchServiceGetS3HDUnlimitedServiceStatistics

SearchServiceGetServiceStatistics

SearchServiceGetS3HDUnlimitedServiceStatistics

Sample request

HTTP

GET https:///servicestats?api-version=2025-11-01-preview

Sample response

Status code:

200

{
  "counters": {
    "documentCount": {
      "usage": 12
    },
    "indexesCount": {
      "usage": 2,
      "quota": 2
    },
    "indexersCount": {
      "usage": 2,
      "quota": 2
    },
    "dataSourcesCount": {
      "usage": 2,
      "quota": 2
    },
    "storageSize": {
      "usage": 123456,
      "quota": 10485760
    },
    "synonymMaps": {
      "usage": 3,
      "quota": 3
    },
    "skillsetCount": {
      "usage": 2,
      "quota": 2
    },
    "aliasesCount": {
      "usage": 4,
      "quota": 4
    },
    "vectorIndexSize": {
      "usage": 123456
    }
  },
  "indexersRuntime": {
    "usedSeconds": 0,
    "remainingSeconds": 86400,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "limits": {
    "maxStoragePerIndex": 10485760,
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 40,
    "maxComplexObjectsInCollectionsPerDocument": 3000,
    "maxCumulativeIndexerRuntimeSeconds": 86400
  }
}

SearchServiceGetServiceStatistics

Sample request

HTTP

GET https:///servicestats?api-version=2025-11-01-preview

Sample response

Status code:

200

{
  "counters": {
    "documentCount": {
      "usage": 12
    },
    "indexesCount": {
      "usage": 2,
      "quota": 2
    },
    "indexersCount": {
      "usage": 2,
      "quota": 2
    },
    "dataSourcesCount": {
      "usage": 2,
      "quota": 2
    },
    "storageSize": {
      "usage": 123456,
      "quota": 10485760
    },
    "synonymMaps": {
      "usage": 3,
      "quota": 3
    },
    "skillsetCount": {
      "usage": 2,
      "quota": 2
    },
    "aliasesCount": {
      "usage": 4,
      "quota": 4
    },
    "vectorIndexSize": {
      "usage": 123456
    }
  },
  "indexersRuntime": {
    "usedSeconds": 0,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "limits": {
    "maxStoragePerIndex": 10485760,
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 40,
    "maxComplexObjectsInCollectionsPerDocument": 3000
  }
}

Definitions

Name	Description
Accept	The Accept header.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
ResourceCounter	Represents a resource's usage and quota.
SearchServiceCounters	Represents service-level resource counters and quotas.
SearchServiceLimits	Represents various service level limits.
SearchServiceStatistics	Response from a get service statistics request. If successful, it includes service level counters and limits.
ServiceIndexersRuntime	Represents service-level indexer runtime counters.

Accept

Enumeration

The Accept header.

Value	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info		The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error	ErrorDetail	The error object.

ResourceCounter

Object

Represents a resource's usage and quota.

Name	Type	Description
quota	integer (int64)	The resource amount quota.
usage	integer (int64)	The resource usage amount.

SearchServiceCounters

Object

Represents service-level resource counters and quotas.

Name	Type	Description
aliasesCount	ResourceCounter	Total number of aliases.
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.

SearchServiceLimits

Object

Represents various service level limits.

Name	Type	Description
maxComplexCollectionFieldsPerIndex	integer (int32)	The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.
maxComplexObjectsInCollectionsPerDocument	integer (int32)	The maximum number of objects in complex collections allowed per document.
maxCumulativeIndexerRuntimeSeconds	integer (int64)	The maximum cumulative indexer runtime in seconds allowed for the service.
maxFieldNestingDepthPerIndex	integer (int32)	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 (int32)	The maximum allowed fields per index.
maxStoragePerIndex	integer (int64)	The maximum amount of storage in bytes allowed per index.

SearchServiceStatistics

Object

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

Name	Type	Description
counters	SearchServiceCounters	Service level resource counters.
indexersRuntime	ServiceIndexersRuntime	Service level indexer runtime consumption.
limits	SearchServiceLimits	Service level general limits.

ServiceIndexersRuntime

Object

Represents service-level indexer runtime counters.

Name	Type	Description
beginningTime	string (date-time)	Beginning UTC time of the 24-hour period considered for indexer runtime usage (inclusive).
endingTime	string (date-time)	End UTC time of the 24-hour period considered for indexer runtime usage (inclusive).
remainingSeconds	integer (int64)	Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds.
usedSeconds	integer (int64)	Cumulative runtime of all indexers in the service from the beginningTime to endingTime, in seconds.