Search dashboards
- Base URL
-
https://{kibana_url}
- GET /api/dashboards
Returns a paginated list of dashboards. Each result includes title, description, tags, and metadata, but not the full panel layout. Use GET /api/dashboards/{id} to retrieve the complete state.
Query parameters
-
querystring -
Filters results by
titleanddescriptionusing Elasticsearchsimple_query_stringsyntax. Multi-word terms require all words to match. -
A tag ID to include. Accepts a single tag ID or multiple tag IDs. When multiple are specified, library items matching any of the tag IDs are included.
-
A tag ID to exclude. Accepts a single tag ID or multiple tag IDs. When multiple are specified, library items matching any of the tag IDs are excluded.
Responses
success
-
dataobject · max items: 1000required -
List of dashboards matching the query. Each entry includes summary fields but not the full panel layout.
-
dataobjectrequired -
Tag IDs associated with this dashboard.
-
time_rangeobject -
Specifies the time range for a query.
-
fromstringrequired -
The start of the time range. Accepts Elasticsearch date math expressions (for example,
now-7d) or ISO 8601 timestamps. -
mode -
The time range mode. Use
absolutefor fixed start and end timestamps. Userelativefor date math expressions that are re-evaluated at query time (for example,now-7d). -
Values:
absoluterelative -
tostringrequired -
The end of the time range. Accepts Elasticsearch date math expressions (for example,
now) or ISO 8601 timestamps.
bad request
forbidden
internal server error