Skip to content

dashboard

dashboard

Dashboard definition

Annotation pydantic-model

Bases: BaseModel

Show JSON schema:
{
  "description": "    ",
  "properties": {
    "builtIn": {
      "default": 1,
      "title": "Builtin",
      "type": "integer"
    },
    "datasource": {
      "default": {
        "type": "grafana",
        "uid": "-- Grafana --"
      },
      "title": "Datasource",
      "type": "object"
    },
    "enable": {
      "default": true,
      "title": "Enable",
      "type": "boolean"
    },
    "hide": {
      "default": true,
      "title": "Hide",
      "type": "boolean"
    },
    "iconColor": {
      "default": "rgba(0, 211, 255, 1)",
      "title": "Iconcolor",
      "type": "string"
    },
    "name": {
      "default": "Annotation & Alers",
      "title": "Name",
      "type": "string"
    },
    "type": {
      "default": "dashboard",
      "title": "Type",
      "type": "string"
    }
  },
  "title": "Annotation",
  "type": "object"
}

Fields:

Annotations pydantic-model

Bases: BaseModel

Show JSON schema:
{
  "$defs": {
    "Annotation": {
      "description": "    ",
      "properties": {
        "builtIn": {
          "default": 1,
          "title": "Builtin",
          "type": "integer"
        },
        "datasource": {
          "default": {
            "type": "grafana",
            "uid": "-- Grafana --"
          },
          "title": "Datasource",
          "type": "object"
        },
        "enable": {
          "default": true,
          "title": "Enable",
          "type": "boolean"
        },
        "hide": {
          "default": true,
          "title": "Hide",
          "type": "boolean"
        },
        "iconColor": {
          "default": "rgba(0, 211, 255, 1)",
          "title": "Iconcolor",
          "type": "string"
        },
        "name": {
          "default": "Annotation & Alers",
          "title": "Name",
          "type": "string"
        },
        "type": {
          "default": "dashboard",
          "title": "Type",
          "type": "string"
        }
      },
      "title": "Annotation",
      "type": "object"
    }
  },
  "description": "    ",
  "properties": {
    "list": {
      "default": [
        {
          "builtIn": 1,
          "datasource": {
            "type": "grafana",
            "uid": "-- Grafana --"
          },
          "enable": true,
          "hide": true,
          "iconColor": "rgba(0, 211, 255, 1)",
          "name": "Annotation & Alers",
          "type": "dashboard"
        }
      ],
      "items": {
        "$ref": "#/$defs/Annotation"
      },
      "title": "List",
      "type": "array"
    }
  },
  "title": "Annotations",
  "type": "object"
}

Fields:

Dashboard pydantic-model

Bases: BaseModel

