IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Update data view fields API Create runtime field API »
Elastic Docs ›Kibana Guide [8.11] ›REST API ›Data views API

Get runtime field API

edit

Get runtime field API

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Get a runtime field

For the most up-to-date API details, refer to the open API specification.

Request

edit

GET <kibana host>:<port>/api/data_views/data_view/<data_view_id>/runtime_field/<name>

GET <kibana host>:<port>/s/<space_id>/api/data_views/data_view/<data_view_id>/runtime_field/<name>

Path parameters

edit
space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.
data_view_id
(Required, string) The ID of the data view.
name
(Required, string) The name of the runtime field you want to retrieve.

Example

edit

Retrieve a runtime field named foo of data view with the my-view ID:

$ curl -X GET api/data_views/data_view/my-view/runtime_field/foo

The API returns a runtime field object array, and a runtimeField definition object:

{
    "fields": [
        ...
    ],
    "runtimeField": {
        ...
    }
}
« Update data view fields API Create runtime field API »