
* Update dashboards pages to use `docs/reference` shortcode Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update panels-visualizations pages to use `docs/reference` shortcode Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use raw Markdown admonitions for contextual links See https://discourse.gohugo.io/t/markdown-reference-links-in-shortcodes/5770/3. Should be resolved by https://docs.google.com/document/d/19xd4CD3IrAqQqNR3xQeLfuIV-u2iNSQSBEvPZE9J4qU/edit#heading=h.5sybau7waq2q. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Prefer "Warning" over "Caution" Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Prettier Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix some links missing destinations Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix 'time range controls' link Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add missing 'HTTP APIs' link Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix dashboard links missing destinations Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix links missing destinations in panels and visualizations documentation Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix dud link Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
4.1 KiB
aliases | keywords | labels | title | weight | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
Dashboard URL variables | 250 |
Dashboard URL variables
Grafana can apply variable values passed as query parameters in dashboard URLs. For more information, refer to [Manage dashboard links][] and [Templates and variables][].
Passing variables as query parameters
Grafana interprets query string parameters prefixed with var-
as variables in the given dashboard.
For example, in this URL:
https://${your-domain}/path/to/your/dashboard?var-example=value
The query parameter var-example=value
represents the dashboard variable example
with a value of value
.
Passing multiple values for a variable
To pass multiple values, repeat the variable parameter once for each value:
https://${your-domain}/path/to/your/dashboard?var-example=value1&var-example=value2
Grafana interprets var-example=value1&var-example=value2
as the dashboard variable example
with two values: value1
and value2
.
Example
This example in Grafana Play passes the variable server
with multiple values, and the variables app
and interval
with a single value each.
Adding variables to dashboard links
Grafana can add variables to dashboard links when you generate them from a dashboard's settings. For more information and steps to add variables, refer to [Manage dashboard links][].
Passing ad hoc filters
Ad hoc filters apply key/value filters to all metric queries that use a specified data source. For more information, refer to [Add ad hoc filters][].
To pass an ad hoc filter as a query parameter, use the variable syntax to pass the ad hoc filter variable, and also provide the key, the operator as the value, and the value as a pipe-separated list.
For example, in this URL:
https://${your-domain}/path/to/your/dashboard?var-adhoc=example_key|=|example_value
The query parameter var-adhoc=key|=|value
applies the ad hoc filter configured as the adhoc
dashboard variable using the example_key
key, the =
operator, and the example_value
value.
{{% admonition type="note" %}}
When sharing URLs with ad hoc filters, remember to encode the URL. In the above example, replace the pipes (|
) with %7C
and the equality operator (=
) with %3D
.
{{% /admonition %}}
Example
This example in Grafana Play passes the ad hoc filter variable adhoc
with the filter value datacenter = America
.
Controlling time range using the URL
To set a dashboard's time range, use the from
, to
, time
, and time.window
query parameters. Because these are not variables, they do not require the var-
prefix. For more information, see the [Linking overview][].
{{% docs/reference %}} [Linking overview]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards" [Linking overview]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards"
[Manage dashboard links]: "/docs/grafana/ -> /docs/grafana//dashboards/build-dashboards/manage-dashboard-links" [Manage dashboard links]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/build-dashboards/manage-dashboard-links"
[Add ad hoc filters]: "/docs/grafana/ -> /docs/grafana//dashboards/variables/add-template-variables#add-ad-hoc-filters" [Add ad hoc filters]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables/add-template-variables#add-ad-hoc-filters"
[Template and variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables" [Template and variables]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables" {{% /docs/reference %}}