Get an ES|QL view

GET /_query/view/{name}
GET /_query/view

Auth

Returns one or more stored views. A reserved view includes reserved set to true.

Define reusable queries with ES|QL views

Required privileges

Index privileges read_view_metadata

Path parameters

name union string | string[] optional

The comma-separated view names to retrieve.

Leave it out to use /_query/view.

Response

application/json

views object[] required

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_query/view/country_addresses

JavaScript Elasticsearch JavaScript Client

const response = await client.esql.getView({
  name: "country_addresses",
});

Python Elasticsearch Python Client

resp = client.esql.get_view(
    name="country_addresses",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_query/view/country_addresses" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

C# Elasticsearch .NET Client

var response = await client.Esql
    .GetViewAsync(d1 => d1
        .Name(new[] { "country_addresses" })
    );

PHP Elasticsearch PHP Client

$resp = $client->esql()->getView([
    "name" => "country_addresses",
]);

Ruby Elasticsearch Ruby Client

response = client.esql.get_view(
  name: "country_addresses"
)

Response

The response contains the requested view.

{
  "views": [
    {
      "name": "country_addresses",
      "query": """
        FROM addresses
        | RENAME city.country.name AS country
        | EVAL country = CASE(country == "United States of America", "United States", country)
        | STATS count=COUNT() BY country
      """,
      "description": "Address counts by country"
    }
  ]
}