Splunk® Enterprise

Dashboards and Visualizations

Download manual as PDF

Download topic as PDF

Token reference

Tokens are a type of variable that can be used to pass values in a simple XML dashboard. This reference lists the types of tokens available for various scenarios.

See Token usage in dashboards for further details on token usage.

Token Type Elements Description
Form input <input> User defined input for referencing the value selected from an input.

See Define tokens for form inputs.

Form input example

Time picker input <input type="time"> Optional user defined input token to associate two or more time pickers with multiple panels in a dashboard.

Contains the earliest and latest modifiers to capture the time range.

See Define tokens for time inputs.

Time input example

Drilldown event <drilldown> Predefined tokens to capture the value from a click in a chart. Dynamic drilldown operations use the captured value from the source chart when accessing the drilldown target.

See Drilldown event tokens for a list of the predefined tokens.

See Define tokens for drilldown.

Pan and zoom event <selection> Predefined tokens to capture a range of values for a pan and zoom operation. The token values apply to a user selection on the chart. The context of the tokens is only for the chart. Copy the token values into user defined tokens to access the values in the dashboard.

start and end capture the values of the X-axis of a chart for the beginning and end of the selected area. For example, a selection in a time chart captures the starting and ending time of the selection.

start.<field>and end.field capture the values of the Y-axis of a chart at the beginning and end of the selected area. For example, a selection in a time chart captures the number of events for the series specified by <field>.

See Define tokens for pan and zoom chart controls.

Define tokens for pan and zoom chart controls contains an example using a time chart.

Conditional drilldown action <drilldown>
<condition>
<link>
<set>|<unset>
User defined token within a condition element to configure conditional operations. Conditional operations include:
  • Set token values based on the condition.
  • Select a value for a multivalue fields in a visualization.
  • Select a view to open based on a token value.
  • Hide or show panels based on conditions.

See Define tokens for conditional operations with the <drilldown> element.

Conditional form input action <input>
<change>
<condition>
<link>
<set>|<unset>
User defined token within a condition element to modify searches or select which visualization to display based on the conditional value of a token.

See Define tokens for conditional operations with form inputs.

Conditional operations with form inputs example

Set destination action <input>|<drilldown>
<condition>
<link>
<set>|<unset>
Set and unset tokens to specify a target page to open.

Can be used with the <input> element or <drilldown> element. The <condition> element defines the condition for the action. The <link> element consumes the token to open the target destination.

PREVIOUS
Event Handler Reference
  NEXT
Customize Simple XML

This documentation applies to the following versions of Splunk® Enterprise: 6.6.0, 6.6.1, 6.6.2


Comments

This page is missing two important token-related elements: init and eval. I would imagine that init would be in its own row, whereas eval would appear in the elements column for various rows.

Rjthibod
July 18, 2017

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters