Type to search.

Search Discover sessions

Base URL
https://{kibana_url}
  • GET /api/discover_sessions
  • GET /s/{space_id}/api/discover_sessions
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Planned We plan to add this functionality in a future Elastic Stack update. Subject to changes. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Returns a paginated summary list of Discover sessions. Use GET /api/discover_sessions/{id} for the full session state.

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 · max length: 1000

Full-text search (simple_query_string) over title and description. All terms must match.

tags string[] · max items: 100 · default: []

A tag ID to include. Accepts a single tag ID or multiple tag IDs. When multiple are specified, Discover sessions matching any of the tag IDs are included.

excluded_tags string[] · max items: 100 · default: []

A tag ID to exclude. Accepts a single tag ID or multiple tag IDs. When multiple are specified, Discover sessions matching any of the tag IDs are excluded.

tag_names string[] · max items: 100

A tag name to include. Accepts a single tag name or multiple tag names. When multiple are specified, Discover sessions matching any of the tag names are included. If the same name is shared by multiple tags, sessions matching any of those tags are included.

excluded_tag_names string[] · max items: 100

A tag name to exclude. Accepts a single tag name or multiple tag names. When multiple are specified, Discover sessions matching any of the tag names are excluded. If the same name is shared by multiple tags, sessions matching any of those tags are excluded.

Responses

Success

application/json
data object[] · max items: 1000 required

List of matching Discover sessions (summaries, not the full session state).

data object required
description string

Discover session description.

tags string[] · max items: 1000 · default: []

Tag IDs associated with this Discover session.

title string required

Discover session title.

id string required

The Discover session ID.

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.

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

Invalid request

500

Internal server error