Show JSON schema:
{
  "$defs": {
    "Annotation": {
      "description": "    ",
      "properties": {
        "builtIn": {
          "default": 1,
          "title": "Builtin",
          "type": "integer"
        },
        "datasource": {
          "default": {
            "type": "grafana",
            "uid": "-- Grafana --"
          },
          "title": "Datasource",
          "type": "object"
        },
        "enable": {
          "default": true,
          "title": "Enable",
          "type": "boolean"
        },
        "hide": {
          "default": true,
          "title": "Hide",
          "type": "boolean"
        },
        "iconColor": {
          "default": "rgba(0, 211, 255, 1)",
          "title": "Iconcolor",
          "type": "string"
        },
        "name": {
          "default": "Annotation & Alers",
          "title": "Name",
          "type": "string"
        },
        "type": {
          "default": "dashboard",
          "title": "Type",
          "type": "string"
        }
      },
      "title": "Annotation",
      "type": "object"
    },
    "Annotations": {
      "description": "    ",
      "properties": {
        "list": {
          "default": [
            {
              "builtIn": 1,
              "datasource": {
                "type": "grafana",
                "uid": "-- Grafana --"
              },
              "enable": true,
              "hide": true,
              "iconColor": "rgba(0, 211, 255, 1)",
              "name": "Annotation & Alers",
              "type": "dashboard"
            }
          ],
          "items": {
            "$ref": "#/$defs/Annotation"
          },
          "title": "List",
          "type": "array"
        }
      },
      "title": "Annotations",
      "type": "object"
    },
    "Color": {
      "properties": {
        "fixedColor": {
          "default": "semi-dark-blue",
          "title": "Fixedcolor",
          "type": "string"
        },
        "mote": {
          "default": "palette-classic",
          "title": "Mote",
          "type": "string"
        }
      },
      "title": "Color",
      "type": "object"
    },
    "Custom": {
      "properties": {
        "axisBorderShow": {
          "default": false,
          "title": "Axisbordershow",
          "type": "boolean"
        },
        "axisCenteredZero": {
          "default": false,
          "title": "Axiscenteredzero",
          "type": "boolean"
        },
        "axisColorMode": {
          "default": "text",
          "title": "Axiscolormode",
          "type": "string"
        },
        "axisLabel": {
          "default": "",
          "title": "Axislabel",
          "type": "string"
        },
        "axisPlacement": {
          "default": "auto",
          "title": "Axisplacement",
          "type": "string"
        },
        "fillOpacity": {
          "default": 50,
          "title": "Fillopacity",
          "type": "integer"
        },
        "hideFrom": {
          "$ref": "#/$defs/HideFrom",
          "default": {
            "legend": false,
            "tooltip": false,
            "viz": false
          }
        },
        "lineStyle": {
          "$ref": "#/$defs/LineStyle",
          "default": {
            "fill": "solid"
          }
        },
        "lineWidth": {
          "default": 2,
          "title": "Linewidth",
          "type": "integer"
        },
        "pointShape": {
          "default": "circle",
          "title": "Pointshape",
          "type": "string"
        },
        "pointSize": {
          "$ref": "#/$defs/PointSize",
          "default": {
            "fixed": 3
          }
        },
        "pointStrokeWidth": {
          "default": 1,
          "title": "Pointstrokewidth",
          "type": "integer"
        },
        "scaleDistribution": {
          "$ref": "#/$defs/ScaleDistribution",
          "default": {
            "type": "linear"
          }
        },
        "show": {
          "default": "points",
          "title": "Show",
          "type": "string"
        }
      },
      "title": "Custom",
      "type": "object"
    },
    "DataSource": {
      "description": "    ",
      "properties": {
        "type": {
          "default": "yesoreyeram-infinity-datasource",
          "title": "Type",
          "type": "string"
        },
        "uid": {
          "default": "be1d76jvnf668b",
          "title": "Uid",
          "type": "string"
        }
      },
      "title": "DataSource",
      "type": "object"
    },
    "Defaults": {
      "properties": {
        "color": {
          "$ref": "#/$defs/Color",
          "default": {
            "fixedColor": "semi-dark-blue",
            "mote": "palette-classic"
          }
        },
        "cusom": {
          "$ref": "#/$defs/Custom",
          "default": {
            "axisBorderShow": false,
            "axisCenteredZero": false,
            "axisColorMode": "text",
            "axisLabel": "",
            "axisPlacement": "auto",
            "fillOpacity": 50,
            "hideFrom": {
              "legend": false,
              "tooltip": false,
              "viz": false
            },
            "lineStyle": {
              "fill": "solid"
            },
            "lineWidth": 2,
            "pointShape": "circle",
            "pointSize": {
              "fixed": 3
            },
            "pointStrokeWidth": 1,
            "scaleDistribution": {
              "type": "linear"
            },
            "show": "points"
          }
        },
        "fieldMinMax": {
          "default": false,
          "title": "Fieldminmax",
          "type": "boolean"
        },
        "mappings": {
          "default": [],
          "items": {},
          "title": "Mappings",
          "type": "array"
        },
        "thresholds": {
          "$ref": "#/$defs/Thresholds",
          "default": {
            "mode": "absolute",
            "steps": [
              {
                "color": "green",
                "value": null
              }
            ]
          }
        }
      },
      "title": "Defaults",
      "type": "object"
    },
    "FieldConfig": {
      "description": "```json\n \"fieldConfig\": {\n    \"defaults\": {\n        \n        \"fieldMinMax\": false,\n        \"mappings\": [],\n        \n    },\n    \"overrides\": []\n},\n```",
      "properties": {
        "defaults": {
          "$ref": "#/$defs/Defaults",
          "default": {
            "color": {
              "fixedColor": "semi-dark-blue",
              "mote": "palette-classic"
            },
            "cusom": {
              "axisBorderShow": false,
              "axisCenteredZero": false,
              "axisColorMode": "text",
              "axisLabel": "",
              "axisPlacement": "auto",
              "fillOpacity": 50,
              "hideFrom": {
                "legend": false,
                "tooltip": false,
                "viz": false
              },
              "lineStyle": {
                "fill": "solid"
              },
              "lineWidth": 2,
              "pointShape": "circle",
              "pointSize": {
                "fixed": 3
              },
              "pointStrokeWidth": 1,
              "scaleDistribution": {
                "type": "linear"
              },
              "show": "points"
            },
            "fieldMinMax": false,
            "mappings": [],
            "thresholds": {
              "mode": "absolute",
              "steps": [
                {
                  "color": "green",
                  "value": null
                }
              ]
            }
          }
        },
        "overrides": {
          "default": [],
          "items": {},
          "title": "Overrides",
          "type": "array"
        }
      },
      "title": "FieldConfig",
      "type": "object"
    },
    "GridPosition": {
      "description": "```json\n\"gridPos\": {\n    \"h\": 8,\n    \"w\": 12,\n    \"x\": 12,\n    \"y\": 16\n}\n```",
      "properties": {
        "h": {
          "default": 16,
          "title": "H",
          "type": "integer"
        },
        "w": {
          "default": 24,
          "title": "W",
          "type": "integer"
        },
        "x": {
          "default": 0,
          "title": "X",
          "type": "integer"
        },
        "y": {
          "default": 0,
          "title": "Y",
          "type": "integer"
        }
      },
      "title": "GridPosition",
      "type": "object"
    },
    "HideFrom": {
      "description": "{\n    \"legend\": false,\n    \"tooltip\": false,\n    \"viz\": false\n}",
      "properties": {
        "legend": {
          "default": false,
          "title": "Legend",
          "type": "boolean"
        },
        "tooltip": {
          "default": false,
          "title": "Tooltip",
          "type": "boolean"
        },
        "viz": {
          "default": false,
          "title": "Viz",
          "type": "boolean"
        }
      },
      "title": "HideFrom",
      "type": "object"
    },
    "Legend": {
      "description": "    ",
      "properties": {
        "calcs": {
          "default": [],
          "items": {},
          "title": "Calcs",
          "type": "array"
        },
        "displayMode": {
          "default": "list",
          "title": "Displaymode",
          "type": "string"
        },
        "placement": {
          "default": "bottom",
          "title": "Placement",
          "type": "string"
        },
        "showLegend": {
          "default": true,
          "title": "Showlegend",
          "type": "boolean"
        },
        "sortBy": {
          "default": "Name",
          "title": "Sortby",
          "type": "string"
        },
        "sortDesc": {
          "default": false,
          "title": "Sortdesc",
          "type": "boolean"
        }
      },
      "title": "Legend",
      "type": "object"
    },
    "LineStyle": {
      "description": "```json\n{\n    \"fill\": \"solid\"\n}\n```",
      "properties": {
        "fill": {
          "default": "solid",
          "title": "Fill",
          "type": "string"
        }
      },
      "title": "LineStyle",
      "type": "object"
    },
    "Matcher": {
      "properties": {
        "matcher": {
          "$ref": "#/$defs/MatcherOptions"
        }
      },
      "required": [
        "matcher"
      ],
      "title": "Matcher",
      "type": "object"
    },
    "MatcherOptions": {
      "description": "    ",
      "properties": {
        "options": {
          "title": "Options",
          "type": "string"
        },
        "id": {
          "default": "byName",
          "title": "Id",
          "type": "string"
        }
      },
      "required": [
        "options"
      ],
      "title": "MatcherOptions",
      "type": "object"
    },
    "Options": {
      "description": "    ",
      "properties": {
        "legend": {
          "$ref": "#/$defs/Legend",
          "default": {
            "calcs": [],
            "displayMode": "list",
            "placement": "bottom",
            "showLegend": true,
            "sortBy": "Name",
            "sortDesc": false
          }
        },
        "mapping": {
          "default": "auto",
          "title": "Mapping",
          "type": "string"
        },
        "series": {
          "default": [
            {
              "x": {
                "matcher": {
                  "id": "byName",
                  "options": "x"
                }
              },
              "y": {
                "matcher": {
                  "id": "byName",
                  "options": "y"
                }
              }
            }
          ],
          "items": {
            "$ref": "#/$defs/Series"
          },
          "title": "Series",
          "type": "array"
        },
        "tooltop": {
          "$ref": "#/$defs/ToolTip",
          "default": {
            "mode": "single",
            "sort": "none"
          }
        }
      },
      "title": "Options",
      "type": "object"
    },
    "Panel": {
      "description": "    ",
      "properties": {
        "datasource": {
          "$ref": "#/$defs/DataSource",
          "default": {
            "type": "yesoreyeram-infinity-datasource",
            "uid": "be1d76jvnf668b",
            "default": true
          }
        },
        "fieldConfig": {
          "$ref": "#/$defs/FieldConfig",
          "default": {
            "defaults": {
              "color": {
                "fixedColor": "semi-dark-blue",
                "mote": "palette-classic"
              },
              "cusom": {
                "axisBorderShow": false,
                "axisCenteredZero": false,
                "axisColorMode": "text",
                "axisLabel": "",
                "axisPlacement": "auto",
                "fillOpacity": 50,
                "hideFrom": {
                  "legend": false,
                  "tooltip": false,
                  "viz": false
                },
                "lineStyle": {
                  "fill": "solid"
                },
                "lineWidth": 2,
                "pointShape": "circle",
                "pointSize": {
                  "fixed": 3
                },
                "pointStrokeWidth": 1,
                "scaleDistribution": {
                  "type": "linear"
                },
                "show": "points"
              },
              "fieldMinMax": false,
              "mappings": [],
              "thresholds": {
                "mode": "absolute",
                "steps": [
                  {
                    "color": "green",
                    "value": null
                  }
                ]
              }
            },
            "overrides": []
          }
        },
        "gridPos": {
          "$ref": "#/$defs/GridPosition",
          "default": {
            "h": 16,
            "w": 24,
            "x": 0,
            "y": 0
          }
        },
        "id": {
          "default": 1,
          "title": "Id",
          "type": "integer"
        },
        "options": {
          "$ref": "#/$defs/Options",
          "default": {
            "legend": {
              "calcs": [],
              "displayMode": "list",
              "placement": "bottom",
              "showLegend": true,
              "sortBy": "Name",
              "sortDesc": false
            },
            "mapping": "auto",
            "series": [
              {
                "x": {
                  "matcher": {
                    "id": "byName",
                    "options": "x"
                  }
                },
                "y": {
                  "matcher": {
                    "id": "byName",
                    "options": "y"
                  }
                }
              }
            ],
            "tooltop": {
              "mode": "single",
              "sort": "none"
            }
          }
        },
        "pluginVersion": {
          "default": "11.2.2",
          "title": "Pluginversion",
          "type": "string"
        },
        "targets": {
          "items": {
            "$ref": "#/$defs/Target"
          },
          "title": "Targets",
          "type": "array"
        },
        "title": {
          "default": "Example XY Chart for Trace2D Data",
          "title": "Title",
          "type": "string"
        },
        "transformations": {
          "default": [],
          "items": {
            "$ref": "#/$defs/Transformation"
          },
          "title": "Transformations",
          "type": "array"
        },
        "type": {
          "default": "xychart",
          "title": "Type",
          "type": "string"
        }
      },
      "required": [
        "targets"
      ],
      "title": "Panel",
      "type": "object"
    },
    "PointSize": {
      "description": "```json\n{\n    \"fixed\": 3\n}\n```",
      "properties": {
        "fixed": {
          "default": 3,
          "title": "Fixed",
          "type": "integer"
        }
      },
      "title": "PointSize",
      "type": "object"
    },
    "ScaleDistribution": {
      "description": "```json\n{\n    \"type\": \"linear\"\n}\n```",
      "properties": {
        "type": {
          "default": "linear",
          "title": "Type",
          "type": "string"
        }
      },
      "title": "ScaleDistribution",
      "type": "object"
    },
    "Series": {
      "description": "    ",
      "properties": {
        "x": {
          "$ref": "#/$defs/Matcher",
          "default": {
            "matcher": {
              "id": "byName",
              "options": "x"
            }
          }
        },
        "y": {
          "$ref": "#/$defs/Matcher",
          "default": {
            "matcher": {
              "id": "byName",
              "options": "y"
            }
          }
        }
      },
      "title": "Series",
      "type": "object"
    },
    "Target": {
      "description": "    ",
      "properties": {
        "columns": {
          "default": [],
          "items": {},
          "title": "Columns",
          "type": "array"
        },
        "datasource": {
          "$ref": "#/$defs/DataSource",
          "default": {
            "type": "yesoreyeram-infinity-datasource",
            "uid": "be1d76jvnf668b"
          }
        },
        "filters": {
          "default": [],
          "items": {},
          "title": "Filters",
          "type": "array"
        },
        "format": {
          "default": "table",
          "title": "Format",
          "type": "string"
        },
        "global_query_id": {
          "default": "",
          "title": "Global Query Id",
          "type": "string"
        },
        "hide": {
          "default": false,
          "title": "Hide",
          "type": "boolean"
        },
        "parser": {
          "default": "uql",
          "title": "Parser",
          "type": "string"
        },
        "refId": {
          "default": "A",
          "title": "Refid",
          "type": "string"
        },
        "root_selector": {
          "default": "",
          "title": "Root Selector",
          "type": "string"
        },
        "source": {
          "default": "url",
          "title": "Source",
          "type": "string"
        },
        "type": {
          "default": "json",
          "title": "Type",
          "type": "string"
        },
        "uql": {
          "default": "parse-json\n| project \"elements\"\n| extend \"label\"=\"pen.label\"\n| extend \"label1\"=substring(\"label\",0,2)\n| extend \"label2\"=substring(\"label\",3)\n| mv-expand \"points\"\n| extend \"x\"=\"points.x\", \"y\"=\"points.y\"\n#| project \"label1\", \"label2\", \"x\", \"y\", \"color\"=mul(\"label2\", 0.1)\n#| project \"label1\", \"x\", \"y\"\n| project \"label\", \"x\", \"y\", \"metadata\"\n\n\n",
          "title": "Uql",
          "type": "string"
        },
        "url": {
          "title": "Url",
          "type": "string"
        },
        "url_options": {
          "$ref": "#/$defs/URLOptions",
          "default": {
            "data": "",
            "method": "GET"
          }
        }
      },
      "required": [
        "url"
      ],
      "title": "Target",
      "type": "object"
    },
    "Threshold": {
      "description": "```json\n{\n    \"color\": \"green\",\n    \"value\": null\n}\n```",
      "properties": {
        "color": {
          "default": "green",
          "title": "Color",
          "type": "string"
        },
        "value": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Value"
        }
      },
      "title": "Threshold",
      "type": "object"
    },
    "Thresholds": {
      "description": "```json\n\"thresholds\": {\n    \"mode\": \"absolute\",\n    \"steps\": [\n        \n    ]\n}\n```",
      "properties": {
        "mode": {
          "default": "absolute",
          "title": "Mode",
          "type": "string"
        },
        "steps": {
          "default": [
            {
              "color": "green",
              "value": null
            }
          ],
          "items": {
            "$ref": "#/$defs/Threshold"
          },
          "title": "Steps",
          "type": "array"
        }
      },
      "title": "Thresholds",
      "type": "object"
    },
    "ToolTip": {
      "description": "    ",
      "properties": {
        "mode": {
          "default": "single",
          "title": "Mode",
          "type": "string"
        },
        "sort": {
          "default": "none",
          "title": "Sort",
          "type": "string"
        }
      },
      "title": "ToolTip",
      "type": "object"
    },
    "Transformation": {
      "description": "    \n    ",
      "properties": {
        "id": {
          "title": "Id",
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "title": "Transformation",
      "type": "object"
    },
    "URLOptions": {
      "description": "    ",
      "properties": {
        "data": {
          "default": "",
          "title": "Data",
          "type": "string"
        },
        "method": {
          "default": "GET",
          "title": "Method",
          "type": "string"
        }
      },
      "title": "URLOptions",
      "type": "object"
    }
  },
  "description": "    ",
  "properties": {
    "annotations": {
      "$ref": "#/$defs/Annotations",
      "default": {
        "list": [
          {
            "builtIn": 1,
            "datasource": {
              "type": "grafana",
              "uid": "-- Grafana --"
            },
            "enable": true,
            "hide": true,
            "iconColor": "rgba(0, 211, 255, 1)",
            "name": "Annotation & Alers",
            "type": "dashboard"
          }
        ]
      }
    },
    "description": {
      "default": "Try Parsing JSON Data",
      "title": "Description",
      "type": "string"
    },
    "editable": {
      "default": true,
      "title": "Editable",
      "type": "boolean"
    },
    "fiscalYearStartMonth": {
      "default": 0,
      "title": "Fiscalyearstartmonth",
      "type": "integer"
    },
    "graphTooltip": {
      "default": 0,
      "title": "Graphtooltip",
      "type": "integer"
    },
    "id": {
      "default": 1,
      "title": "Id",
      "type": "integer"
    },
    "links": {
      "default": [],
      "items": {},
      "title": "Links",
      "type": "array"
    },
    "panels": {
      "items": {
        "$ref": "#/$defs/Panel"
      },
      "title": "Panels",
      "type": "array"
    },
    "refresh": {
      "default": "",
      "title": "Refresh",
      "type": "string"
    },
    "schemaVersion": {
      "default": 39,
      "title": "Schemaversion",
      "type": "integer"
    },
    "tags": {
      "default": [],
      "items": {},
      "title": "Tags",
      "type": "array"
    },
    "templating": {
      "default": {
        "list": []
      },
      "title": "Templating",
      "type": "object"
    },
    "time": {
      "default": {
        "from": "now-6h",
        "to": "now"
      },
      "title": "Time",
      "type": "object"
    },
    "timepicker": {
      "default": {},
      "title": "Timepicker",
      "type": "object"
    },
    "timezone": {
      "default": "browser",
      "title": "Timezone",
      "type": "string"
    },
    "title": {
      "default": "DemoDashboard",
      "title": "Title",
      "type": "string"
    },
    "uid": {
      "default": "de1dapkdr47wgf",
      "title": "Uid",
      "type": "string"
    },
    "version": {
      "default": 20,
      "title": "Version",
      "type": "integer"
    },
    "weekStart": {
      "default": "",
      "title": "Weekstart",
      "type": "string"
    }
  },
  "required": [
    "panels"
  ],
  "title": "Dashboard",
  "type": "object"
}

Fields: