Create a runtime field

Base URL: https://{kibana_url}

POST /api/data_views/data_view/{viewId}/runtime_field

Auth

Create a runtime field for a data view. Runtime fields are computed at query time using a Painless script and do not require reindexing. If no script is provided, the runtime field returns the corresponding value from the document _source.

Path parameters

viewId string required: An identifier for the data view.; Example: ff959d40-b880-11e8-a6d9-e546fe2bba5f

Header parameters

kbn-xsrf string required: Cross-site request forgery protection

Request body

name string required: The name for a runtime field.
runtimeField object required: The runtime field definition object.

Response

Indicates a successful call.

application/json

Response Type: object

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/data_views/data_view/{viewId}/runtime_field
{"name":"hour_of_day","runtimeField":{"type":"long","script":{"source":"emit(doc['timestamp'].value.getHour())"}}}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/data_views/data_view/${DATA_VIEW_ID}/runtime_field" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{"name":"hour_of_day","runtimeField":{"type":"long","script":{"source":"emit(doc['"'"'timestamp'"'"'].value.getHour())"}}}'

Response

No example

Request Console 1 / 2 languages

Create a long-type runtime field that emits a value derived from the foo source field.

Console Kibana Dev Tools

POST kbn:/api/data_views/data_view/VIEW_ID/runtime_field
{
  "name": "runtimeFoo",
  "runtimeField": {
    "script": {
      "source": "emit(doc[\u0022foo\u0022].value)"
    },
    "type": "long"
  }
}

Generated from the API spec

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/data_views/data_view/${VIEW_ID}/runtime_field" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "runtimeFoo",
    "runtimeField": {
      "script": {
        "source": "emit(doc[\u0022foo\u0022].value)"
      },
      "type": "long"
    }
  }'"'"'timestamp'"'"'].value.getHour())"}}}'

Generated from the API spec

Response

The response includes the newly created runtime field as an array and the full updated data view object.

{
  "data_view": {
    "...": "null"
  },
  "fields": [
    "..."
  ]
}

Path parameters

Header parameters

Request body { }

Response

Request body