Run a search application search

POST also GET /_application/search_application/{name}/_search

Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.

Path Parameters

name string Name required: The name of the search application to be searched.

Query Parameters

typed_keys boolean · default: false: Determines whether aggregation names are prefixed by their respective types in the response.

Request

params map string to object: Query parameters specific to this request, which will override any defaults specified in the template.

Response

application/json

Examples

Use POST _application/search_application/my-app/_search to run a search against a search application called my-app that uses a search template.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _application/search_application/my-app/_search
{
  "params": {
    "query_string": "my first query",
    "text_fields": [
      {"name": "title", "boost": 5},
      {"name": "description", "boost": 1}
    ]
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.searchApplication.search({
  name: "my-app",
  params: {
    query_string: "my first query",
    text_fields: [
      {
        name: "title",
        boost: 5,
      },
      {
        name: "description",
        boost: 1,
      },
    ],
  },
});

Python Elasticsearch Python Client

resp = client.search_application.search(
    name="my-app",
    params={
        "query_string": "my first query",
        "text_fields": [
            {
                "name": "title",
                "boost": 5
            },
            {
                "name": "description",
                "boost": 1
            }
        ]
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_application/search_application/my-app/_search" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "query_string": "my first query",
      "text_fields": [
        {
          "name": "title",
          "boost": 5
        },
        {
          "name": "description",
          "boost": 1
        }
      ]
    }
  }'

Java Elasticsearch Java Client

client.searchApplication().search(s -> s
    .name("my-app")
    .params(Map.of("text_fields", JsonData.fromJson("""
[{"name":"title","boost":5},{"name":"description","boost":1}]
"""),"query_string", JsonData.fromJson("\"my first query\"")))
);

C# Elasticsearch .NET Client

var response = await client.SearchApplication
    .SearchAsync<MyDocument>(name: "my-app", d1 => d1
        .Params(new Dictionary<string, object>()
        {
            { "query_string", "my first query" },
            { "text_fields", JsonSerializer.Deserialize<JsonElement>("""
            [
              {
                "name": "title",
                "boost": 5
              },
              {
                "name": "description",
                "boost": 1
              }
            ]
            """) }
        })
    );

PHP Elasticsearch PHP Client

$resp = $client->searchApplication()->search([
    "name" => "my-app",
    "body" => [
        "params" => [
            "query_string" => "my first query",
            "text_fields" => array(
                [
                    "name" => "title",
                    "boost" => 5,
                ],
                [
                    "name" => "description",
                    "boost" => 1,
                ],
            ),
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.search_application.search(
  name: "my-app",
  body: {
    "params": {
      "query_string": "my first query",
      "text_fields": [
        {
          "name": "title",
          "boost": 5
        },
        {
          "name": "description",
          "boost": 1
        }
      ]
    }
  }
)

Response

No example