---
title: "links | Grafana documentation"
description: "A reference for the JSON links schema used with Observability as Code."
---

> For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt).

# `links`

The `links` schema is the configuration for links with references to other dashboards or external websites. Following are the default JSON fields:

JSON ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```json
  "links": [
    {
      "asDropdown": false,
      "icon": "",
      "includeVars": false,
      "keepTime": false,
      "tags": [],
      "targetBlank": false,
      "title": "",
      "tooltip": "",
      "type": "link",
    },
  ],
```

## `DashboardLink`

The following table explains the usage of the dashboard link JSON fields. The table includes default and other fields:

Expand table

NameUsage

titlestring. Title to display with the link.

type`DashboardLinkType`. Link type. Accepted values are:

- dashboards - To refer to another dashboard
- link - To refer to an external resource

iconstring. Icon name to be displayed with the link.

tooltipstring. Tooltip to display when the user hovers their mouse over it.

url?string. Link URL. Only required/valid if the type is link.

tagsstring. List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards.

asDropdownbool. If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards. Default is `false`.

targetBlankbool. If true, the link will be opened in a new tab. Default is `false`.

includeVarsbool. If true, includes current template variables values in the link as query params. Default is `false`.

keepTimebool. If true, includes current time range in the link as query params. Default is `false`.

placement?string. Use placement to display the link somewhere else on the dashboard other than above the visualizations. Use the `inControlsMenu` parameter to render the link in the dashboard controls dropdown menu.