Menu
Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow Observability as Codebreadcrumb arrow JSON schema v2breadcrumb arrow links schema
Grafana Cloud Enterprise Open source

links

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

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

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

NameUsage
titlestring. Title to display with the link.
typeDashboardLinkType. 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.