Get query results

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

string

required

The query profile ID.

Query Parameters

string

required

The query terms, using the Solr query language.

params

object

Additional Solr query parameters. The parameters of the query request.

Show child attributes

params.all

object

Show child attributes

params.all.{key}

string

params.empty

boolean

params.{key}

string[]

Response

The search response.

spellcheck

object

Spellcheck results.

Show child attributes

spellcheck.suggestions

object

Show child attributes

spellcheck.suggestions.{key}

object

A suggested spelling correction for a query term.

Show child attributes

spellcheck.suggestions.{key}.numFound

integer<int32>

The number of spelling suggestions found for this term.

spellcheck.suggestions.{key}.startOffset

integer<int32>

The starting offset for pagination.

spellcheck.suggestions.{key}.endOffset

integer<int32>

The ending offset for pagination.

spellcheck.suggestions.{key}.origFreq

integer<int32>

The number of times the original, uncorrected query term appears in results.

spellcheck.suggestions.{key}.suggestion

object[]

Show child attributes

spellcheck.suggestions.{key}.suggestion.word

string

A suggested spell-corrected word.

spellcheck.suggestions.{key}.suggestion.freq

integer

The number of times the suggested word appears in results.

spellcheck.suggestions.{key}.wordFreqList

object[]

Show child attributes

spellcheck.suggestions.{key}.wordFreqList.word

string

A word.

spellcheck.suggestions.{key}.wordFreqList.freq

integer<int32>

The word's frequency.

spellcheck.correctlySpelled

boolean

true if no misspellings are detected in the query terms.

spellcheck.collations

object[]

Spellcheck collations for this query.

Show child attributes

spellcheck.collations.collationQuery

string

The collated query suggestion.

spellcheck.collations.hits

integer<int64>

The number of documents matching this collated query.

spellcheck.collations.misspellingsAndCorrections

object

The misspelled term and the corrected term.

Show child attributes

spellcheck.collations.misspellingsAndCorrections.{key}

string

response

object

The query result documents and statistics.

Show child attributes

response.numFound

integer<int64>

The number of documents matching the query.

response.start

integer<int64>

The response start position, for pagination.

response.numFoundExact

boolean

true if the numFound value is exact. If false, the real number of hits for the query is guaranteed to be greater than or equal to numFound. You can enable approximate document counts using Solr's minExactCount parameter.

response.docs

object[]

The set of documents matching the query.

Show child attributes

response.docs.{key}

object

The document fields.

Example:

{
  "response": {
    "numFound": 106,
    "start": 0,
    "docs": [
      {
        "title": [
          "Solr and SolrAdmin APIs - Fusion Documentation - Lucidworks"
        ]
      },
      {
        "title": [
          "Solr and SolrAdmin APIs - Fusion Documentation - Lucidworks"
        ]
      },
      {
        "title": [
          "Search Clusters - Fusion Documentation - Lucidworks"
        ]
      },
      {
        "title": [
          "Search Clusters - Fusion Documentation - Lucidworks"
        ]
      },
      {
        "title": [
          "Searching - Fusion Documentation - Lucidworks"
        ]
      }
    ]
  },
  "responseHeader": {
    "status": 0,
    "QTime": 1,
    "params": {
      "fl": "title",
      "lw.pipelineId": "default",
      "q": "solr",
      "wt": "json",
      "rows": "5",
      "defType": "edismax"
    }
  }
}

responseHeader

object

Show child attributes

responseHeader.zkConnected

boolean

true if the node that processed the request was connected to ZooKeeper at the time.

responseHeader.QTime

integer<int32>

The request processing time.

responseHeader.totalTime

integer<int32>

The sum of all request processing times since the Solr process was started.

responseHeader.params

object

The query request parameters.

Show child attributes

responseHeader.params.{key}

object

responseHeader.status

integer<int32>

The request status as an HTTP status code, or 0 for 200 (success).

facet_counts

object

Counts of facets matching the query.

Show child attributes

facet_counts.facet_fields

object

Counts of matching documents per facet field value.

Show child attributes

facet_counts.facet_fields.{key}

object

facet_counts.facet_queries

object

Show child attributes

facet_counts.facet_queries.{key}

object

facet_counts.facet_ranges

object

Show child attributes

