Path parameters

  • namestring Required

    The name of the search application to be searched.

Query parameters

  • typed_keysboolean

    Determines whether aggregation names are prefixed by their respective types in the response.

application/json

Body

  • paramsobject

    Query parameters specific to this request, which will override any defaults specified in the template.

    Hide params attribute Show params attribute object
    • *object Additional properties

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • tooknumber Required

      The number of milliseconds it took Elasticsearch to run the request. This value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response. It includes:

      • Communication time between the coordinating node and data nodes
      • Time the request spends in the search thread pool, queued for execution
      • Actual run time

      It does not include:

      • Time needed to send the request to Elasticsearch
      • Time needed to serialize the JSON response
      • Time needed to send the response to a client
    • timed_outboolean Required

      If true, the request timed out before completion; returned results may be partial or empty.

    • _shardsobject Required
      Hide _shards attributes Show _shards attributes object
      • failednumber Required
      • successfulnumber Required
      • totalnumber Required
      • failuresarray[object]
        Hide failures attributes Show failures attributes object
        • indexstring
        • nodestring
        • reasonobject Required

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Hide reason attributes Show reason attributes object
          • typestring Required

            The type of error

          • reasonstring | null

            A human-readable explanation of the error, in English.

            One of:
            string-1stringstring-2string | null
          • stack_tracestring

            The server stack trace. Present only if the error_trace=true parameter was sent with the request.

          • caused_byobject

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          • root_causearray[object]

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          • suppressedarray[object]

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • shardnumber Required
        • statusstring
      • skippednumber
    • hitsobject Required
      Hide hits attributes Show hits attributes object
    • aggregationsobject
    • _clustersobject
      Hide _clusters attributes Show _clusters attributes object
      • skippednumber Required
      • successfulnumber Required
      • totalnumber Required
      • runningnumber Required
      • partialnumber Required
      • failednumber Required
      • detailsobject
        Hide details attribute Show details attribute object
        • *object Additional properties
          Hide * attributes Show * attributes object
          • statusstring Required

            Values are running, successful, partial, skipped, or failed.

          • indicesstring Required
          • tooknumber

            Time unit for milliseconds

          • timed_outboolean Required
          • _shardsobject
            Hide _shards attributes Show _shards attributes object
          • failuresarray[object]
            Hide failures attributes Show failures attributes object
            • indexstring
            • nodestring
            • reasonobject Required

              Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

            • shardnumber Required
            • statusstring
    • fieldsobject
      Hide fields attribute Show fields attribute object
      • *object Additional properties
    • max_scorenumber
    • num_reduce_phasesnumber
    • profileobject
      Hide profile attribute Show profile attribute object
    • pit_idstring
    • _scroll_idstring
    • suggestobject
      Hide suggest attribute Show suggest attribute object
    • terminated_earlyboolean
GET /_application/search_application/{name}/_search
POST _application/search_application/my-app/_search
{
  "params": {
    "query_string": "my first query",
    "text_fields": [
      {"name": "title", "boost": 5},
      {"name": "description", "boost": 1}
    ]
  }
}
resp = client.search_application.search(
    name="my-app",
    params={
        "query_string": "my first query",
        "text_fields": [
            {
                "name": "title",
                "boost": 5
            },
            {
                "name": "description",
                "boost": 1
            }
        ]
    },
)
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,
      },
    ],
  },
});
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
        }
      ]
    }
  }
)
$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,
                ],
            ),
        ],
    ],
]);
curl -X POST -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}]}}' "$ELASTICSEARCH_URL/_application/search_application/my-app/_search"
Request example
Use `POST _application/search_application/my-app/_search` to run a search against a search application called `my-app` that uses a search template.
{
  "params": {
    "query_string": "my first query",
    "text_fields": [
      {"name": "title", "boost": 5},
      {"name": "description", "boost": 1}
    ]
  }
}