IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Wrapper query Term-level queries »
Elastic Docs ›Elasticsearch Guide [7.6] ›Query DSL ›Specialized queries

Pinned Query

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Pinned Query

edit

Promotes selected documents to rank higher than those matching a given query. This feature is typically used to guide searchers to curated documents that are promoted over and above any "organic" matches for a search. The promoted or "pinned" documents are identified using the document IDs stored in the _id field.

Example request

edit
GET /_search
{
    "query": {
        "pinned" : {
            "ids" : ["1", "4", "100"],
            "organic" : {
            	"match":{
            		"description": "brown shoes"
            	}
            }
        }
    }
}

Top-level parameters for pinned

edit
ids
An array of document IDs listed in the order they are to appear in results.
organic
Any choice of query used to rank documents which will be ranked below the "pinned" document ids.
« Wrapper query Term-level queries »