Get a data view

GET /api/data_views/data_view/{viewId}
Api key auth

Path parameters

  • viewId string Required

    An identifier for the data view.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attribute Show response attribute object
    • data_view object
      Hide data_view attributes Show data_view attributes object
      • allowNoIndex boolean

        Allows the data view saved object to exist before the data is available.

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

          A map of field attributes by field name.

          Hide * attributes Show * attributes object
          • count integer

            Popularity count for the field.

          • customDescription string

            Custom description for the field.

            Maximum length is 300.

          • customLabel string

            Custom label for the field.

      • fieldFormats object

        A map of field formats by field name.

      • fields object
      • id string
      • name string

        The data view name.

      • namespaces array[string]

        An array of space identifiers for sharing the data view between multiple spaces.

        Default value is default.

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

          A map of runtime field definitions by field name.

          Hide * attributes Show * attributes object
          • script object Required
            Hide script attribute Show script attribute object
            • source string

              Script for the runtime field.

          • type string Required

            Mapping type of the runtime field.

      • sourceFilters array[object]

        The array of field names you want to filter out in Discover.

        Hide sourceFilters attribute Show sourceFilters attribute object
        • value string Required
      • timeFieldName string

        The timestamp field name, which you use for time-based data views.

      • title string

        Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (*).

      • typeMeta object | null

        When you use rollup indices, contains the field list for the rollup data view API endpoints.

        Hide typeMeta attributes Show typeMeta attributes object | null
        • aggs object

          A map of rollup restrictions by aggregation type and field name.

        • params object

          Properties for retrieving rollup fields.

      • version string
  • 404 application/json

    Object is not found.

    Hide response attributes Show response attributes object
    • error string

      Value is Not Found.

    • message string
    • statusCode integer

      Value is 404.
