Create/Update Dashboard

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Dashboard to create or update

Request to create or update a dashboard

dashboard

object

required

Dashboard object

Show child attributes

dashboard.metadata

object

required

Metadata for dashboard

Show child attributes

dashboard.metadata.id

string

required

Unique identifier for the dashboard

dashboard.metadata.title

string

Dashboard title

dashboard.metadata.folderPath

string

default:/dashboards/default/

Path to the folder where the dashboard is stored. Must start with /dashboards/. Must end with /. The generated filesystem path will be {folderPath}{id}.

Example:

{
  "id": "id",
  "title": "title",
  "folderPath": "/dashboards/default/"
}

dashboard.content

object

required

Widget for grouping other widgets

Show child attributes

dashboard.content.title

string

Group title

dashboard.content.widgets

object[]

Array of widgets in the group

Show child attributes

dashboard.content.widgets.type

enum<string>

required

Type of widget

Available options:

group,

markdown,

chart,

stat,

gauge,

trace,

log

dashboard.content.widgets.position

object

Position configuration for widget placement

Show child attributes

dashboard.content.widgets.position.type

enum<string>

required

Type of positioning

Available options:

absolute

dashboard.content.widgets.position.absolute

object

Absolute positioning coordinates. Each dashboard and a GroupWidget consists of 12 columns and 12 rows.

Show child attributes

dashboard.content.widgets.position.absolute.x

integer

required

X coordinate (0-12)

Required range: 0 <= x <= 12

dashboard.content.widgets.position.absolute.y

integer

required

Y coordinate (0-12)

Required range: 0 <= x <= 12

dashboard.content.widgets.position.absolute.w

integer

required

Width (0-12)

Required range: 0 <= x <= 12

dashboard.content.widgets.position.absolute.h

integer

required

Height (0-12)

Required range: 0 <= x <= 12

Example:

{ "w": 1, "x": 0, "h": 7, "y": 7 }

dashboard.content.widgets.group

any

dashboard.content.widgets.markdown

object

