POST
/
query
/
{id}
Get query results (DSL mode)
curl --request POST \
  --url https://{FUSION HOST}/api/query/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "queryDefinition": {
    "main": {
      "type": "<string>"
    },
    "boostsByValues": [
      {
        "field": "<string>",
        "boosts": [
          {
            "key": "<string>",
            "boost": 100
          }
        ]
      }
    ],
    "boostsByQuery": [
      {
        "query": {
          "type": "<string>"
        },
        "boost": 123,
        "type": "<string>"
      }
    ],
    "userQuery": "<string>",
    "filters": [
      {
        "type": "<string>"
      }
    ],
    "namedFilters": [
      {
        "name": "<string>",
        "query": {
          "type": "<string>"
        }
      }
    ],
    "groupedQuery": {
      "type": "<string>"
    },
    "groupedFilters": [
      {
        "type": "<string>"
      }
    ]
  },
  "results": {
    "cursor": "<string>",
    "start": 0,
    "size": 123,
    "sort": [
      {
        "type": "field",
        "value": "<string>",
        "order": "asc",
        "query": {
          "type": "<string>"
        }
      }
    ],
    "fields": [
      "<string>"
    ],
    "highlight": {
      "fields": [
        "<string>"
      ],
      "pre": "<em>",
      "post": "</em>",
      "length": 100,
      "count": 1,
      "defaultHighlight": false
    },
    "returnScore": true,
    "includeRawResponse": true,
    "group": {
      "field": "<string>",
      "leaderStrategy": {
        "type": "<string>"
      },
      "sort": [
        {
          "type": "field",
          "value": "<string>",
          "order": "asc",
          "query": {
            "type": "<string>"
          }
        }
      ],
      "size": 123
    }
  },
  "params": {},
  "context": {},
  "facets": {
    "fields": [
      {
        "field": "<string>",
        "prefix": "<string>",
        "sort": "count",
        "limit": 100,
        "offset": 0,
        "minCount": 123,
        "missing": true,
        "ensuredValues": [
          "<string>"
        ],
        "domain": {
          "additionalFilters": [
            {
              "type": "<string>"
            }
          ],
          "excludedFiltersByName": [
            "<string>"
          ]
        }
      }
    ],
    "ranges": [
      {
        "field": "<string>",
        "start": "<string>",
        "end": "<string>",
        "gap": "<string>",
        "hardEnd": true,
        "minCount": 123,
        "include": [
          "lower"
        ],
        "other": [
          "before"
        ],
        "domain": {
          "additionalFilters": [
            {
              "type": "<string>"
            }
          ],
          "excludedFiltersByName": [
            "<string>"
          ]
        }
      }
    ],
    "groupFacets": true,
    "groupingMethod": "unique"
  }
}'
{
  "meta": {
    "timing": {
      "total": 123,
      "mainQuery": 123,
      "pipeline": [
        {
          "stage": "<string>",
          "time": 123
        }
      ]
    },
    "debug": {
      "solrParams": {}
    }
  },
  "facets": {
    "fields": [
      {
        "field": "<string>",
        "prefix": "<string>",
        "sort": "count",
        "limit": 100,
        "offset": 0,
        "minCount": 123,
        "missing": true,
        "ensuredValues": [
          "<string>"
        ],
        "domain": {
          "additionalFilters": [
            {
              "type": "<string>"
            }
          ],
          "excludedFiltersByName": [
            "<string>"
          ]
        }
      }
    ],
    "ranges": [
      {
        "field": "<string>",
        "start": "<string>",
        "end": "<string>",
        "gap": "<string>",
        "hardEnd": true,
        "minCount": 123,
        "include": [
          "lower"
        ],
        "other": [
          "before"
        ],
        "domain": {
          "additionalFilters": [
            {
              "type": "<string>"
            }
          ],
          "excludedFiltersByName": [
            "<string>"
          ]
        }
      }
    ],
    "groupFacets": true,
    "groupingMethod": "unique"
  },
  "results": {
    "cursor": "<string>",
    "start": 0,
    "size": 123,
    "sort": [
      {
        "type": "field",
        "value": "<string>",
        "order": "asc",
        "query": {
          "type": "<string>"
        }
      }
    ],
    "fields": [
      "<string>"
    ],
    "highlight": {
      "fields": [
        "<string>"
      ],
      "pre": "<em>",
      "post": "</em>",
      "length": 100,
      "count": 1,
      "defaultHighlight": false
    },
    "returnScore": true,
    "includeRawResponse": true,
    "group": {
      "field": "<string>",
      "leaderStrategy": {
        "type": "<string>"
      },
      "sort": [
        {
          "type": "field",
          "value": "<string>",
          "order": "asc",
          "query": {
            "type": "<string>"
          }
        }
      ],
      "size": 123
    }
  },
  "spellcheck": {
    "suggestions": {},
    "correctlySpelled": true,
    "collations": [
      {
        "collationQuery": "<string>",
        "hits": 123,
        "misspellingsAndCorrections": {}
      }
    ]
  },
  "debugResponse": {},
  "rules": {
    "redirects": [
      "<string>"
    ],
    "responseValues": {},
    "banners": [
      {
        "url": "<string>",
        "zone": "<string>"
      }
    ],
    "jsonBlobs": {}
  }
}

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

id
string
required

The query profile ID.

Body

application/json
queryDefinition
object

Defines the logic of what to query for.

results
object

How the results should be displayed and organized.

params
object

Arbitrary query parameters to be added to the underlying Solr query, also used to supply Security Trimming Stage parameters.

context
object

Parameters used by various query stages as well as DSL hints.

facets
object

Response

200 - application/json

OK

meta
object

Assorted metadata about the query, such as timing and debug information.

facets
object

The returned facets and facet values.

results
object

The results list with pagination info, scoring, and hit count.

spellcheck
object

Spelling suggestions

debugResponse
object
rules
object

Data returned by any rules that triggered.