Search data views

Base URL
https://{kibana_url}
  • GET /api/data_views/v2
  • GET /s/{space_id}/api/data_views/v2
Auth

Returns a paginated list of the data views in the current space. Each item includes only the name, index pattern, and time field. To get the full definition, use GET /api/data_views/v2/{id}.

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

page number · min: 1 · default: 1

The page of results to return.

per_page number · min: 1 · max: 1000 · default: 20

The number of results to return per page.

query string

Filters results by name and index_pattern using Elasticsearch simple_query_string syntax.

Responses

OK

application/json
data object[] · max items: 1000 required
data object required
index_pattern string · min length: 1 required

The index pattern (Elasticsearch index expression) to use as the data source. Example: "my-index-*".

name string · min length: 1 · max length: 256

The name of the data view. Example: "Sample data view".

time_field string

The name of the time field in the index. Used for time-based filtering. Example: "@timestamp".

id string · max length: 1000 required

The ID of the data view.

meta object required
created_at string

Timestamp when the object was created (ISO 8601).

created_by string

User profile ID of the user who created the object.

managed boolean

When true, the object is managed by Kibana and cannot be edited by users.

owner string

Identifier of the plugin or team that owns this object.

spaces string[] · max items: 100

The IDs of the spaces where the data view is available.

updated_at string

Timestamp when the object was last updated (ISO 8601).

updated_by string

User profile ID of the user who last updated the object.

version string

Internal version identifier for optimistic concurrency control.

meta object required
page number · min: 1 · default: 1

The returned page of results.

per_page number · min: 1 · max: 1000 · default: 20

The number of results returned per page.

total number required

The total number of results matching the query.

400

bad request

Base URL
https://{kibana_url}