url-drilldown.asciidoc

URL templating

beta[]

The URL template input uses Handlebars — a simple templating language. Handlebars templates look like regular text with embedded Handlebars expressions.

https://github.com/elastic/kibana/issues?q={{event.value}}

A Handlebars expression is a {{, some contents, followed by a }}. When the drilldown is executed, these expressions are replaced by values from the dashboard and interaction context.

In addition to built-in Handlebars helpers, you can use custom helpers.

Refer to Handlebars documentation to learn about advanced use cases.

Custom helper	Use case
json	Serialize variables in JSON format. Example: {{json event}} {{json event.key event.value}} {{json filters=context.panel.filters}}
rison	Serialize variables in rison format. Rison is a common format for {kib} apps for storing state in the URL. Example: {{rison event}} {{rison event.key event.value}} {{rison filters=context.panel.filters}}
date	Format dates. Supports relative dates expressions (for example, "now-15d"). Refer to the moment docs for different formatting options. Example: {{date event.from “YYYY MM DD”}} {{date “now-15d”}} {{date “now/d” roundUp=true}}
formatNumber	Format numbers. Numbers can be formatted to look like currency, percentages, times or numbers with decimal places, thousands, and abbreviations. Refer to the numeral.js for different formatting options. Example: {{formatNumber event.value "0.0"}}
lowercase	Converts a string to lower case. Example: {{lowercase event.value}}
uppercase	Converts a string to upper case. Example: {{uppercase event.value}}
trim	Removes leading and trailing spaces from a string. Example: {{trim event.value}}
trimLeft	Removes leading spaces from a string. Example: {{trimLeft event.value}}
trimRight	Removes trailing spaces from a string. Example: {{trimRight event.value}}
mid	Extracts a substring from a string by start position and number of characters to extract. Example: {{mid event.value 3 5}} - extracts five characters starting from a third character.
left	Extracts a number of characters from a string (starting from left). Example: {{left event.value 3}}
right	Extracts a number of characters from a string (starting from right). Example: {{right event.value 3}}
concat	Concatenates two or more strings. Example: {{concat event.value "," event.key}}
replace	Replaces all substrings within a string. Example: {{replace event.value "stringToReplace" "stringToReplaceWith"}}
split	Splits a string using a provided splitter. Example: {{split event.value ","}}
encodeURIComponent	Escapes string using built in encodeURIComponent function.
encodeURIQuery	Escapes string using built in encodeURIComponent function, while keeping "@", ":", "$", ",", and ";" characters as is.

URL template variables

The URL drilldown template has three sources for variables:

• Global static variables that don’t change depending on the place where the URL drilldown is used or which user interaction executed the drilldown. For example: {{kibanaUrl}}.

• Context variables that change depending on where the drilldown is created and used. These variables are extracted from a context of a panel on a dashboard. For example, {{context.panel.filters}} gives access to filters that applied to the current panel.

• Event variables that depend on the trigger context. These variables are dynamically extracted from the interaction context when the drilldown is executed.

To ensure that the configured URL drilldown works as expected with your data, you have to save the dashboard and test in the panel. You can access the full list of variables available for the current panel and selected trigger by clicking Add variable in the top-right corner of a URL template input.

Variables reference

Source	Variable	Description
Global	kibanaUrl	{kib} base URL. Useful for creating URL drilldowns that navigate within {kib}.
Context	context.panel	Context provided by current dashboard panel.
	context.panel.id	ID of a panel.
	context.panel.title	Title of a panel.
	context.panel.filters	List of {kib} filters applied to a panel. Tip: Use in combination with rison helper for internal {kib} navigations with carrying over current filters.
	context.panel.query.query	Current query string.
	context.panel.query.language	Current query language.
	context.panel.timeRange.from context.panel.timeRange.to	Current time picker values. Tip: Use in combination with date helper to format date.
	context.panel.indexPatternId context.panel.indexPatternIds	The {data-source} IDs used by a panel.
	context.panel.savedObjectId	ID of saved object behind a panel.
Single click	event.value	Value behind clicked data point.
	event.key	Field name behind clicked data point
	event.negate	Boolean, indicating whether clicked data point resulted in negative filter.
	event.points	Some visualizations have clickable points that emit more than one data point. Use list of data points in case a single value is insufficient. Example: {{json event.points}} {{event.points.[0].key}} {{event.points.[0].value}} {{#each event.points}}key=value&{{/each}} Note: {{event.value}} is a shorthand for {{event.points.[0].value}} {{event.key}} is a shorthand for {{event.points.[0].key}}
Row click	event.rowIndex	Number, representing the row that was clicked, starting from 0.
	event.values	An array of all cell values for the row on which the action will execute. To access a column value, use {{event.values.[x]}}, where x represents the column number.
	event.keys	An array of field names for each column.
	event.columnNames	An array of column names.
Range selection	event.from event.to	from and to values of the selected range as numbers. Tip: Consider using date helper for date formatting.
	event.key	Aggregation field behind the selected range, if available.