New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Search API Request Body Search »
Elastic Docs ›Elasticsearch Guide [7.6] ›REST APIs ›Search APIs

URI Search

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

URI Search

edit

Specifies search criteria as query parameters in the request URI.

GET twitter/_search?q=user:kimchy
Copy as curlTry in Elastic 

Request

edit

GET /<index>/_search?q=<parameter>

Description

edit

You can use query parameters to define your search criteria directly in the request URI, rather than in the request body. Request URI searches do not support the full Elasticsearch Query DSL, but are handy for testing.

Path parameters

edit
<index>
(Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.

Query parameters

edit

See the search API’s query parameters.

Examples

edit
GET twitter/_search?q=user:kimchy
Copy as curlTry in Elastic 

The API returns the following response:

{
    "timed_out": false,
    "took": 62,
    "_shards":{
        "total" : 1,
        "successful" : 1,
        "skipped" : 0,
        "failed" : 0
    },
    "hits":{
        "total" : {
            "value": 1,
            "relation": "eq"
        },
        "max_score": 1.3862942,
        "hits" : [
            {
                "_index" : "twitter",
                "_type" : "_doc",
                "_id" : "0",
                "_score": 1.3862942,
                "_source" : {
                    "user" : "kimchy",
                    "date" : "2009-11-15T14:12:12",
                    "message" : "trying out Elasticsearch",
                    "likes": 0
                }
            }
        ]
    }
}
« Search API Request Body Search »
Was this helpful?
Feedback