Get data view APIedit
[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Retrieve a single data view by ID.
For the most up-to-date API details, refer to the open API specification.
Requestedit
GET <kibana host>:<port>/api/data_views/data_view/<id>
GET <kibana host>:<port>/s/<space_id>/api/data_views/data_view/<id>
Path parametersedit
-
space_id
-
(Optional, string) An identifier for the space. If
space_id
is not provided in the URL, the default space is used. -
id
- (Required, string) The ID of the data view you want to retrieve.
Response codeedit
-
200
- Indicates a successful call.
-
404
- The specified data view and ID doesn’t exist.
Exampleedit
Retrieve the data view object with the my-view
ID:
$ curl -X GET api/data_views/data_view/my-view
The API returns a data view object:
{ "data_view": { "id": "my-view", "version": "...", "title": "...", "type": "...", "timeFieldName": "...", "sourceFilters": [], "fields": {}, "typeMeta": {}, "fieldFormats": {}, "fieldAttrs": {}, "runtimeFieldMap" {}, "allowNoIndex: "..." } }