GET /api/data_views/data_view/{viewId} 
curl \ --request GET 'https://<KIBANA_URL>/api/data_views/data_view/ff959d40-b880-11e8-a6d9-e546fe2bba5f' \ --header "Authorization: $API_KEY"
Response examples (200) 
{ "data_view": { "id": "ff959d40-b880-11e8-a6d9-e546fe2bba5f", "name": "Kibana Sample Data eCommerce", "title": "kibana_sample_data_ecommerce", "fields": { "_id": { "name": "_id", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "_id" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "sku": { "name": "sku", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "type": { "name": "type", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "user": { "name": "user", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "email": { "name": "email", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "_index": { "name": "_index", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "_index" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": false }, "_score": { "name": "_score", "type": "number", "count": 0, "format": { "id": "number" }, "isMapped": true, "scripted": false, "searchable": false, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "_source": { "name": "_source", "type": "_source", "count": 0, "format": { "id": "_source" }, "esTypes": [ "_source" ], "isMapped": true, "scripted": false, "searchable": false, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "category": { "name": "category", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "currency": { "name": "currency", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "order_id": { "name": "order_id", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "order_date": { "name": "order_date", "type": "date", "count": 0, "format": { "id": "date" }, "esTypes": [ "date" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_id": { "name": "customer_id", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "day_of_week": { "name": "day_of_week", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "manufacturer": { "name": "manufacturer", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "products._id": { "name": "products._id", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "products.sku": { "name": "products.sku", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "day_of_week_i": { "name": "day_of_week_i", "type": "number", "count": 0, "format": { "id": "number" }, "esTypes": [ "integer" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "event.dataset": { "name": "event.dataset", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_phone": { "name": "customer_phone", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "geoip.location": { "name": "geoip.location", "type": "geo_point", "count": 0, "format": { "id": "geo_point", "params": { "transform": "wkt" } }, "esTypes": [ "geo_point" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.price": { "name": "products.price", "type": "number", "count": 1, "format": { "id": "number", "params": { "pattern": "$0,0.00" } }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "total_quantity": { "name": "total_quantity", "type": "number", "count": 1, "format": { "id": "number" }, "esTypes": [ "integer" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_gender": { "name": "customer_gender", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "geoip.city_name": { "name": "geoip.city_name", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "category.keyword": { "name": "category.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "category" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "geoip.region_name": { "name": "geoip.region_name", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.category": { "name": "products.category", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "products.quantity": { "name": "products.quantity", "type": "number", "count": 0, "format": { "id": "number" }, "esTypes": [ "integer" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_full_name": { "name": "customer_full_name", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "customer_last_name": { "name": "customer_last_name", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "products.min_price": { "name": "products.min_price", "type": "number", "count": 0, "format": { "id": "number", "params": { "pattern": "$0,0.00" } }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "taxful_total_price": { "name": "taxful_total_price", "type": "number", "count": 0, "format": { "id": "number", "params": { "pattern": "$0,0.[00]" } }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_birth_date": { "name": "customer_birth_date", "type": "date", "count": 0, "format": { "id": "date" }, "esTypes": [ "date" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_first_name": { "name": "customer_first_name", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "products.base_price": { "name": "products.base_price", "type": "number", "count": 0, "format": { "id": "number", "params": { "pattern": "$0,0.00" } }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.created_on": { "name": "products.created_on", "type": "date", "count": 0, "format": { "id": "date" }, "esTypes": [ "date" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.product_id": { "name": "products.product_id", "type": "number", "count": 0, "format": { "id": "number" }, "esTypes": [ "long" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.tax_amount": { "name": "products.tax_amount", "type": "number", "count": 0, "format": { "id": "number" }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "taxless_total_price": { "name": "taxless_total_price", "type": "number", "count": 0, "format": { "id": "number", "params": { "pattern": "$0,0.00" } }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "geoip.continent_name": { "name": "geoip.continent_name", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "manufacturer.keyword": { "name": "manufacturer.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "manufacturer" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products._id.keyword": { "name": "products._id.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "products._id" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.manufacturer": { "name": "products.manufacturer", "type": "string", "count": 1, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "products.product_name": { "name": "products.product_name", "type": "string", "count": 1, "format": { "id": "string" }, "esTypes": [ "text" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": false, "shortDotsEnable": false, "readFromDocValues": false }, "products.taxful_price": { "name": "products.taxful_price", "type": "number", "count": 0, "format": { "id": "number", "params": { "pattern": "$0,0.00" } }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "total_unique_products": { "name": "total_unique_products", "type": "number", "count": 0, "format": { "id": "number" }, "esTypes": [ "integer" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "geoip.country_iso_code": { "name": "geoip.country_iso_code", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.taxless_price": { "name": "products.taxless_price", "type": "number", "count": 0, "format": { "id": "number", "params": { "pattern": "$0,0.00" } }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.base_unit_price": { "name": "products.base_unit_price", "type": "number", "count": 0, "format": { "id": "number", "params": { "pattern": "$0,0.00" } }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.discount_amount": { "name": "products.discount_amount", "type": "number", "count": 0, "format": { "id": "number" }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.category.keyword": { "name": "products.category.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "products.category" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_full_name.keyword": { "name": "customer_full_name.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "customer_full_name" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_last_name.keyword": { "name": "customer_last_name.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "customer_last_name" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "customer_first_name.keyword": { "name": "customer_first_name.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "customer_first_name" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.discount_percentage": { "name": "products.discount_percentage", "type": "number", "count": 0, "format": { "id": "number" }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.manufacturer.keyword": { "name": "products.manufacturer.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "products.manufacturer" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.product_name.keyword": { "name": "products.product_name.keyword", "type": "string", "count": 0, "format": { "id": "string" }, "esTypes": [ "keyword" ], "subType": { "multi": { "parent": "products.product_name" } }, "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true }, "products.unit_discount_amount": { "name": "products.unit_discount_amount", "type": "number", "count": 0, "format": { "id": "number" }, "esTypes": [ "half_float" ], "isMapped": true, "scripted": false, "searchable": true, "aggregatable": true, "shortDotsEnable": false, "readFromDocValues": true } }, "version": "WzUsMV0=", "typeMeta": {}, "fieldAttrs": { "products.price": { "count": 1 }, "total_quantity": { "count": 1 }, "products.manufacturer": { "count": 1 }, "products.product_name": { "count": 1 } }, "namespaces": [ "default" ], "allowNoIndex": false, "fieldFormats": { "products.price": { "id": "number", "params": { "pattern": "$0,0.00" } }, "products.min_price": { "id": "number", "params": { "pattern": "$0,0.00" } }, "taxful_total_price": { "id": "number", "params": { "pattern": "$0,0.[00]" } }, "products.base_price": { "id": "number", "params": { "pattern": "$0,0.00" } }, "taxless_total_price": { "id": "number", "params": { "pattern": "$0,0.00" } }, "products.taxful_price": { "id": "number", "params": { "pattern": "$0,0.00" } }, "products.taxless_price": { "id": "number", "params": { "pattern": "$0,0.00" } }, "products.base_unit_price": { "id": "number", "params": { "pattern": "$0,0.00" } } }, "sourceFilters": [], "timeFieldName": "order_date", "runtimeFieldMap": {} } }