Widget for displaying markdown content. Supports any markdown that is compatible with the CommonMark (https://commonmark.org/) format.

Show child attributes

dashboard.content.widgets.markdown.content

string

required

Markdown content

Example:

{ "content": "content" }

dashboard.content.widgets.chart

object

Widget for displaying charts

Show child attributes

dashboard.content.widgets.chart.title

string

Chart title

dashboard.content.widgets.chart.chartType

enum<string>

default:line

Type of chart

Available options:

line,

area,

bar

dashboard.content.widgets.chart.expression

object

Expression timeseries data to be shown on the chart

Show child attributes

dashboard.content.widgets.chart.expression.metoroQLQueries

object[]

Array of MetoroQL queries

Show child attributes

dashboard.content.widgets.chart.expression.metoroQLQueries.query

string

required

MetoroQL query string

dashboard.content.widgets.chart.expression.metoroQLQueries.bucketSize

integer<int64>

default:0

Size of the time buckets in seconds (0 for auto)

dashboard.content.widgets.chart.expression.metoroQLQueries.displaySettings

object

Display settings for chart visualization

Show child attributes

dashboard.content.widgets.chart.expression.metoroQLQueries.displaySettings.label

string

Label for the metric on the legend

dashboard.content.widgets.chart.expression.metoroQLQueries.displaySettings.lineSettings

object

Settings for line display

Show child attributes

dashboard.content.widgets.chart.expression.metoroQLQueries.displaySettings.lineSettings.lineType

enum<string>

default:solid

Type of line

Available options:

solid,

dash

dashboard.content.widgets.chart.expression.metoroQLQueries.displaySettings.lineSettings.lineColour

string

Color of the line

dashboard.content.widgets.chart.expression.metoroQLQueries.displaySettings.lineSettings.lineDotColor

string

Color of dots on the line

dashboard.content.widgets.chart.expression.metoroQLQueries.displaySettings.lineSettings.lineDotSize

integer<int64>

default:0

Size of dots on the line (0 for no dots)

Example:

{
  "lineDotSize": 2,
  "lineType": "solid",
  "lineColour": "lineColour",
  "lineDotColor": "lineDotColor"
}

dashboard.content.widgets.chart.expression.metoroQLQueries.displaySettings.unitOverride

string

if specified, this unit will be used instead of the backend-provided unit

Example:

{
  "label": "label",
  "lineSettings": {
    "lineDotSize": 2,
    "lineType": "solid",
    "lineColour": "lineColour",
    "lineDotColor": "lineDotColor"
  }
}

Example:

{
  "metoroQLQueries": [
    {
      "displaySettings": {
        "label": "label",
        "lineSettings": {
          "lineDotSize": 2,
          "lineType": "solid",
          "lineColour": "lineColour",
          "lineDotColor": "lineDotColor"
        }
      },
      "query": "query",
      "bucketSize": 5
    },
    {
      "displaySettings": {
        "label": "label",
        "lineSettings": {
          "lineDotSize": 2,
          "lineType": "solid",
          "lineColour": "lineColour",
          "lineDotColor": "lineDotColor"
        }
      },
      "query": "query",
      "bucketSize": 5
    }
  ]
}

dashboard.content.widgets.chart.displaySettings

object

Display settings for chart widget visualization

Show child attributes

dashboard.content.widgets.chart.displaySettings.thresholds

object

Threshold settings for chart visualization

Show child attributes

dashboard.content.widgets.chart.displaySettings.thresholds.steps

object[]

Array of threshold steps

Show child attributes

dashboard.content.widgets.chart.displaySettings.thresholds.steps.value

number<double>

required

Threshold value

dashboard.content.widgets.chart.displaySettings.thresholds.steps.color

string

Color in hex format for this threshold level

dashboard.content.widgets.chart.displaySettings.thresholds.steps.name

string

Name for this threshold level

Example:

{
  "thresholds": {
    "steps": [
      {
        "value": 50,
        "color": "#2DD881",
        "name": "Low"
      },
      {
        "value": 80,
        "color": "#FFFF00",
        "name": "Medium"
      },
      {
        "value": 90,
        "color": "#FF0000",
        "name": "High"
      }
    ]
  }
}

Example:

{
  "expression": {
    "metoroQLQueries": [
      {
        "displaySettings": {
          "label": "label",
          "lineSettings": {
            "lineDotSize": 2,
            "lineType": "solid",
            "lineColour": "lineColour",
            "lineDotColor": "lineDotColor"
          }
        },
        "query": "query",
        "bucketSize": 5
      },
      {
        "displaySettings": {
          "label": "label",
          "lineSettings": {
            "lineDotSize": 2,
            "lineType": "solid",
            "lineColour": "lineColour",
            "lineDotColor": "lineDotColor"
          }
        },
        "query": "query",
        "bucketSize": 5
      }
    ]
  },
  "chartType": "line",
  "title": "title",
  "displaySettings": {
    "thresholds": {
      "steps": [
        {
          "value": 50,
          "color": "#2DD881",
          "name": "Low"
        },
        {
          "value": 80,
          "color": "#FFFF00",
          "name": "Medium"
        },
        {
          "value": 90,
          "color": "#FF0000",
          "name": "High"
        }
      ]
    }
  }
}

dashboard.content.widgets.stat

object

Widget for displaying statistics

Show child attributes

dashboard.content.widgets.stat.title

string

Stat title

dashboard.content.widgets.stat.expression

object

Query expression for stat data

Show child attributes

dashboard.content.widgets.stat.expression.reduceAggregation

enum<string>

required

Aggregation method

Available options:

max,

min,

avg,

sum,

count

dashboard.content.widgets.stat.expression.metoroQLQuery

object

Query configuration for MetoroQL

Show child attributes

dashboard.content.widgets.stat.expression.metoroQLQuery.query

string

required

MetoroQL query string

dashboard.content.widgets.stat.expression.metoroQLQuery.bucketSize

integer<int64>

default:0

Size of the time buckets in seconds (0 for auto)

dashboard.content.widgets.stat.expression.metoroQLQuery.displaySettings

object

Display settings for chart visualization

Show child attributes

dashboard.content.widgets.stat.expression.metoroQLQuery.displaySettings.label

string

Label for the metric on the legend

dashboard.content.widgets.stat.expression.metoroQLQuery.displaySettings.lineSettings

object

Settings for line display

Show child attributes

dashboard.content.widgets.stat.expression.metoroQLQuery.displaySettings.lineSettings.lineType

enum<string>

default:solid

Type of line

Available options:

solid,

dash

dashboard.content.widgets.stat.expression.metoroQLQuery.displaySettings.lineSettings.lineColour

string

Color of the line

dashboard.content.widgets.stat.expression.metoroQLQuery.displaySettings.lineSettings.lineDotColor

string

Color of dots on the line

dashboard.content.widgets.stat.expression.metoroQLQuery.displaySettings.lineSettings.lineDotSize

integer<int64>

default:0

Size of dots on the line (0 for no dots)

Example:

{
  "lineDotSize": 2,
  "lineType": "solid",
  "lineColour": "lineColour",
  "lineDotColor": "lineDotColor"
}

dashboard.content.widgets.stat.expression.metoroQLQuery.displaySettings.unitOverride

string

if specified, this unit will be used instead of the backend-provided unit

Example:

{
  "label": "label",
  "lineSettings": {
    "lineDotSize": 2,
    "lineType": "solid",
    "lineColour": "lineColour",
    "lineDotColor": "lineDotColor"
  }
}

Example:

{
  "displaySettings": {
    "label": "label",
    "lineSettings": {
      "lineDotSize": 2,
      "lineType": "solid",
      "lineColour": "lineColour",
      "lineDotColor": "lineDotColor"
    }
  },
  "query": "query",
  "bucketSize": 5
}

Example:

{
  "reduceAggregation": "max",
  "metoroQLQuery": {
    "displaySettings": {
      "label": "label",
      "lineSettings": {
        "lineDotSize": 2,
        "lineType": "solid",
        "lineColour": "lineColour",
        "lineDotColor": "lineDotColor"
      }
    },
    "query": "query",
    "bucketSize": 5
  }
}

dashboard.content.widgets.stat.displaySettings

object

Display settings for stat widget

Show child attributes

dashboard.content.widgets.stat.displaySettings.valueSettings

object[]

Settings for value display

Show child attributes

dashboard.content.widgets.stat.displaySettings.valueSettings.matchingOperators

object[]

Operators for matching conditions

Show child attributes

dashboard.content.widgets.stat.displaySettings.valueSettings.matchingOperators.operator

enum<string>

required

Comparison operator

Available options:

greaterThan,

lessThan,

greaterThanOrEqual,

lessThanOrEqual,

equals,

notEquals,

range

dashboard.content.widgets.stat.displaySettings.valueSettings.matchingOperators.threshold

number<double>

Threshold value for comparison (used with operators other than 'range')

dashboard.content.widgets.stat.displaySettings.valueSettings.matchingOperators.range

object

Range values for comparison when operator is 'range'

Show child attributes

dashboard.content.widgets.stat.displaySettings.valueSettings.matchingOperators.range.from

number<double>

required

Start value of the range

dashboard.content.widgets.stat.displaySettings.valueSettings.matchingOperators.range.to

number<double>

required

End value of the range

dashboard.content.widgets.stat.displaySettings.valueSettings.colorSettings

object

Color settings for matches

Show child attributes

dashboard.content.widgets.stat.displaySettings.valueSettings.colorSettings.type

enum<string>

Type of coloring

Available options:

text,

background

dashboard.content.widgets.stat.displaySettings.valueSettings.colorSettings.color

string

Color value

Example:

{ "color": "color", "type": "text" }

dashboard.content.widgets.stat.displaySettings.valueSettings.formatSpecifier

string

Format string for value display

Example:

"$value cores used"

dashboard.content.widgets.stat.displaySettings.columnSettings

object[]

Settings for columns

Show child attributes

dashboard.content.widgets.stat.displaySettings.columnSettings.column

string

required

Column identifier

dashboard.content.widgets.stat.displaySettings.columnSettings.title

string

Display title for column

dashboard.content.widgets.stat.displaySettings.columnSettings.hiddenByDefault

boolean

Whether column is hidden by default

dashboard.content.widgets.stat.displaySettings.columnSettings.regexExtractor

string

Regex pattern for extracting values

dashboard.content.widgets.stat.displaySettings.globalSettings

object

Global display settings

Show child attributes

dashboard.content.widgets.stat.displaySettings.globalSettings.valuePrecision

integer<int64>

default:0

Precision for numeric values

dashboard.content.widgets.stat.displaySettings.globalSettings.fontSize

enum<string>

Font size for display

Available options:

text-xs,

text-sm,

text-base,

text-lg,

text-xl,

text-2xl

dashboard.content.widgets.stat.displaySettings.globalSettings.filterableColumn

string

Column that can be filtered

dashboard.content.widgets.stat.displaySettings.globalSettings.unitOverride

string

Optional unit override for the displayed value.

Example:

{
  "unitOverride": "ms",
  "valuePrecision": 9,
  "filterableColumn": "filterableColumn",
  "fontSize": "text-xs"
}

Example:

{
  "globalSettings": {
    "valuePrecision": 9,
    "filterableColumn": "filterableColumn",
    "fontSize": "text-xs"
  },
  "valueSettings": [
    {
      "formatSpecifier": "$value cores used",
      "colorSettings": { "color": "color", "type": "text" },
      "matchingOperators": [
        { "threshold": 7, "operator": "greaterThan" },
        { "threshold": 7, "operator": "greaterThan" }
      ]
    },
    {
      "formatSpecifier": "$value cores used",
      "colorSettings": { "color": "color", "type": "text" },
      "matchingOperators": [
        { "threshold": 7, "operator": "greaterThan" },
        { "threshold": 7, "operator": "greaterThan" }
      ]
    }
  ],
  "columnSettings": [
    {
      "hiddenByDefault": true,
      "column": "column",
      "regexExtractor": "regexExtractor",
      "title": "title"
    },
    {
      "hiddenByDefault": true,
      "column": "column",
      "regexExtractor": "regexExtractor",
      "title": "title"
    }
  ]
}

Example:

{
  "expression": {
    "reduceAggregation": "max",
    "metoroQLQuery": { "query": "query", "bucketSize": 5 }
  },
  "displaySettings": {
    "globalSettings": {
      "valuePrecision": 9,
      "filterableColumn": "filterableColumn",
      "fontSize": "text-xs"
    },
    "valueSettings": [
      {
        "formatSpecifier": "$value cores used",
        "colorSettings": { "color": "color", "type": "text" },
        "matchingOperators": [
          { "threshold": 7, "operator": "greaterThan" },
          { "threshold": 7, "operator": "greaterThan" }
        ]
      },
      {
        "formatSpecifier": "$value cores used",
        "colorSettings": { "color": "color", "type": "text" },
        "matchingOperators": [
          { "threshold": 7, "operator": "greaterThan" },
          { "threshold": 7, "operator": "greaterThan" }
        ]
      }
    ],
    "columnSettings": [
      {
        "hiddenByDefault": true,
        "column": "column",
        "regexExtractor": "regexExtractor",
        "title": "title"
      },
      {
        "hiddenByDefault": true,
        "column": "column",
        "regexExtractor": "regexExtractor",
        "title": "title"
      }
    ]
  },
  "title": "title"
}

dashboard.content.widgets.gauge

object

Widget for displaying gauge metrics

Show child attributes

dashboard.content.widgets.gauge.title

string

Gauge title

dashboard.content.widgets.gauge.expression

object

Query expression for gauge data

Show child attributes

dashboard.content.widgets.gauge.expression.reduceAggregation

enum<string>

required

Aggregation method

Available options:

max,

min,

avg,

sum,

count

dashboard.content.widgets.gauge.expression.metoroQLQuery

object

Query configuration for MetoroQL

Show child attributes

dashboard.content.widgets.gauge.expression.metoroQLQuery.query

string

required

MetoroQL query string

dashboard.content.widgets.gauge.expression.metoroQLQuery.bucketSize

integer<int64>

default:0

Size of the time buckets in seconds (0 for auto)

dashboard.content.widgets.gauge.expression.metoroQLQuery.displaySettings

object

Display settings for chart visualization

Show child attributes

dashboard.content.widgets.gauge.expression.metoroQLQuery.displaySettings.label

string

Label for the metric on the legend

dashboard.content.widgets.gauge.expression.metoroQLQuery.displaySettings.lineSettings

object

Settings for line display

Show child attributes

dashboard.content.widgets.gauge.expression.metoroQLQuery.displaySettings.lineSettings.lineType

enum<string>

default:solid

Type of line

Available options:

solid,

dash

dashboard.content.widgets.gauge.expression.metoroQLQuery.displaySettings.lineSettings.lineColour

string

Color of the line

dashboard.content.widgets.gauge.expression.metoroQLQuery.displaySettings.lineSettings.lineDotColor

string

Color of dots on the line

dashboard.content.widgets.gauge.expression.metoroQLQuery.displaySettings.lineSettings.lineDotSize

integer<int64>

default:0

Size of dots on the line (0 for no dots)

Example:

{
  "lineDotSize": 2,
  "lineType": "solid",
  "lineColour": "lineColour",
  "lineDotColor": "lineDotColor"
}

dashboard.content.widgets.gauge.expression.metoroQLQuery.displaySettings.unitOverride

string

if specified, this unit will be used instead of the backend-provided unit

Example:

{
  "label": "label",
  "lineSettings": {
    "lineDotSize": 2,
    "lineType": "solid",
    "lineColour": "lineColour",
    "lineDotColor": "lineDotColor"
  }
}

Example:

{
  "displaySettings": {
    "label": "label",
    "lineSettings": {
      "lineDotSize": 2,
      "lineType": "solid",
      "lineColour": "lineColour",
      "lineDotColor": "lineDotColor"
    }
  },
  "query": "query",
  "bucketSize": 5
}

Example:

{
  "reduceAggregation": "max",
  "metoroQLQuery": { "query": "query", "bucketSize": 5 }
}

dashboard.content.widgets.gauge.displaySettings

object

Display settings for gauge widget

Show child attributes

dashboard.content.widgets.gauge.displaySettings.globalSettings

object

Global display settings for gauge widget

Show child attributes

dashboard.content.widgets.gauge.displaySettings.globalSettings.valuePrecision

integer<int64>

default:0

Precision for numeric values

dashboard.content.widgets.gauge.displaySettings.globalSettings.min

number<double>

Minimum value for gauge

dashboard.content.widgets.gauge.displaySettings.globalSettings.max

number<double>

Maximum value for gauge

dashboard.content.widgets.gauge.displaySettings.globalSettings.label

string

Label for the gauge

dashboard.content.widgets.gauge.displaySettings.globalSettings.showAbsoluteValue

boolean

When true, display raw value instead of percentage

dashboard.content.widgets.gauge.displaySettings.globalSettings.unitOverride

string

Optional unit override for the displayed value

Example:

{
  "valuePrecision": 9,
  "min": 0,
  "max": 100,
  "label": "Gauge Label",
  "showAbsoluteValue": false,
  "unitOverride": "ms"
}

Example:

{
  "globalSettings": {
    "valuePrecision": 9,
    "min": 0,
    "max": 100,
    "label": "Gauge Label"
  }
}

Example:

{
  "expression": {
    "reduceAggregation": "max",
    "metoroQLQuery": { "query": "query", "bucketSize": 5 }
  },
  "displaySettings": {
    "globalSettings": {
      "valuePrecision": 9,
      "min": 0,
      "max": 100,
      "label": "Gauge Label"
    }
  },
  "title": "title"
}

dashboard.content.widgets.trace

object

Widget for displaying trace data

Show child attributes

dashboard.content.widgets.trace.title

string

Trace widget title

dashboard.content.widgets.trace.expression

object

Query expression for trace data

Show child attributes

dashboard.content.widgets.trace.expression.metoroQLQuery

object

Query configuration for MetoroQL

Show child attributes

dashboard.content.widgets.trace.expression.metoroQLQuery.query

string

required

MetoroQL query string

dashboard.content.widgets.trace.expression.metoroQLQuery.bucketSize

integer<int64>

default:0

Size of the time buckets in seconds (0 for auto)

dashboard.content.widgets.trace.expression.metoroQLQuery.displaySettings

object

Display settings for chart visualization

Show child attributes

dashboard.content.widgets.trace.expression.metoroQLQuery.displaySettings.label

string

Label for the metric on the legend

dashboard.content.widgets.trace.expression.metoroQLQuery.displaySettings.lineSettings

object

Settings for line display

Show child attributes

dashboard.content.widgets.trace.expression.metoroQLQuery.displaySettings.lineSettings.lineType

enum<string>

default:solid

Type of line

Available options:

solid,

dash

dashboard.content.widgets.trace.expression.metoroQLQuery.displaySettings.lineSettings.lineColour

string

Color of the line

dashboard.content.widgets.trace.expression.metoroQLQuery.displaySettings.lineSettings.lineDotColor

string

Color of dots on the line

dashboard.content.widgets.trace.expression.metoroQLQuery.displaySettings.lineSettings.lineDotSize

integer<int64>

default:0

Size of dots on the line (0 for no dots)

Example:

{
  "lineDotSize": 2,
  "lineType": "solid",
  "lineColour": "lineColour",
  "lineDotColor": "lineDotColor"
}

dashboard.content.widgets.trace.expression.metoroQLQuery.displaySettings.unitOverride

string

if specified, this unit will be used instead of the backend-provided unit

Example:

{
  "label": "label",
  "lineSettings": {
    "lineDotSize": 2,
    "lineType": "solid",
    "lineColour": "lineColour",
    "lineDotColor": "lineDotColor"
  }
}

Example:

{
  "displaySettings": {
    "label": "label",
    "lineSettings": {
      "lineDotSize": 2,
      "lineType": "solid",
      "lineColour": "lineColour",
      "lineDotColor": "lineDotColor"
    }
  },
  "query": "query",
  "bucketSize": 5
}

Example:

{
  "metoroQLQuery": {
    "query": "traces{service.name=\"api\"}",
    "bucketSize": 5
  }
}

dashboard.content.widgets.trace.displaySettings

object

Display settings for trace widget

Show child attributes

dashboard.content.widgets.trace.displaySettings.hideSearchBar

boolean

Whether to hide the search bar

dashboard.content.widgets.trace.displaySettings.columns

string[]

Array of column names to display

Example:

{
  "hideSearchBar": false,
  "columns": ["time", "traceId", "service.name"]
}

Example:

{
  "expression": {
    "metoroQLQuery": {
      "query": "traces{service.name=\"api\"}",
      "bucketSize": 5
    }
  },
  "displaySettings": {
    "hideSearchBar": false,
    "columns": ["time", "traceId", "service.name", "status"]
  },
  "title": "API Traces"
}

dashboard.content.widgets.log

object

Widget for displaying log data

Show child attributes

dashboard.content.widgets.log.title

string

Log widget title

dashboard.content.widgets.log.expression

object

Query expression for log data

Show child attributes

dashboard.content.widgets.log.expression.metoroQLQuery

object

Query configuration for MetoroQL

Show child attributes

dashboard.content.widgets.log.expression.metoroQLQuery.query

string

required

MetoroQL query string

dashboard.content.widgets.log.expression.metoroQLQuery.bucketSize

integer<int64>

default:0

Size of the time buckets in seconds (0 for auto)

dashboard.content.widgets.log.expression.metoroQLQuery.displaySettings

object

Display settings for chart visualization

Show child attributes

dashboard.content.widgets.log.expression.metoroQLQuery.displaySettings.label

string

Label for the metric on the legend

dashboard.content.widgets.log.expression.metoroQLQuery.displaySettings.lineSettings

object

Settings for line display

Show child attributes

dashboard.content.widgets.log.expression.metoroQLQuery.displaySettings.lineSettings.lineType

enum<string>

default:solid

Type of line

Available options:

solid,

dash

dashboard.content.widgets.log.expression.metoroQLQuery.displaySettings.lineSettings.lineColour

string

Color of the line

dashboard.content.widgets.log.expression.metoroQLQuery.displaySettings.lineSettings.lineDotColor

string

Color of dots on the line

dashboard.content.widgets.log.expression.metoroQLQuery.displaySettings.lineSettings.lineDotSize

integer<int64>

default:0

Size of dots on the line (0 for no dots)

Example:

{
  "lineDotSize": 2,
  "lineType": "solid",
  "lineColour": "lineColour",
  "lineDotColor": "lineDotColor"
}

dashboard.content.widgets.log.expression.metoroQLQuery.displaySettings.unitOverride

string

if specified, this unit will be used instead of the backend-provided unit

Example:

{
  "label": "label",
  "lineSettings": {
    "lineDotSize": 2,
    "lineType": "solid",
    "lineColour": "lineColour",
    "lineDotColor": "lineDotColor"
  }
}

Example:

{
  "displaySettings": {
    "label": "label",
    "lineSettings": {
      "lineDotSize": 2,
      "lineType": "solid",
      "lineColour": "lineColour",
      "lineDotColor": "lineDotColor"
    }
  },
  "query": "query",
  "bucketSize": 5
}

Example:

{
  "metoroQLQuery": {
    "query": "logs{level=\"error\"}",
    "bucketSize": 5
  }
}

dashboard.content.widgets.log.displaySettings

object

Display settings for log widget

Show child attributes

dashboard.content.widgets.log.displaySettings.hideSearchBar

boolean

Whether to hide the search bar

dashboard.content.widgets.log.displaySettings.columns

string[]

Array of column names to display

Example:

{
  "hideSearchBar": false,
  "columns": ["level", "message", "timestamp"]
}

Example:

{
  "expression": {
    "metoroQLQuery": {
      "query": "logs{level=\"error\"}",
      "bucketSize": 5
    }
  },
  "displaySettings": {
    "hideSearchBar": false,
    "columns": ["level", "message", "timestamp"]
  },
  "title": "Error Logs"
}

dashboard.content.variables

object[]

Variables available in this group

Show child attributes

dashboard.content.variables.name

string

required

Name of the variable

dashboard.content.variables.overridable

boolean

default:true

Whether this variable can be overridden

dashboard.content.variables.defaultValue

string

Default value for this variable

dashboard.content.variables.selector

object

Show child attributes

dashboard.content.variables.selector.dynamic

object

Settings for dynamic variable value selection

Show child attributes

dashboard.content.variables.selector.dynamic.selectorQueries

string[]

required

Array of MetoroQL query strings (should have exactly 1 element)

Required array length: 1 element

dashboard.content.variables.selector.dynamic.attributeKey

string

required

Key of the attribute to use for value selection

Example:

{
  "selectorQueries": ["avg(container_info)"],
  "attributeKey": "attribute"
}

Example:

{
  "variables": [
    {
      "defaultValue": "defaultValue",
      "overridable": true,
      "name": "name",
      "selectorSettings": {
        "metricName": "metricName",
        "attribute": "attribute"
      }
    },
    {
      "defaultValue": "defaultValue",
      "overridable": true,
      "name": "name",
      "selectorSettings": {
        "metricName": "metricName",
        "attribute": "attribute"
      }
    }
  ],
  "title": "title",
  "widgets": []
}

dashboard.settings

object

Dashboard-wide settings

Show child attributes

dashboard.settings.defaultTimeRange

string

Default time range for the dashboard

dashboard.settings.hideGlobalEnvironmentSelector

boolean

default:false

Whether to hide the global environment selector

Example:

{
  "hideGlobalEnvironmentSelector": false,
  "defaultTimeRange": "defaultTimeRange"
}

Example:

{
  "settings": {
    "hideGlobalEnvironmentSelector": false,
    "defaultTimeRange": "defaultTimeRange"
  },
  "metadata": {
    "id": "id",
    "title": "title",
    "folderPath": "/dashboards/default/"
  },
  "content": {
    "variables": [
      {
        "defaultValue": "defaultValue",
        "overridable": true,
        "name": "name",
        "selectorSettings": {
          "metricName": "metricName",
          "attribute": "attribute"
        }
      },
      {
        "defaultValue": "defaultValue",
        "overridable": true,
        "name": "name",
        "selectorSettings": {
          "metricName": "metricName",
          "attribute": "attribute"
        }
      }
    ],
    "title": "title",
    "widgets": []
  }
}

Response

Dashboard created or updated successfully

Response from creating or updating a dashboard

string

required

Unique identifier of the created/updated dashboard

Logs

Environments

Alerts

Dashboards

Authorizations

Body

Response