Render a search application query

POST /_application/search_application/{name}/_render_query

Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in params, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.

You must have read privileges on the backing alias of the search application.

Path Parameters

name string Name required: The name of the search application to render teh query for.

Request

params map string to object

Response

application/json

Examples

Run POST _application/search_application/my-app/_render_query to generate a query for a search application called my-app that uses the search template.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _application/search_application/my-app/_render_query
{
  "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.renderQuery({
  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.render_query(
    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/_render_query" \
  -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().renderQuery(r -> r
    .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
    .RenderQueryAsync(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()->renderQuery([
    "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.render_query(
  name: "my-app",
  body: {
    "params": {
      "query_string": "my first query",
      "text_fields": [
        {
          "name": "title",
          "boost": 5
        },
        {
          "name": "description",
          "boost": 1
        }
      ]
    }
  }
)

Response

{
  "from": 0,
  "size": 10,
  "query": {
    "multi_match": {
      "query": "my first query",
      "fields": [
        "description^1.0",
        "title^5.0"
      ]
    }
  },
  "explain": false
}