Microsoft Graph · Schema

searchHitsContainer

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name Type Description
aggregations array
hits array 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 number The total number of results. Note this isn't the number of results on the page, but the total number of results satisfying the query.
@odata.type string
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphsearchhitscontainer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.searchHitsContainer",
  "title": "searchHitsContainer",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "aggregations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.searchAggregation"
      }
    },
    "hits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.searchHit"
      },
      "description": "A collection of the search results."
    },
    "moreResultsAvailable": {
      "type": "boolean",
      "description": "Provides information if more results are available. Based on this information, you can adjust the from and size properties of the searchRequest accordingly.",
      "nullable": true
    },
    "total": {
      "maximum": 2147483647,
      "minimum": -2147483648,
      "type": "number",
      "description": "The total number of results. Note this isn't the number of results on the page, but the total number of results satisfying the query.",
      "format": "int32",
      "nullable": true
    },
    "@odata.type": {
      "type": "string"
    }
  }
}