Edit

Share via

searchBucket resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a container for one or more search results that share the same value for the entity field that aggregates them.

Properties

Property Type Description
aggregationFilterToken String A token containing the encoded filter to aggregate search matches by the specific key value. To use the filter, pass the token as part of the aggregationFilter property in a searchRequest object, in the format "{field}:\"{aggregationFilterToken}\"". See an example.
count Int32 The approximate number of search matches that share the same value specified in the key property. Note that this number is not the exact number of matches.
key String The discrete value of the field that an aggregation was computed on.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "key": "String",
  "count": "10",  
  "aggregationFilterToken": "String"
}