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

annotations

The configuration for the list of annotations that are associated with the dashboard.

json 
  "annotations": [
    {
      "kind": "AnnotationQuery",
      "spec": {
        "builtIn": false,
        "datasource": {
          "type": "",
          "uid": ""
        },
        "enable": false,
        "hide": false,
        "iconColor": "",
        "name": ""
      }
    }
  ],

AnnotationsQueryKind consists of:

AnnotationQuerySpec

NameType/Definition
datasourceDataSourceRef
queryDataQueryKind
enablebool
hidebool
iconColorstring
namestring
builtInbool. Default is false.
filterAnnotationPanelFilter
options[string]: A catch-all field for datasource-specific properties.

DataSourceRef

NameUsage
type?string. The plugin type-id.
uid?The specific data source instance.

DataQueryKind

NameType
kindstring
specstring

AnnotationPanelFilter

NameType/Definition
exclude?bool. Should the specified panels be included or excluded. Default is false.
ids[...uint8]. Panel IDs that should be included or excluded.