Edit

Share via

searchHitsContainer 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.

Represent the list of search results.

Properties

Property Type Description
hits searchHit collection A collection of the search results.
moreResultsAvailable Boolean Provides information if more results are available. Based on this information, you can adjust the from and size properties of the searchRequest accordingly.
total Int32 The total number of results. Note this is not the number of results on the page, but the total number of results satisfying the query.
aggregations searchAggregation collection Contains the collection of aggregations computed based on the provided aggregationOption specified in the request.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "hits": [{"@odata.type": "microsoft.graph.searchHit"}],
  "moreResultsAvailable": true,
  "total": 1024,
  "aggregations": [{"@odata.type": "microsoft.graph.searchAggregation"}]
}