facet_counts.facet_ranges.{key}

object

Range facets are used for fields that contain date or number values.

Show child attributes

facet_counts.facet_ranges.{key}.field

string

The field that functions as a range facet field.

facet_counts.facet_ranges.{key}.start

string

The start of the facet range.

facet_counts.facet_ranges.{key}.end

string

The end of the facet range.

facet_counts.facet_ranges.{key}.gap

string

The span of the range as a value to be added to the lower bound.

facet_counts.facet_ranges.{key}.hardEnd

boolean

A boolean parameter that specifies how Solr handles a range gap that cannot be evenly divided between the range start and end values.

If true, the last range constraint will have the facet.range.end value an upper bound.
If false, the last range will have the smallest possible upper bound greater then facet.range.end such that the range is the exact width of the specified range gap. Solr's default value for this parameter is false.

facet_counts.facet_ranges.{key}.minCount

integer<int32>

The minimum count required for a range to be included in the response.

facet_counts.facet_ranges.{key}.include

enum<string>[]

By default, the ranges used to compute range faceting between start and end are inclusive of their lower bounds and exclusive of the upper bounds. The "before" range defined with the other parameter is exclusive and the "after" range is inclusive. This default, equivalent to "lower" below, will not result in double counting at the boundaries.

You can use the include parameter to modify this behavior using the following options:

lower - All gap-based ranges include their lower bound.
upper - All gap-based ranges include their upper bound.
edge - The first and last gap ranges include their edge bounds (lower for the first one, upper for the last one) even if the corresponding upper/lower option is not specified.
outer - The "before" and "after" ranges will be inclusive of their bounds, even if the first or last ranges already include those boundaries.
all - Includes all options: lower, upper, edge, outer.

Available options:

lower,

upper,

outer,

edge,

all

facet_counts.facet_ranges.{key}.other

enum<string>[]

This parameter specifies that, in addition to the counts for each range constraint between start and end, counts should also be computed for these options:

before - All records with field values lower then lower bound of the first range.
after - All records with field values greater then the upper bound of the last range.
between - All records with field values between the start and end bounds of all ranges.
none - Do not compute any counts.
all - Compute counts for before, between, and after.

Available options:

before,

after,

between,

non,

all

facet_counts.facet_ranges.{key}.domain

object

Show child attributes

facet_counts.facet_ranges.{key}.domain.additionalFilters

object[]

Show child attributes

facet_counts.facet_ranges.{key}.domain.additionalFilters.type

string

facet_counts.facet_ranges.{key}.domain.excludedFiltersByName

string[]

facet_counts.facet_intervals

object

Show child attributes

facet_counts.facet_intervals.{key}

object

facet_counts.facet_heatmaps

object

Show child attributes

facet_counts.facet_heatmaps.{key}

object

facets

object

Show child attributes

facets.{key}

object

stats

object

Show child attributes

stats.stats_fields

object

Show child attributes

stats.stats_fields.{key}

object

grouped

object

Show child attributes

grouped.{key}

object

Show child attributes

grouped.{key}.numFound

integer<int64>

grouped.{key}.groups

object[]

Show child attributes

grouped.{key}.groups.field

string

grouped.{key}.groups.leaderStrategy

object

Show child attributes

grouped.{key}.groups.leaderStrategy.type

string

grouped.{key}.groups.sort

object[]

Show child attributes

grouped.{key}.groups.sort.type

enum<string>

Available options:

field,

expression,

relevancy,

query

grouped.{key}.groups.sort.value

string

grouped.{key}.groups.sort.order

enum<string>

The sort order, either ascending (asc) or descending (desc).

Available options:

asc,

desc

grouped.{key}.groups.sort.query

object

Show child attributes

grouped.{key}.groups.sort.query.type

string

grouped.{key}.groups.size

integer<int64>

debug

object

Show child attributes

debug.{key}

object

highlighting

object

Highlight snippets per matching document, if requested.

Show child attributes

highlighting.{key}

object

fusionResponse

object

Show child attributes

fusionResponse.{key}

object

Admin

Apps Manager

Async Parsing

Connectors

Indexing

Job Config

Job Launcher

Job Rest Server

ML Model Service

Proxy

Query

Templating

Authorizations

Path Parameters

Query Parameters

Response