Get a data view

Base URL: https://{kibana_url}

GET /api/data_views/data_view/{viewId}
GET /s/{space_id}/api/data_views/data_view/{viewId}

Refer to Spaces for more information.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Responses

Indicates a successful call.

application/json

data_view object

Object is not found.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/data_views/data_view/ff959d40-b880-11e8-a6d9-e546fe2bba5f

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/data_views/data_view/ff959d40-b880-11e8-a6d9-e546fe2bba5f" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

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