Splunk · Schema

SearchResults

AnalyticsData AnalysisLoggingMachine DataMonitoringObservabilityPlatformSecuritySIEM

Properties

Name Type Description
init_offset integer Starting offset of results
results array Array of result rows
fields array Metadata about the fields in the results
messages array
preview boolean Whether results are preview (partial) results
highlighted object Highlighted terms in results
View JSON Schema on GitHub

JSON Schema

splunk-enterprise-rest-search-results-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SearchResults",
  "type": "object",
  "properties": {
    "init_offset": {
      "type": "integer",
      "description": "Starting offset of results"
    },
    "results": {
      "type": "array",
      "description": "Array of result rows"
    },
    "fields": {
      "type": "array",
      "description": "Metadata about the fields in the results"
    },
    "messages": {
      "type": "array"
    },
    "preview": {
      "type": "boolean",
      "description": "Whether results are preview (partial) results"
    },
    "highlighted": {
      "type": "object",
      "description": "Highlighted terms in results"
    }
  }
}