Create a dashboard
https://{kibana_url}
- POST /api/dashboards
Creates a new dashboard and returns its ID, full state, and metadata.
Request
-
access_control -
Access control settings for the dashboard.
-
access_mode -
Controls edit access to the dashboard. Set to
write_restrictedto prevent edits by users without explicit write permission. Defaults todefault(all viewers can edit). -
Values:
write_restricteddefault -
descriptionstring -
A short description of the dashboard.
-
esql_approximationboolean -
When
true, ES|QL visualizations that useSTATSrun with approximate execution for faster, estimated results. -
filters· max: 500 -
Filters applied across all panels, including pinned panels.
-
condition -
A filter condition with strict operator/value type matching.
-
fieldstringrequired -
Name of the document field the condition evaluates.
-
negateboolean -
When
true, the filter is negated and matches documents that do NOT satisfy the condition. Defaults tofalse. -
operator -
Values:
is -
valuestring | number | booleanrequired -
Single value to compare against the field.
-
fieldstringrequired -
Name of the document field the condition evaluates.
-
negateboolean -
When
true, the filter is negated and matches documents that do NOT satisfy the condition. Defaults tofalse. -
operator -
Values:
is_one_of -
valuestring | number | booleanrequired -
Homogeneous array of values to match against the field.
-
controlled_bystring -
Identifier of the panel that manages this filter. When set, the filter is treated as owned by that panel.
-
data_view_idstring -
Identifier of the data view used as context for this filter.
-
disabledboolean -
When
true, the filter is inactive and does not affect query results. Defaults tofalse. -
is_multi_indexboolean -
When
true, the filter can be applied across multiple indices. Defaults tofalse. -
labelstring -
Human-readable label for the filter, used for display purposes.
-
negateboolean -
When
true, the filter is negated and matches documents that do NOT satisfy the condition. Defaults tofalse. -
type -
Values:
condition -
controlled_bystring -
Identifier of the panel that manages this filter. When set, the filter is treated as owned by that panel.
-
data_view_idstring -
Identifier of the data view used as context for this filter.
-
disabledboolean -
When
true, the filter is inactive and does not affect query results. Defaults tofalse. -
group -
Logical group that combines one or more conditions or nested groups.
-
conditionsanyOfrequired -
Ordered list of conditions or nested groups combined by the group
operator. -
operator -
Logical operator applied across all entries in
conditions. Useandto require all conditions, ororto require at least one. -
Values:
andor -
is_multi_indexboolean -
When
true, the filter can be applied across multiple indices. Defaults tofalse. -
labelstring -
Human-readable label for the filter, used for display purposes.
-
negateboolean -
When
true, the filter is negated and matches documents that do NOT satisfy the condition. Defaults tofalse. -
type -
Values:
group -
controlled_bystring -
Identifier of the panel that manages this filter. When set, the filter is treated as owned by that panel.
-
data_view_idstring -
Identifier of the data view used as context for this filter.
-
disabledboolean -
When
true, the filter is inactive and does not affect query results. Defaults tofalse. -
dslmap string to objectrequired -
Elasticsearch Query DSL object passed directly to the query.
-
fieldstring -
Field name for scripted filters where the field cannot be extracted from the DSL query.
-
is_multi_indexboolean -
When
true, the filter can be applied across multiple indices. Defaults tofalse. -
labelstring -
Human-readable label for the filter, used for display purposes.
-
negateboolean -
When
true, the filter is negated and matches documents that do NOT satisfy the condition. Defaults tofalse. -
paramsobject -
Filter parameters metadata. May contain display values, formats, and parameters for scripted filters.
-
type -
Values:
dsl -
controlled_bystring -
Identifier of the panel that manages this filter. When set, the filter is treated as owned by that panel.
-
data_view_idstring -
Identifier of the data view used as context for this filter.
-
disabledboolean -
When
true, the filter is inactive and does not affect query results. Defaults tofalse. -
dslmap string to objectrequired -
Elasticsearch geo query DSL object.
-
is_multi_indexboolean -
When
true, the filter can be applied across multiple indices. Defaults tofalse. -
labelstring -
Human-readable label for the filter, used for display purposes.
-
negateboolean -
When
true, the filter is negated and matches documents that do NOT satisfy the condition. Defaults tofalse. -
type -
Values:
spatial -
options· default: { "auto_apply_filters": true, "hide_panel_borders": false, "hide_panel_titles": false, "sync_colors": false, "sync_cursor": true, "sync_tooltips": false, "use_margins": true } -
Display and behavior settings for the dashboard.
-
auto_apply_filtersboolean · default: true -
When
true, control filter changes are applied automatically. Whenfalse, control filter changes are applied manually through the dashboard's search update button. Defaults totrue. -
hide_panel_bordersboolean · default: false -
When
true, panel borders are hidden. Defaults tofalse. -
hide_panel_titlesboolean · default: false -
When
true, panel titles are hidden. Defaults tofalse. -
sync_colorsboolean · default: false -
When
true, colors are synchronized across panels that share a data source. Defaults tofalse. -
sync_cursorboolean · default: true -
When
true, the cursor position is synchronized across panels. Defaults totrue. -
sync_tooltipsboolean · default: false -
When
true, tooltips are synchronized across panels. Defaults tofalse. -
use_marginsboolean · default: true -
When
true, panels are separated by a margin. Defaults totrue. -
panelsanyOf · max: 1000 -
Panels and sections in the dashboard. Each entry is either a panel (with a
typeandconfig) or a collapsible section (with atitle,collapsedstate, and nestedpanels). -
config -
Anomaly Charts embeddable
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
job_idsstring · min: 1 · max: 10000required -
Anomaly detection job or group IDs whose results are shown in the charts.
-
max_series_to_plotnumber · min: 1 · max: 50 -
Maximum number of anomaly series to plot.
-
severity_thresholdanyOf · max: 5 -
Severity threshold ranges used to filter anomaly results.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
ml_anomaly_charts -
config -
Anomaly Swim Lane embeddable
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
job_idsstring · min: 1 · max: 10000required -
IDs of the anomaly detection jobs or groups whose results are shown in the swim lane.
-
per_pagenumber · min: 1 -
Number of rows to display per page in a view-by swim lane. Ignored for overall swim lanes.
-
swimlane_type -
Values:
overall -
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
job_idsstring · min: 1 · max: 10000required -
IDs of the anomaly detection jobs or groups whose results are shown in the swim lane.
-
per_pagenumber · min: 1 -
Number of rows to display per page in a view-by swim lane. Ignored for overall swim lanes.
-
swimlane_type -
Values:
viewBy -
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
view_bystring · min: 1 · max: 1000required -
Field name used to split anomalies into a view-by swim lane.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
ml_anomaly_swimlane -
config -
APM service map embeddable schema
-
alert_status_filter· max: 4 -
Values:
activerecovereduntrackeddelayed -
anomaly_severity_filter· max: 6 -
Values:
criticalmajorminorwarninglowunknown -
connection_filter· max: 2 -
Values:
orphanedconnected -
descriptionstring -
A short description of the panel.
-
environmentstring · max: 1024 · default: ENVIRONMENT_ALL -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
highlighted_service_namesstring · max: 50 -
kuerystring · max: 2048 -
map_orientation -
Values:
horizontalvertical -
service_group_idstring · max: 1024 -
service_namestring · max: 1024 -
slo_status_filter· max: 4 -
Values:
healthydegradingviolatednoData -
sync_with_dashboard_filtersboolean -
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
apm_service_map -
config -
Change point detection chart embeddable schema
-
aggregation_function· default: avg -
The aggregation function used to calculate the metric values.
-
Values:
avgsumminmax -
data_view_idstring · min: 1 · max: 10000required -
The data view ID used to run change point detection.
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
max_series_to_plotinteger · min: 1 · max: 50 · default: 6 -
The maximum number of change points to visualize. Defaults to 6.
-
metric_fieldstring · min: 1 · max: 10000required -
The metric field used by the aggregation function.
-
partitionsstring · max: 10000 -
Optional split field values to include in the panel.
-
split_fieldstring · min: 1 · max: 10000 -
The optional field used to split change point results.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
view_type· default: charts -
The type of change point detection view to display.
-
Values:
chartstable -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
aiops_change_point_chart -
configobjectrequired -
descriptionstring -
A short description of the panel.
-
esql_querystring · max: 1 -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
templatestring · max: 510000 -
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
custom_content -
configanyOfrequired -
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
tabsanyOf · min: 1 · max: 1required -
Inline tab configuration. Used when no
ref_idis set. Currently supports one tab. -
column_orderstring · max: 100 -
Ordered list of field names to display in the data table. If omitted, defaults to the advanced setting "defaultColumns" or the referenced saved object.
-
column_settingsmap string to object -
Per-column presentation settings keyed by field name (e.g. widths). Keys should correspond to entries in
column_orderwhen both are set. -
<string>object -
widthnumber · min: 0 -
Optional width of the column in pixels.
-
data_sourceoneOfrequired -
When
true, allows the data view to match hidden indices. -
field_filtersobject · max: 10000 -
Field filters can be used to exclude one or more fields when fetching a document. They may contain wildcards, such as
user*which filters fields starting with 'user'. -
field_settingsmap string to object -
index_patternstring · min: 1required -
The index pattern (Elasticsearch index expression) to use as the data source. Example: "my-index-*".
-
namestring · min: 1 · max: 256 -
The name of the data view. Example: "Sample data view".
-
time_fieldstring -
The name of the time field in the index. Used for time-based filtering. Example: "@timestamp".
-
type -
Values:
data_view_spec -
default_rendered_nodesnumber · min: 10 · max: 200 -
Discover display option: controls how many nodes each JSON cell renders by default in JSON document view.
-
density -
Discover display option: controls table row spacing. Choose "compact", "expanded", or "normal". If omitted, Discover or the embedding application determines the density from its current settings, such as the user preference.
-
Values:
compactexpandednormal -
documents_display_mode -
Discover display option: controls whether documents are shown as a formatted table ("table") or as a raw JSON tree ("json").
-
Values:
tablejson -
filters· max: 100 · default: [] -
List of filters to apply to the data in the tab.
-
header_row_heightnumber | enum -
Discover display option: controls table header row height. Use a number (1–5) or "auto" to size based on content. If omitted, Discover or the embedding application determines the height from its current settings, such as the user preference.
-
Values:
auto -
hide_nullsboolean -
Discover display option: controls whether fields with null values are hidden in JSON document view.
-
query -
A search query consisting of an expression and its language. Supports KQL and Lucene syntax.
-
expressionstringrequired -
A query expression in KQL or Lucene syntax.
-
language -
Query language. Use
kqlfor Kibana Query Language (KQL) orlucenefor Lucene query syntax. -
Values:
kqllucene -
row_heightnumber | enum -
Discover display option: controls table data row height. Use a number (1–20) or "auto" to size based on content. If omitted, defaults to the advanced setting "discover:rowHeightOption".
-
Values:
auto -
rows_per_pagenumber · min: 1 · max: 10000 -
The number of rows to display per page in the data table. If omitted, defaults to the advanced setting "discover:sampleRowsPerPage".
-
sample_sizenumber · min: 10 · max: 10000 -
Discover display option: controls how many documents to sample for the data table. If omitted, defaults to the advanced setting "discover:sampleSize".
-
sortobject · max: 100 · default: [] -
Sort configuration for the data table (field and direction).
-
type· default: default -
Identifies the type of profile settings saved with the tab. The
defaultvalue indicates that no profile settings are included. -
Values:
default -
view_mode· default: documents -
Discover view mode. Choose "documents" (search hits), "patterns" (pattern analysis), or "aggregated" (field statistics).
-
Values:
documentspatternsaggregated -
wrap_linesboolean -
Discover display option: controls whether long values wrap in JSON document view. When false, values are truncated to a single line.
-
column_orderstring · max: 100 -
Ordered list of field names to display in the data table. If omitted, defaults to the advanced setting "defaultColumns" or the referenced saved object.
-
column_settingsmap string to object -
Per-column presentation settings keyed by field name (e.g. widths). Keys should correspond to entries in
column_orderwhen both are set. -
<string>object -
widthnumber · min: 0 -
Optional width of the column in pixels.
-
data_source -
Uses an ES|QL query as the data source. The query is executed at render time; resulting columns are available as fields.
-
default_rendered_nodesnumber · min: 10 · max: 200 -
Discover display option: controls how many nodes each JSON cell renders by default in JSON document view.
-
density -
Discover display option: controls table row spacing. Choose "compact", "expanded", or "normal". If omitted, Discover or the embedding application determines the density from its current settings, such as the user preference.
-
Values:
compactexpandednormal -
documents_display_mode -
Discover display option: controls whether documents are shown as a formatted table ("table") or as a raw JSON tree ("json").
-
Values:
tablejson -
header_row_heightnumber | enum -
Discover display option: controls table header row height. Use a number (1–5) or "auto" to size based on content. If omitted, Discover or the embedding application determines the height from its current settings, such as the user preference.
-
Values:
auto -
hide_nullsboolean -
Discover display option: controls whether fields with null values are hidden in JSON document view.
-
row_heightnumber | enum -
Discover display option: controls table data row height. Use a number (1–20) or "auto" to size based on content. If omitted, defaults to the advanced setting "discover:rowHeightOption".
-
Values:
auto -
rows_per_pagenumber · min: 1 · max: 10000 -
The number of rows to display per page in the data table. If omitted, defaults to the advanced setting "discover:sampleRowsPerPage".
-
sample_sizenumber · min: 10 · max: 10000 -
Discover display option: controls how many documents to sample for the data table. If omitted, defaults to the advanced setting "discover:sampleSize".
-
sortobject · max: 100 · default: [] -
Sort configuration for the data table (field and direction).
-
type· default: default -
Identifies the type of profile settings saved with the tab. The
defaultvalue indicates that no profile settings are included. -
Values:
default -
wrap_linesboolean -
Discover display option: controls whether long values wrap in JSON document view. When false, values are truncated to a single line.
-
column_orderstring · max: 100 -
Ordered list of field names to display in the data table. If omitted, defaults to the advanced setting "defaultColumns" or the referenced saved object.
-
column_settingsmap string to object -
Per-column presentation settings keyed by field name (e.g. widths). Keys should correspond to entries in
column_orderwhen both are set. -
<string>object -
widthnumber · min: 0 -
Optional width of the column in pixels.
-
data_source -
Uses an ES|QL query as the data source. The query is executed at render time; resulting columns are available as fields.
-
default_rendered_nodesnumber · min: 10 · max: 200 -
Discover display option: controls how many nodes each JSON cell renders by default in JSON document view.
-
density -
Discover display option: controls table row spacing. Choose "compact", "expanded", or "normal". If omitted, Discover or the embedding application determines the density from its current settings, such as the user preference.
-
Values:
compactexpandednormal -
dimensionsstring · max: 5required -
Fields used to group metrics in the metrics grid.
-
documents_display_mode -
Discover display option: controls whether documents are shown as a formatted table ("table") or as a raw JSON tree ("json").
-
Values:
tablejson -
header_row_heightnumber | enum -
Discover display option: controls table header row height. Use a number (1–5) or "auto" to size based on content. If omitted, Discover or the embedding application determines the height from its current settings, such as the user preference.
-
Values:
auto -
hide_nullsboolean -
Discover display option: controls whether fields with null values are hidden in JSON document view.
-
histogram_percentile -
Percentile displayed for histogram metric fields.
-
Values:
p50p75p90p95p99 -
row_heightnumber | enum -
Discover display option: controls table data row height. Use a number (1–20) or "auto" to size based on content. If omitted, defaults to the advanced setting "discover:rowHeightOption".
-
Values:
auto -
rows_per_pagenumber · min: 1 · max: 10000 -
The number of rows to display per page in the data table. If omitted, defaults to the advanced setting "discover:sampleRowsPerPage".
-
sample_sizenumber · min: 10 · max: 10000 -
Discover display option: controls how many documents to sample for the data table. If omitted, defaults to the advanced setting "discover:sampleSize".
-
search_termstring · max: 1000required -
Search term used to filter metrics in the metrics grid.
-
sortobject · max: 100 · default: [] -
Sort configuration for the data table (field and direction).
-
type -
A tab with saved metrics grid settings. Requires an ES|QL data source. These settings are used only when the query supports the metrics experience.
-
Values:
metrics -
wrap_linesboolean -
Discover display option: controls whether long values wrap in JSON document view. When false, values are truncated to a single line.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
overridesobject · default: {} -
column_orderstring · max: 100 -
When set, overrides column order for the data table relative to the referenced saved object (
ref_id) or the inline tab intabs. If omitted, the source configuration is used. -
column_settingsmap string to object -
Per-column presentation overrides (e.g. widths) keyed by field name. When set, merges with the source configuration for the referenced session or inline tab.
-
<string>object -
widthnumber · min: 0 -
Optional width of the column in pixels.
-
default_rendered_nodesnumber · min: 10 · max: 200 -
Discover display option: controls how many nodes each JSON cell renders by default in JSON document view. When set, overrides the referenced saved object or the inline tab config in
tabs. If omitted, the source configuration is used. -
density -
Discover display option: controls table row spacing (
compact,expanded, ornormal). When set, overrides the referenced saved object or the inline tab config intabs. If omitted, the source configuration is used. -
Values:
compactexpandednormal -
documents_display_mode -
Discover display option: controls whether documents are shown as a formatted table ("table") or as a raw JSON tree ("json"). When set, overrides the referenced saved object or the inline tab config in
tabs. -
Values:
tablejson -
header_row_heightnumber | enum -
Discover display option: controls table header row height (number 1–5 or
auto). When set, overrides the referenced saved object or the inline tab config intabs. If omitted, the source configuration is used. -
Values:
auto -
hide_nullsboolean -
Discover display option: controls whether fields with null values are hidden in JSON document view. When set, overrides the referenced saved object or the inline tab config in
tabs. If omitted, the source configuration is used. -
row_heightnumber | enum -
Discover display option: controls table data row height (number 1–20 or
auto). When set, overrides the referenced saved object or the inline tab config intabs. If omitted, falls back to the source or to the advanced setting "discover:rowHeightOption". -
Values:
auto -
rows_per_pagenumber · min: 1 · max: 10000 -
Number of rows per page. When set, overrides the referenced saved object or the inline tab config in
tabs. If omitted, falls back to the source or to the advanced setting "discover:sampleRowsPerPage". -
sample_sizenumber · min: 10 · max: 10000 -
Discover display option: controls how many documents to sample. When set, overrides the referenced saved object or the inline tab config in
tabs. If omitted, falls back to the source or to the advanced setting "discover:sampleSize". -
sortobject · max: 100 -
Sort configuration (field and direction) for the data table. When set, overrides the referenced saved object or the inline tab config in
tabs. If omitted, the source configuration is used. -
wrap_linesboolean -
Discover display option: controls whether long values wrap in JSON document view. When false, values are truncated to a single line. When set, overrides the referenced saved object or the inline tab config in
tabs. If omitted, the source configuration is used. -
ref_idstringrequired -
selected_tab_idstring -
Tab to select from the referenced saved object. If omitted, defaults to the first tab.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
discover_session -
configoneOfrequired -
available_optionsstring · max: 1000required -
A fixed list of option strings displayed in the control.
-
control_type -
Values:
STATIC_VALUES -
display_settingsobject -
hide_action_barboolean -
When
true, the search bar, sorting options, and select all toggle are hidden from the control. -
hide_excludeboolean -
When
true, the exclude mode toggle is hidden from the control. -
hide_existsboolean -
When
true, the exists filter option is hidden from the control. -
hide_sortboolean -
When
true, the sort selector is hidden from the control. -
placeholderstring -
Placeholder text displayed in the control input when no option is selected.
-
selected_optionsstring · max: 10000required -
The list of currently selected option values.
-
single_selectboolean · default: true -
When
true, only one option can be selected at a time. Selecting a new option deselects any previously selected option. Defaults totrue. -
titlestring -
A human-readable title for the control.
-
variable_namestringrequired -
The name of the ES|QL variable that this control populates. The variable is referenced in ES|QL queries using the
?variable_namesyntax. -
variable_type -
The ES|QL variable type that determines how the selected value is substituted into the query. Accepts
fields,values,functions,time_literal, ormulti_values. -
Values:
fieldsvaluesfunctionstime_literalmulti_values -
control_type -
Values:
VALUES_FROM_QUERY -
display_settingsobject -
hide_action_barboolean -
When
true, the search bar, sorting options, and select all toggle are hidden from the control. -
hide_excludeboolean -
When
true, the exclude mode toggle is hidden from the control. -
hide_existsboolean -
When
true, the exists filter option is hidden from the control. -
hide_sortboolean -
When
true, the sort selector is hidden from the control. -
placeholderstring -
Placeholder text displayed in the control input when no option is selected.
-
esql_querystringrequired -
An ES|QL query whose results populate the list of available options in the control popover.
-
selected_optionsstring · max: 10000required -
The list of currently selected option values.
-
single_selectboolean · default: true -
When
true, only one option can be selected at a time. Selecting a new option deselects any previously selected option. Defaults totrue. -
titlestring -
A human-readable title for the control.
-
variable_namestringrequired -
The name of the ES|QL variable that this control populates. The variable is referenced in ES|QL queries using the
?variable_namesyntax. -
variable_type -
The ES|QL variable type that determines how the selected value is substituted into the query. Accepts
fields,values,functions,time_literal, ormulti_values. -
Values:
fieldsvaluesfunctionstime_literalmulti_values -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
esql_control -
config -
Field statistics table embeddable schema
-
data_view_idstring · min: 1 · max: 1000required -
Data view ID (stored as a panel reference).
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
show_distributionsboolean · default: false -
Whether to show the distribution mini-charts in the table.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
view_type -
Values:
dataview -
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
show_distributionsboolean · default: false -
Whether to show the distribution mini-charts in the table.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
view_type -
Values:
esql -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
field_stats_table -
configobjectrequired -
Image embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldownsanyOf · max: 100 -
open_in_new_tabboolean · default: false -
When enabled, the dashboard opens in a new browser tab.
-
use_filtersboolean · default: true -
When enabled, filters are passed to the opening dashboard.
-
use_time_rangeboolean · default: true -
When enabled, time range is passed to the opening dashboard.
-
dashboard_idstringrequired -
labelstringrequired -
trigger -
Values:
on_click_image -
type -
Values:
dashboard_drilldown -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_click_imageon_open_panel_menu -
type -
Values:
url_drilldown -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
image_configobjectrequired -
alt_textstring -
background_colorstring -
object_fit· default: contain -
How the image should be sized within its container
-
Values:
fillcontaincovernone -
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
image -
configanyOfrequired -
Links embeddable schema
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
linksoneOf · max: 100required -
The list of links to display.
-
destinationstringrequired -
Linked dashboard saved object ID.
-
labelstring -
The label of the link displayed in the UI.
-
optionsobject · default: { "open_in_new_tab": false, "use_filters": true, "use_time_range": true } -
open_in_new_tabboolean · default: false -
When enabled, the dashboard opens in a new browser tab.
-
use_filtersboolean · default: true -
When enabled, filters are passed to the opening dashboard.
-
use_time_rangeboolean · default: true -
When enabled, time range is passed to the opening dashboard.
-
type -
Values:
dashboardLink -
destinationstringrequired -
The external URL to link to.
-
labelstring -
The label of the link displayed in the UI.
-
optionsobject · default: { "encode_url": true, "open_in_new_tab": true } -
encode_urlboolean · default: true -
Whether to escape the URL with percent encoding
-
open_in_new_tabboolean · default: true -
Whether to open this link in a new tab when clicked.
-
type -
Values:
externalLink -
titlestring -
The panel title.
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
ref_idstringrequired -
The unique identifier of the links library item.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
links -
config -
Log rate analysis embeddable schema
-
data_view_idstring · min: 1 · max: 1000required -
The data view ID used to run log rate analysis.
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
aiops_log_rate_analysis -
configanyOfrequired -
Markdown panel config
-
contentstringrequired -
The Markdown text rendered by the panel. Supports GitHub-flavored Markdown, including headings, paragraphs, lists, links, images, tables, blockquotes, and code blocks. Use
\nfor line breaks within JSON strings. -
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
settingsobject · default: { "open_links_in_new_tab": true } -
Display settings for the markdown panel.
-
open_links_in_new_tabboolean · default: true -
Open links in a new browser tab.
-
titlestring -
The panel title.
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
ref_idstringrequired -
The unique identifier of the markdown library item.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
markdown -
configoneOf -
display_settingsobject -
hide_action_barboolean -
When
true, the search bar, sorting options, and select all toggle are hidden from the control. -
hide_excludeboolean -
When
true, the exclude mode toggle is hidden from the control. -
hide_existsboolean -
When
true, the exists filter option is hidden from the control. -
hide_sortboolean -
When
true, the sort selector is hidden from the control. -
placeholderstring -
Placeholder text displayed in the control input when no option is selected.
-
esql_querystring · min: 1required -
The ES|QL query that provides field options for this control
-
excludeboolean · default: false -
When
true, the control filters to documents that do NOT match the selected options. Defaults tofalse. -
exists_selectedboolean · default: false -
When
true, the control filters to documents where the field exists, regardless of the field's value. Defaults tofalse. -
ignore_validationsboolean · default: false -
When
true, the control skips selection validation and does not report which selections are responsible for returning zero results. -
run_past_timeoutboolean · default: false -
When
true, the options list query continues running even if it exceeds the configured timeout threshold. Defaults tofalse. -
search_technique· default: wildcard -
The matching technique used when searching available options.
prefixmatches values starting with the search term,wildcardmatches values containing the search term, andexactrequires a complete match. Only applies to string and IP fields. Defaults towildcard. -
Values:
prefixwildcardexact -
selected_optionsnumber | string · max: 10000 · default: [] -
The list of currently selected option values.
-
single_selectboolean · default: false -
When
true, only one option can be selected at a time. Selecting a new option deselects any previously selected option. Defaults tofalse. -
sortobject · default: { "by": "_count", "direction": "desc" } -
Defines how the available options are sorted in the control popover. Defaults to
{ by: "_count", direction: "desc" }. -
titlestring -
A human-readable title for the control.
-
use_global_filtersboolean · default: true -
When
true, the control's available options are narrowed by the page's active filters. -
values_source -
Values:
esql -
data_view_idstring · min: 1required -
The ID of the data view that provides field options for this control.
-
display_settingsobject -
hide_action_barboolean -
When
true, the search bar, sorting options, and select all toggle are hidden from the control. -
hide_excludeboolean -
When
true, the exclude mode toggle is hidden from the control. -
hide_existsboolean -
When
true, the exists filter option is hidden from the control. -
hide_sortboolean -
When
true, the sort selector is hidden from the control. -
placeholderstring -
Placeholder text displayed in the control input when no option is selected.
-
excludeboolean · default: false -
When
true, the control filters to documents that do NOT match the selected options. Defaults tofalse. -
exists_selectedboolean · default: false -
When
true, the control filters to documents where the field exists, regardless of the field's value. Defaults tofalse. -
field_namestring · min: 1required -
The name of the field in the data view that this control filters on.
-
ignore_validationsboolean · default: false -
When
true, the control skips selection validation and does not report which selections are responsible for returning zero results. -
run_past_timeoutboolean · default: false -
When
true, the options list query continues running even if it exceeds the configured timeout threshold. Defaults tofalse. -
search_technique· default: wildcard -
The matching technique used when searching available options.
prefixmatches values starting with the search term,wildcardmatches values containing the search term, andexactrequires a complete match. Only applies to string and IP fields. Defaults towildcard. -
Values:
prefixwildcardexact -
selected_optionsnumber | string · max: 10000 · default: [] -
The list of currently selected option values.
-
single_selectboolean · default: false -
When
true, only one option can be selected at a time. Selecting a new option deselects any previously selected option. Defaults tofalse. -
sortobject · default: { "by": "_count", "direction": "desc" } -
Defines how the available options are sorted in the control popover. Defaults to
{ by: "_count", direction: "desc" }. -
titlestring -
A human-readable title for the control.
-
use_global_filtersboolean · default: true -
When
true, the control's available options are narrowed by the page's active filters. -
values_source· default: field -
The source of the field options for this control. Defaults to
fieldfor legacy controls. -
Values:
field -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
options_list_control -
config -
Log Pattern Analysis embeddable schema
-
data_view_idstring · min: 1 · max: 1000required -
The data view ID used for pattern analysis.
-
descriptionstring -
A short description of the panel.
-
field_namestring · min: 1 · max: 1000required -
The text field on which to run pattern analysis.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
minimum_time_range· default: no_minimum -
Minimum time range for pattern analysis.
-
Values:
no_minimum1_week1_month3_months6_months -
random_sampler_mode· default: on_automatic -
The random sampler mode.
-
Values:
on_automaticon_manualoff -
random_sampler_probabilitynumber · min: 1E-05 · max: 0.5 · default: nullnullable -
The probability to use for random sampling (between 0.00001 and 0.5).
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
aiops_pattern_analysis -
configoneOf -
esql_querystring · min: 1required -
The ES|QL query that provides field options for this control
-
ignore_validationsboolean · default: false -
When
true, the control skips selection validation and does not report which selections are responsible for returning zero results. -
stepnumber · min: 0 · default: 1 -
The step size between selectable range values.
-
titlestring -
A human-readable title for the control.
-
use_global_filtersboolean · default: true -
When
true, the control's available options are narrowed by the page's active filters. -
valuestring · min: 2 · max: 2 -
The selected range as a two-element array of strings representing the lower and upper bound values, for example
["10", "50"]. -
values_source -
Values:
esql -
data_view_idstring · min: 1required -
The ID of the data view that provides field options for this control.
-
field_namestring · min: 1required -
The name of the field in the data view that this control filters on.
-
ignore_validationsboolean · default: false -
When
true, the control skips selection validation and does not report which selections are responsible for returning zero results. -
stepnumber · min: 0 · default: 1 -
The step size between selectable range values.
-
titlestring -
A human-readable title for the control.
-
use_global_filtersboolean · default: true -
When
true, the control's available options are narrowed by the page's active filters. -
valuestring · min: 2 · max: 2 -
The selected range as a two-element array of strings representing the lower and upper bound values, for example
["10", "50"]. -
values_source· default: field -
The source of the field options for this control. Defaults to
fieldfor legacy controls. -
Values:
field -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
range_slider_control -
config -
Single Metric Viewer embeddable
-
descriptionstring -
A short description of the panel.
-
forecast_idstring · max: 1000 -
Identifier of a forecast to overlay on the chart.
-
function_descriptionstring · max: 1000 -
For detectors that use the
metricfunction, selects which value to plot:min,max, ormean. Ignored for other detector functions. When omitted, the viewer derives a default from the highest-scoring anomaly record. -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
job_idsstring · min: 1 · max: 1required -
Anomaly detection job ID whose results are shown in the single metric viewer.
-
selected_detector_indexnumber · min: 0 · default: 0 -
Zero-based index of the detector (the Elasticsearch detector_index) within the job whose results are shown.
-
selected_entitiesmap string to string | number -
Values of the partition, by, or over fields that identify the single time series to display.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
ml_single_metric_viewer -
config -
SLO Alerts embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
slosobject · max: 100 · default: [] -
List of SLOs to display alerts for
-
slo_idstring · max: 64required -
SLO ID
-
slo_instance_idstring · max: 512 · default: * -
SLO instance ID
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
slo_alerts -
config -
SLO Burn Rate embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
durationstring · max: 32required -
Duration for the burn rate chart in the format [value][unit], e.g. 5m, 3h, or 6d
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
slo_idstring · max: 64required -
The ID of the SLO to display the burn rate for
-
slo_instance_idstring · max: 512 · default: * -
ID of the SLO instance. Set when the SLO uses group_by; identifies which instance to show. Defaults to * (all instances).
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
slo_burn_rate -
config -
SLO Error Budget embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
slo_idstring · max: 64required -
The ID of the SLO to display the error budget for
-
slo_instance_idstring · max: 512 · default: * -
ID of the SLO instance. Set when the SLO uses group_by; identifies which instance to show. Defaults to * (all instances).
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
slo_error_budget -
configoneOfrequired -
SLO Overview embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
overview_mode -
Values:
single -
remote_namestring · max: 256 -
The name of the remote SLO
-
slo_idstring · max: 64required -
The ID of the SLO
-
slo_instance_idstring · max: 512 · default: * -
ID of the SLO instance. Set when the SLO uses group_by; identifies which instance to show. Defaults to * (all instances).
-
titlestring -
The panel title.
-
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
group_filtersobject · default: { "group_by": "status" } -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
overview_mode -
Values:
groups -
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
slo_overview -
configobjectrequired -
Synthetics monitors embeddable schema
-
descriptionstring -
A short description of the panel.
-
filtersobject -
locationsobject · max: 100 -
Filter by monitor locations
-
monitor_idsobject · max: 5000 -
Filter by monitor IDs
-
monitor_typesobject · max: 10 -
Filter by monitor types
-
projectsobject · max: 100 -
Filter by project
-
Filter by tags
-
Display label for the filter option
-
Value for the filter option
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
synthetics_monitors -
configobjectrequired -
Synthetics stats overview embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
filtersobject -
locationsobject · max: 100 -
Filter by monitor locations
-
monitor_idsobject · max: 5000 -
Filter by monitor IDs
-
monitor_typesobject · max: 10 -
Filter by monitor types
-
projectsobject · max: 100 -
Filter by project
-
Filter by tags
-
Display label for the filter option
-
Value for the filter option
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
synthetics_stats_overview -
configobjectrequired -
end_percentage_of_time_rangenumber · min: 0 · max: 1 · default: 1 -
The end of the selected time window expressed as a fraction of the global time range, where
0is the beginning and1is the end of the range. -
is_anchoredboolean · default: false -
When
true, the start of the time window is fixed at the beginning of the global time range. Only the end of the window can be adjusted. Defaults tofalse. -
start_percentage_of_time_rangenumber · min: 0 · max: 1 · default: 0 -
The start of the selected time window expressed as a fraction of the global time range, where
0is the beginning and1is the end of the range. -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
time_slider_control -
configanyOfrequired -
Lens embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldownsanyOf · max: 100 -
open_in_new_tabboolean · default: false -
When enabled, the dashboard opens in a new browser tab.
-
use_filtersboolean · default: true -
When enabled, filters are passed to the opening dashboard.
-
use_time_rangeboolean · default: true -
When enabled, time range is passed to the opening dashboard.
-
dashboard_idstringrequired -
labelstringrequired -
trigger -
Values:
on_apply_filter -
type -
Values:
dashboard_drilldown -
open_in_new_tabboolean · default: true -
labelstringrequired -
trigger -
Values:
on_apply_filter -
type -
Values:
discover_drilldown -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_click_rowon_click_valueon_open_panel_menuon_select_range -
type -
Values:
url_drilldown -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
referencesobject -
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
descriptionstring -
A short description of the panel.
-
drilldownsanyOf · max: 100 -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
ref_idstringrequired -
referencesobject -
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
vis -
collapsedboolean · default: false -
When
true, the section is collapsed and its panels are not rendered until expanded. Useful for improving initial load time on large dashboards. Defaults tofalse. -
idstring -
The unique ID of the section.
-
panelsoneOf · max: 1000 -
The panels that belong to the section.
-
config -
Anomaly Charts embeddable
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
ml_anomaly_charts -
config -
Anomaly Swim Lane embeddable
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
ml_anomaly_swimlane -
config -
APM service map embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
apm_service_map -
config -
Change point detection chart embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
aiops_change_point_chart -
configobjectrequired -
descriptionstring -
A short description of the panel.
-
esql_querystring · max: 1 -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
templatestring · max: 510000 -
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
custom_content -
configanyOfrequired -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
discover_session -
configoneOfrequired -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
esql_control -
config -
Field statistics table embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
field_stats_table -
configobjectrequired -
Image embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldownsanyOf · max: 100 -
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
image_configobjectrequired -
alt_textstring -
background_colorstring -
object_fit· default: contain -
How the image should be sized within its container
-
Values:
fillcontaincovernone -
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
image -
configanyOfrequired -
Links embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
links -
config -
Log rate analysis embeddable schema
-
data_view_idstring · min: 1 · max: 1000required -
The data view ID used to run log rate analysis.
-
descriptionstring -
A short description of the panel.
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
time_range -
Specifies the time range for a query.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
aiops_log_rate_analysis -
configanyOfrequired -
Markdown panel config
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
markdown -
configoneOf -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
options_list_control -
config -
Log Pattern Analysis embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
aiops_pattern_analysis -
configoneOf -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
range_slider_control -
config -
Single Metric Viewer embeddable
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
ml_single_metric_viewer -
config -
SLO Alerts embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
slo_alerts -
config -
SLO Burn Rate embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
slo_burn_rate -
config -
SLO Error Budget embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
slo_error_budget -
configoneOfrequired -
SLO Overview embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
slo_overview -
configobjectrequired -
Synthetics monitors embeddable schema
-
descriptionstring -
A short description of the panel.
-
filtersobject -
locationsobject · max: 100 -
Filter by monitor locations
-
monitor_idsobject · max: 5000 -
Filter by monitor IDs
-
monitor_typesobject · max: 10 -
Filter by monitor types
-
projectsobject · max: 100 -
Filter by project
-
Filter by tags
-
Display label for the filter option
-
Value for the filter option
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
synthetics_monitors -
configobjectrequired -
Synthetics stats overview embeddable schema
-
descriptionstring -
A short description of the panel.
-
drilldowns· max: 100 -
encode_urlboolean · default: true -
When true, URL is escaped using percent encoding
-
open_in_new_tabboolean · default: true -
urlstringrequired -
Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable
-
labelstringrequired -
trigger -
Values:
on_open_panel_menu -
type -
Values:
url_drilldown -
filtersobject -
locationsobject · max: 100 -
Filter by monitor locations
-
monitor_idsobject · max: 5000 -
Filter by monitor IDs
-
monitor_typesobject · max: 10 -
Filter by monitor types
-
projectsobject · max: 100 -
Filter by project
-
Filter by tags
-
Display label for the filter option
-
Value for the filter option
-
hide_borderboolean -
When true, the panel border is hidden. Defaults to false.
-
hide_titleboolean -
When true, the panel title is hidden. Defaults to false.
-
titlestring -
The panel title.
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
synthetics_stats_overview -
configobjectrequired -
end_percentage_of_time_rangenumber · min: 0 · max: 1 · default: 1 -
The end of the selected time window expressed as a fraction of the global time range, where
0is the beginning and1is the end of the range. -
is_anchoredboolean · default: false -
When
true, the start of the time window is fixed at the beginning of the global time range. Only the end of the window can be adjusted. Defaults tofalse. -
start_percentage_of_time_rangenumber · min: 0 · max: 1 · default: 0 -
The start of the selected time window expressed as a fraction of the global time range, where
0is the beginning and1is the end of the range. -
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
time_slider_control -
configanyOfrequired -
Lens embeddable schema
-
grid -
The position and size of the panel on the dashboard grid.
-
hnumber · min: 1 · default: 15 -
The height of the panel in grid units. Minimum
1. Defaults to15. -
wnumber · min: 1 · max: 48 · default: 24 -
The width of the panel in grid units. Minimum
1, maximum48. Defaults to24. -
xnumberrequired -
The x coordinate of the panel in grid units.
-
ynumberrequired -
The y coordinate of the panel in grid units.
-
idstring -
The unique ID of the panel.
-
type -
Values:
vis -
titlestringrequired -
The title of the section.
-
pinned_panelsoneOf · max: 100 -
An array of control panels and their state in the control group.
-
configobjectrequired -
end_percentage_of_time_rangenumber · min: 0 · max: 1 · default: 1 -
The end of the selected time window expressed as a fraction of the global time range, where
0is the beginning and1is the end of the range. -
is_anchoredboolean · default: false -
When
true, the start of the time window is fixed at the beginning of the global time range. Only the end of the window can be adjusted. Defaults tofalse. -
start_percentage_of_time_rangenumber · min: 0 · max: 1 · default: 0 -
The start of the selected time window expressed as a fraction of the global time range, where
0is the beginning and1is the end of the range. -
growboolean · default: false -
When
true, the control expands to fill any available horizontal space. Defaults tofalse. -
idstring -
The unique ID of the control
-
type -
Values:
time_slider_control -
project_routingstring -
Controls cross-project search behavior for this dashboard (Serverless only). Set to
_alias:_originto scope data to the current project, or_alias:*to search across all projects. When omitted, the space default applies. -
query -
A search query consisting of an expression and its language. Supports KQL and Lucene syntax.
-
expressionstringrequired -
A query expression in KQL or Lucene syntax.
-
language -
Query language. Use
kqlfor Kibana Query Language (KQL) orlucenefor Lucene query syntax. -
Values:
kqllucene -
refresh_interval -
Specifies the auto-refresh interval for the object.
-
Tag IDs to associate with this dashboard.
-
time_range -
Specifies the time range for a query.
-
titlestring · min: 1required -
A human-readable title for the dashboard.
A filter that evaluates a single field condition such as equality, range, or existence.
operator: is
Matches documents where field equals a single specified value.
operator: is_one_of
Matches documents where field equals any value in a provided list.
operator: range
Matches documents where field falls within a specified numeric or date range.
operator: exists
Matches documents where field exists and contains a non-null value.
A filter that combines multiple conditions or nested groups using a logical and or or operator.
A filter expressed as a raw Elasticsearch Query DSL object, used for queries that cannot be represented by condition or group filters.
A filter that applies an Elasticsearch geo query, used for geographic boundary and shape matching.
Panel configuration stored inline
url_drilldown
type: data_view_reference
type: data_view_spec
ES|QL (Elasticsearch Query Language) data source.
An ES|QL tab with saved metrics grid settings. The dashboard panel stores these settings and restores them in Discover. The panel does not render the metrics grid.
Panel configuration stored in a linked library item
url_drilldown
control_type: STATIC_VALUES
An ES|QL variable control with a fixed list of selectable options defined directly in available_options.
control_type: VALUES_FROM_QUERY
An ES|QL variable control whose selectable options are dynamically retrieved by running an ES|QL query.
view_type: dataview
view_type: esql
Panel configuration stored inline
Link type. Set to dashboardLink for a link to another dashboard.
Link type. Set to externalLink for a URL outside Kibana.
Panel configuration stored in a linked library item
Panel configuration stored inline
Panel configuration stored in a linked library item
values_source: esql
An options list control whose available options come from an ES|QL query's results.
values_source: field
An options list control whose available options come from a data view field.
values_source: esql
A range slider control whose values come from an ES|QL query's results.
values_source: field
A range slider control whose values come from a numeric data view field.
url_drilldown
url_drilldown
url_drilldown
overview_mode: single
SLO Single Overview embeddable schema
url_drilldown
overview_mode: groups
SLO Group Overview embeddable schema
url_drilldown
url_drilldown
Panel configuration stored inline
Panel configuration stored in a linked library item
A collapsible group of panels.
url_drilldown
An ES|QL variable control whose selected value is injected into ES|QL visualizations using the ?variable_name syntax. Options can come from a fixed list or an ES|QL query. Define the options source in config.
A dropdown control that filters data by selecting field values from a data view. Define the data view, field, and selection settings in config.
A slider control that filters data by selecting a numeric range for the configured field. Define the data view, field, and selection settings in config.
A control panel that filters a time field to a selected sub-range of the global time range. Define the start and end positions in config as fractions of the global range (0 to 1).
Responses
created
-
data -
access_control -
Access control settings for the dashboard.
-
access_mode -
Controls edit access to the dashboard. Set to
write_restrictedto prevent edits by users without explicit write permission. Defaults todefault(all viewers can edit). -
Values:
write_restricteddefault -
descriptionstring -
A short description of the dashboard.
-
esql_approximationboolean -
When
true, ES|QL visualizations that useSTATSrun with approximate execution for faster, estimated results. -
filters· max: 500 -
Filters applied across all panels, including pinned panels.
-
options· default: { "auto_apply_filters": true, "hide_panel_borders": false, "hide_panel_titles": false, "sync_colors": false, "sync_cursor": true, "sync_tooltips": false, "use_margins": true } -
Display and behavior settings for the dashboard.
-
auto_apply_filtersboolean · default: true -
When
true, control filter changes are applied automatically. Whenfalse, control filter changes are applied manually through the dashboard's search update button. Defaults totrue. -
hide_panel_bordersboolean · default: false -
When
true, panel borders are hidden. Defaults tofalse. -
hide_panel_titlesboolean · default: false -
When
true, panel titles are hidden. Defaults tofalse. -
sync_colorsboolean · default: false -
When
true, colors are synchronized across panels that share a data source. Defaults tofalse. -
sync_cursorboolean · default: true -
When
true, the cursor position is synchronized across panels. Defaults totrue. -
sync_tooltipsboolean · default: false -
When
true, tooltips are synchronized across panels. Defaults tofalse. -
use_marginsboolean · default: true -
When
true, panels are separated by a margin. Defaults totrue. -
panelsanyOf · max: 1000 -
Panels and sections in the dashboard. Each entry is either a panel (with a
typeandconfig) or a collapsible section (with atitle,collapsedstate, and nestedpanels). -
pinned_panelsoneOf · max: 100 -
An array of control panels and their state in the control group.
-
project_routingstring -
Controls cross-project search behavior for this dashboard (Serverless only). Set to
_alias:_originto scope data to the current project, or_alias:*to search across all projects. When omitted, the space default applies. -
query -
A search query consisting of an expression and its language. Supports KQL and Lucene syntax.
-
expressionstringrequired -
A query expression in KQL or Lucene syntax.
-
language -
Query language. Use
kqlfor Kibana Query Language (KQL) orlucenefor Lucene query syntax. -
Values:
kqllucene -
refresh_interval -
Specifies the auto-refresh interval for the object.
-
Tag IDs to associate with this dashboard.
-
time_range -
Specifies the time range for a query.
-
titlestring · min: 1required -
A human-readable title for the dashboard.
-
idstringrequired -
The unique ID of the dashboard, as returned by the create or search endpoints.
-
meta -
created_atstring -
Timestamp when the object was created (ISO 8601).
-
created_bystring -
User profile ID of the user who created the object.
-
managedboolean -
When
true, the object is managed by Kibana and cannot be edited by users. -
ownerstring -
Identifier of the plugin or team that owns this object.
-
updated_atstring -
Timestamp when the object was last updated (ISO 8601).
-
updated_bystring -
User profile ID of the user who last updated the object.
-
versionstring -
Internal version identifier for optimistic concurrency control.
invalid request
forbidden