Wavefront v3.1.8, Mar 4 25

Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi

wavefront.getDashboards

Explore with Pulumi AI

Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as wavefront from "@pulumi/wavefront";

// Get the information about all dashboards.
const example = wavefront.getDashboards({
    limit: 10,
    offset: 0,
});

import pulumi
import pulumi_wavefront as wavefront

# Get the information about all dashboards.
example = wavefront.get_dashboards(limit=10,
    offset=0)

package main

import (
	"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get the information about all dashboards.
		_, err := wavefront.GetDashboards(ctx, &wavefront.GetDashboardsArgs{
			Limit:  pulumi.IntRef(10),
			Offset: pulumi.IntRef(0),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Wavefront = Pulumi.Wavefront;

return await Deployment.RunAsync(() => 
{
    // Get the information about all dashboards.
    var example = Wavefront.GetDashboards.Invoke(new()
    {
        Limit = 10,
        Offset = 0,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.WavefrontFunctions;
import com.pulumi.wavefront.inputs.GetDashboardsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Get the information about all dashboards.
        final var example = WavefrontFunctions.getDashboards(GetDashboardsArgs.builder()
            .limit(10)
            .offset(0)
            .build());

    }
}

variables:
  # Get the information about all dashboards.
  example:
    fn::invoke:
      function: wavefront:getDashboards
      arguments:
        limit: 10
        offset: 0

Using getDashboards

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getDashboards(args: GetDashboardsArgs, opts?: InvokeOptions): Promise<GetDashboardsResult>
function getDashboardsOutput(args: GetDashboardsOutputArgs, opts?: InvokeOptions): Output<GetDashboardsResult>

def get_dashboards(limit: Optional[int] = None,
                   offset: Optional[int] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDashboardsResult
def get_dashboards_output(limit: Optional[pulumi.Input[int]] = None,
                   offset: Optional[pulumi.Input[int]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDashboardsResult]

func GetDashboards(ctx *Context, args *GetDashboardsArgs, opts ...InvokeOption) (*GetDashboardsResult, error)
func GetDashboardsOutput(ctx *Context, args *GetDashboardsOutputArgs, opts ...InvokeOption) GetDashboardsResultOutput

> Note: This function is named GetDashboards in the Go SDK.

public static class GetDashboards 
{
    public static Task<GetDashboardsResult> InvokeAsync(GetDashboardsArgs args, InvokeOptions? opts = null)
    public static Output<GetDashboardsResult> Invoke(GetDashboardsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
public static Output<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)

fn::invoke:
  function: wavefront:index/getDashboards:getDashboards
  arguments:
    # arguments dictionary

The following arguments are supported:

Limit int: Limit is the maximum number of results to be returned. Defaults to 100.
Offset int: Offset is the offset from the first result to be returned. Defaults to 0.

Limit int: Limit is the maximum number of results to be returned. Defaults to 100.
Offset int: Offset is the offset from the first result to be returned. Defaults to 0.

limit Integer: Limit is the maximum number of results to be returned. Defaults to 100.
offset Integer: Offset is the offset from the first result to be returned. Defaults to 0.

limit number: Limit is the maximum number of results to be returned. Defaults to 100.
offset number: Offset is the offset from the first result to be returned. Defaults to 0.

limit int: Limit is the maximum number of results to be returned. Defaults to 100.
offset int: Offset is the offset from the first result to be returned. Defaults to 0.

limit Number: Limit is the maximum number of results to be returned. Defaults to 100.
offset Number: Offset is the offset from the first result to be returned. Defaults to 0.

getDashboards Result

The following output properties are available:

Dashboards List<GetDashboardsDashboard>: List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
Id string: The provider-assigned unique ID for this managed resource.
Limit int
Offset int

Dashboards []GetDashboardsDashboard: List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
Id string: The provider-assigned unique ID for this managed resource.
Limit int
Offset int

dashboards List<GetDashboardsDashboard>: List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
id String: The provider-assigned unique ID for this managed resource.
limit Integer
offset Integer

dashboards GetDashboardsDashboard[]: List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
id string: The provider-assigned unique ID for this managed resource.
limit number
offset number

dashboards Sequence[GetDashboardsDashboard]: List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
id str: The provider-assigned unique ID for this managed resource.
limit int
offset int

dashboards List<Property Map>: List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
id String: The provider-assigned unique ID for this managed resource.
limit Number
offset Number

Supporting Types

GetDashboardsDashboard

CanModifies List<string>: A list of users that have modify ACL access to the dashboard.
CanViews List<string>: A list of users that have view ACL access to the dashboard.
ChartTitleBgColor string
ChartTitleColor string
ChartTitleScalar int
CreatedEpochMillis int
CreatorId string
Customer string
DefaultEndTime int
DefaultStartTime int
DefaultTimeWindow string
Deleted bool
Description string: Description of the chart.
DisplayDescription bool
DisplayQueryParameters bool: Whether the dashboard parameters section is opened by default when the dashboard is shown.
DisplaySectionTableOfContents bool: Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
EventFilterType string: How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.
EventQuery string
Favorite bool
Hidden bool
Id string
Name string: The name of the parameters.
NumCharts int
NumFavorites int
ParameterDetails List<GetDashboardsDashboardParameterDetail>: The current JSON representation of dashboard parameters. See parameter details.
Parameters Dictionary<string, string>
Sections List<GetDashboardsDashboardSection>
SystemOwned bool
Tags List<string>: A set of tags to assign to this resource.
UpdatedEpochMillis int
UpdaterId string
Url string: Unique identifier, also a URL slug of the dashboard.
ViewsLastDay int
ViewsLastMonth int
ViewsLastWeek int

CanModifies []string: A list of users that have modify ACL access to the dashboard.
CanViews []string: A list of users that have view ACL access to the dashboard.
ChartTitleBgColor string
ChartTitleColor string
ChartTitleScalar int
CreatedEpochMillis int
CreatorId string
Customer string
DefaultEndTime int
DefaultStartTime int
DefaultTimeWindow string
Deleted bool
Description string: Description of the chart.
DisplayDescription bool
DisplayQueryParameters bool: Whether the dashboard parameters section is opened by default when the dashboard is shown.
DisplaySectionTableOfContents bool: Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
EventFilterType string: How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.
EventQuery string
Favorite bool
Hidden bool
Id string
Name string: The name of the parameters.
NumCharts int
NumFavorites int
ParameterDetails []GetDashboardsDashboardParameterDetail: The current JSON representation of dashboard parameters. See parameter details.
Parameters map[string]string
Sections []GetDashboardsDashboardSection
SystemOwned bool
Tags []string: A set of tags to assign to this resource.
UpdatedEpochMillis int
UpdaterId string
Url string: Unique identifier, also a URL slug of the dashboard.
ViewsLastDay int
ViewsLastMonth int
ViewsLastWeek int

canModifies List<String>: A list of users that have modify ACL access to the dashboard.
canViews List<String>: A list of users that have view ACL access to the dashboard.
chartTitleBgColor String
chartTitleColor String
chartTitleScalar Integer
createdEpochMillis Integer
creatorId String
customer String
defaultEndTime Integer
defaultStartTime Integer
defaultTimeWindow String
deleted Boolean
description String: Description of the chart.
displayDescription Boolean
displayQueryParameters Boolean: Whether the dashboard parameters section is opened by default when the dashboard is shown.
displaySectionTableOfContents Boolean: Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
eventFilterType String: How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.
eventQuery String
favorite Boolean
hidden Boolean
id String
name String: The name of the parameters.
numCharts Integer
numFavorites Integer
parameterDetails List<GetDashboardsDashboardParameterDetail>: The current JSON representation of dashboard parameters. See parameter details.
parameters Map<String,String>
sections List<GetDashboardsDashboardSection>
systemOwned Boolean
tags List<String>: A set of tags to assign to this resource.
updatedEpochMillis Integer
updaterId String
url String: Unique identifier, also a URL slug of the dashboard.
viewsLastDay Integer
viewsLastMonth Integer
viewsLastWeek Integer

canModifies string[]: A list of users that have modify ACL access to the dashboard.
canViews string[]: A list of users that have view ACL access to the dashboard.
chartTitleBgColor string
chartTitleColor string
chartTitleScalar number
createdEpochMillis number
creatorId string
customer string
defaultEndTime number
defaultStartTime number
defaultTimeWindow string
deleted boolean
description string: Description of the chart.
displayDescription boolean
displayQueryParameters boolean: Whether the dashboard parameters section is opened by default when the dashboard is shown.
displaySectionTableOfContents boolean: Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
eventFilterType string: How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.
eventQuery string
favorite boolean
hidden boolean
id string
name string: The name of the parameters.
numCharts number
numFavorites number
parameterDetails GetDashboardsDashboardParameterDetail[]: The current JSON representation of dashboard parameters. See parameter details.
parameters {[key: string]: string}
sections GetDashboardsDashboardSection[]
systemOwned boolean
tags string[]: A set of tags to assign to this resource.
updatedEpochMillis number
updaterId string
url string: Unique identifier, also a URL slug of the dashboard.
viewsLastDay number
viewsLastMonth number
viewsLastWeek number

can_modifies Sequence[str]: A list of users that have modify ACL access to the dashboard.
can_views Sequence[str]: A list of users that have view ACL access to the dashboard.
chart_title_bg_color str
chart_title_color str
chart_title_scalar int
created_epoch_millis int
creator_id str
customer str
default_end_time int
default_start_time int
default_time_window str
deleted bool
description str: Description of the chart.
display_description bool
display_query_parameters bool: Whether the dashboard parameters section is opened by default when the dashboard is shown.
display_section_table_of_contents bool: Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
event_filter_type str: How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.
event_query str
favorite bool
hidden bool
id str
name str: The name of the parameters.
num_charts int
num_favorites int
parameter_details Sequence[GetDashboardsDashboardParameterDetail]: The current JSON representation of dashboard parameters. See parameter details.
parameters Mapping[str, str]
sections Sequence[GetDashboardsDashboardSection]
system_owned bool
tags Sequence[str]: A set of tags to assign to this resource.
updated_epoch_millis int
updater_id str
url str: Unique identifier, also a URL slug of the dashboard.
views_last_day int
views_last_month int
views_last_week int

canModifies List<String>: A list of users that have modify ACL access to the dashboard.
canViews List<String>: A list of users that have view ACL access to the dashboard.
chartTitleBgColor String
chartTitleColor String
chartTitleScalar Number
createdEpochMillis Number
creatorId String
customer String
defaultEndTime Number
defaultStartTime Number
defaultTimeWindow String
deleted Boolean
description String: Description of the chart.
displayDescription Boolean
displayQueryParameters Boolean: Whether the dashboard parameters section is opened by default when the dashboard is shown.
displaySectionTableOfContents Boolean: Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
eventFilterType String: How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.
eventQuery String
favorite Boolean
hidden Boolean
id String
name String: The name of the parameters.
numCharts Number
numFavorites Number
parameterDetails List<Property Map>: The current JSON representation of dashboard parameters. See parameter details.
parameters Map<String>
sections List<Property Map>
systemOwned Boolean
tags List<String>: A set of tags to assign to this resource.
updatedEpochMillis Number
updaterId String
url String: Unique identifier, also a URL slug of the dashboard.
viewsLastDay Number
viewsLastMonth Number
viewsLastWeek Number

GetDashboardsDashboardParameterDetail

DefaultValue string: The default value of the parameter.
DynamicFieldType string: For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.
HideFromView bool: If true the parameter will only be shown on the edit view of the dashboard.
Label string: The label for the parameter.
ParameterType string: The type of the parameter. SIMPLE, LIST, or DYNAMIC.
QueryValue string: For DYNAMIC parameter types, the query to execute to return values.
TagKey string: For TAG_KEY dynamic field types, the tag key to return.
ValuesToReadableStrings Dictionary<string, string>: A string to string map. At least one of the keys must match the value of default_value.

DefaultValue string: The default value of the parameter.
DynamicFieldType string: For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.
HideFromView bool: If true the parameter will only be shown on the edit view of the dashboard.
Label string: The label for the parameter.
ParameterType string: The type of the parameter. SIMPLE, LIST, or DYNAMIC.
QueryValue string: For DYNAMIC parameter types, the query to execute to return values.
TagKey string: For TAG_KEY dynamic field types, the tag key to return.
ValuesToReadableStrings map[string]string: A string to string map. At least one of the keys must match the value of default_value.

defaultValue String: The default value of the parameter.
dynamicFieldType String: For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.
hideFromView Boolean: If true the parameter will only be shown on the edit view of the dashboard.
label String: The label for the parameter.
parameterType String: The type of the parameter. SIMPLE, LIST, or DYNAMIC.
queryValue String: For DYNAMIC parameter types, the query to execute to return values.
tagKey String: For TAG_KEY dynamic field types, the tag key to return.
valuesToReadableStrings Map<String,String>: A string to string map. At least one of the keys must match the value of default_value.

defaultValue string: The default value of the parameter.
dynamicFieldType string: For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.
hideFromView boolean: If true the parameter will only be shown on the edit view of the dashboard.
label string: The label for the parameter.
parameterType string: The type of the parameter. SIMPLE, LIST, or DYNAMIC.
queryValue string: For DYNAMIC parameter types, the query to execute to return values.
tagKey string: For TAG_KEY dynamic field types, the tag key to return.
valuesToReadableStrings {[key: string]: string}: A string to string map. At least one of the keys must match the value of default_value.

default_value str: The default value of the parameter.
dynamic_field_type str: For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.
hide_from_view bool: If true the parameter will only be shown on the edit view of the dashboard.
label str: The label for the parameter.
parameter_type str: The type of the parameter. SIMPLE, LIST, or DYNAMIC.
query_value str: For DYNAMIC parameter types, the query to execute to return values.
tag_key str: For TAG_KEY dynamic field types, the tag key to return.
values_to_readable_strings Mapping[str, str]: A string to string map. At least one of the keys must match the value of default_value.

defaultValue String: The default value of the parameter.
dynamicFieldType String: For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.
hideFromView Boolean: If true the parameter will only be shown on the edit view of the dashboard.
label String: The label for the parameter.
parameterType String: The type of the parameter. SIMPLE, LIST, or DYNAMIC.
queryValue String: For DYNAMIC parameter types, the query to execute to return values.
tagKey String: For TAG_KEY dynamic field types, the tag key to return.
valuesToReadableStrings Map<String>: A string to string map. At least one of the keys must match the value of default_value.

GetDashboardsDashboardSection

Name string: The name of the parameters.
Rows List<GetDashboardsDashboardSectionRow>

Name string: The name of the parameters.
Rows []GetDashboardsDashboardSectionRow

name String: The name of the parameters.
rows List<GetDashboardsDashboardSectionRow>

name string: The name of the parameters.
rows GetDashboardsDashboardSectionRow[]

name str: The name of the parameters.
rows Sequence[GetDashboardsDashboardSectionRow]

name String: The name of the parameters.
rows List<Property Map>

GetDashboardsDashboardSectionRow

Charts List<GetDashboardsDashboardSectionRowChart>
HeightFactor int
Name string: The name of the parameters.

Charts []GetDashboardsDashboardSectionRowChart
HeightFactor int
Name string: The name of the parameters.

charts List<GetDashboardsDashboardSectionRowChart>
heightFactor Integer
name String: The name of the parameters.

charts GetDashboardsDashboardSectionRowChart[]
heightFactor number
name string: The name of the parameters.

charts Sequence[GetDashboardsDashboardSectionRowChart]
height_factor int
name str: The name of the parameters.

charts List<Property Map>
heightFactor Number
name String: The name of the parameters.

GetDashboardsDashboardSectionRowChart

Base int: The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
ChartAttributes string
ChartSettings List<GetDashboardsDashboardSectionRowChartChartSetting>
Description string: Description of the chart.
IncludeObsoleteMetrics bool
InterpolatePointsKey bool
Name string: The name of the parameters.
NoDefaultEvents bool
Sources List<GetDashboardsDashboardSectionRowChartSource>
Summarization string: Summarization strategy for the chart. MEAN is default.
Units string: String to label the units of the chart on the Y-Axis.

Base int: The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
ChartAttributes string
ChartSettings []GetDashboardsDashboardSectionRowChartChartSetting
Description string: Description of the chart.
IncludeObsoleteMetrics bool
InterpolatePointsKey bool
Name string: The name of the parameters.
NoDefaultEvents bool
Sources []GetDashboardsDashboardSectionRowChartSource
Summarization string: Summarization strategy for the chart. MEAN is default.
Units string: String to label the units of the chart on the Y-Axis.

base Integer: The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
chartAttributes String
chartSettings List<GetDashboardsDashboardSectionRowChartChartSetting>
description String: Description of the chart.
includeObsoleteMetrics Boolean
interpolatePointsKey Boolean
name String: The name of the parameters.
noDefaultEvents Boolean
sources List<GetDashboardsDashboardSectionRowChartSource>
summarization String: Summarization strategy for the chart. MEAN is default.
units String: String to label the units of the chart on the Y-Axis.

base number: The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
chartAttributes string
chartSettings GetDashboardsDashboardSectionRowChartChartSetting[]
description string: Description of the chart.
includeObsoleteMetrics boolean
interpolatePointsKey boolean
name string: The name of the parameters.
noDefaultEvents boolean
sources GetDashboardsDashboardSectionRowChartSource[]
summarization string: Summarization strategy for the chart. MEAN is default.
units string: String to label the units of the chart on the Y-Axis.

base int: The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
chart_attributes str
chart_settings Sequence[GetDashboardsDashboardSectionRowChartChartSetting]
description str: Description of the chart.
include_obsolete_metrics bool
interpolate_points_key bool
name str: The name of the parameters.
no_default_events bool
sources Sequence[GetDashboardsDashboardSectionRowChartSource]
summarization str: Summarization strategy for the chart. MEAN is default.
units str: String to label the units of the chart on the Y-Axis.

base Number: The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
chartAttributes String
chartSettings List<Property Map>
description String: Description of the chart.
includeObsoleteMetrics Boolean
interpolatePointsKey Boolean
name String: The name of the parameters.
noDefaultEvents Boolean
sources List<Property Map>
summarization String: Summarization strategy for the chart. MEAN is default.
units String: String to label the units of the chart on the Y-Axis.

GetDashboardsDashboardSectionRowChartChartSetting

AutoColumnTags bool: This setting is deprecated.
ColumnTags string: This setting is deprecated.
CustomTags List<string>: For the tabular view, a list of point tags to display when using the custom tag display mode.
ExpectedDataSpacing int: Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
FixedLegendDisplayStats List<string>: (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
FixedLegendEnabled bool: (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
FixedLegendFilterField string: (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.
FixedLegendFilterLimit int: (Optional) Number of series to include in the fixed legend.
FixedLegendFilterSort string: (Optional) Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.
FixedLegendHideLabel bool: (Optional) This setting is deprecated.
FixedLegendPosition string: (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.
FixedLegendUseRawStats bool: (Optional) If true, the legend uses non-summarized stats instead of summarized.
GroupBySource bool: For the tabular view, whether to group multi metrics into a single row by a common source. If set to false, each source is displayed in its own row. If set to true, multiple metrics for the same host are displayed as different columns in the same row.
InvertDynamicLegendHoverControl bool: (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
LineType string: Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.
Max double: Max value of the Y-axis. Set to null or leave blank for auto.
Min double: Min value of the Y-axis. Set to null or leave blank for auto.
NumTags int: For the tabular view defines how many point tags to display.
PlainMarkdownContent string: The markdown content for a Markdown display, in plain text.
ShowHosts bool: For the tabular view, whether to display sources. Default is true.
ShowLabels bool: For the tabular view, whether to display labels. Default is true.
ShowRawValues bool: For the tabular view, whether to display raw values. Default is false.
SortValuesDescending bool: For the tabular view, whether to display values in descending order. Default is false.
SparklineDecimalPrecision int: For the single stat view, the decimal precision of the displayed number.
SparklineDisplayColor string: For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
SparklineDisplayFontSize string: For the single stat view, the font size of the displayed text, in percent.
SparklineDisplayHorizontalPosition string: For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.
SparklineDisplayPostfix string: For the single stat view, a string to append to the displayed text.
SparklineDisplayPrefix string: For the single stat view, a string to add before the displayed text.
SparklineDisplayValueType string: For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.
SparklineDisplayVerticalPosition string: This setting is deprecated.
SparklineFillColor string: For the single stat view, the color of the background fill. Values should be in RGBA format.
SparklineLineColor string: For the single stat view, the color of the line. Values should be in RGBA format.
SparklineSize string: For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.
SparklineValueColorMapApplyTo string: For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.
SparklineValueColorMapColors List<string>: For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in RGBA format.
SparklineValueColorMapValues List<int>: This setting is deprecated.
SparklineValueColorMapValuesV2s List<double>: For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.
SparklineValueTextMapTexts List<string>: For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.
SparklineValueTextMapThresholds List<double>: For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.
StackType string: Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.
TagMode string: For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.
TimeBasedColoring bool: For x-y scatterplots, whether to color more recent points as darker than older points.
Type string: Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options areline, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.
WindowSize int: Width, in minutes, of the time window to use for last windowing.
Windowing string: For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.
Xmax double: For x-y scatterplots, max value for the X-axis. Set to null for auto.
Xmin double: For x-y scatterplots, min value for the X-axis. Set to null for auto.
Y0ScaleSiBy1024 bool
Y0UnitAutoscaling bool: (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
Y1Max double
Y1Min double
Y1ScaleSiBy1024 bool
Y1UnitAutoscaling bool: (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
Y1Units string: For plots with multiple Y-axes, units for right side Y-axis.
Ymax double: For x-y scatterplots, max value for the Y-axis. Set to null for auto.
Ymin double: For x-y scatterplots, min value for the Y-axis. Set to null for auto.

AutoColumnTags bool: This setting is deprecated.
ColumnTags string: This setting is deprecated.
CustomTags []string: For the tabular view, a list of point tags to display when using the custom tag display mode.
ExpectedDataSpacing int: Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
FixedLegendDisplayStats []string: (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
FixedLegendEnabled bool: (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
FixedLegendFilterField string: (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.
FixedLegendFilterLimit int: (Optional) Number of series to include in the fixed legend.
FixedLegendFilterSort string: (Optional) Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.
FixedLegendHideLabel bool: (Optional) This setting is deprecated.
FixedLegendPosition string: (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.
FixedLegendUseRawStats bool: (Optional) If true, the legend uses non-summarized stats instead of summarized.
GroupBySource bool: For the tabular view, whether to group multi metrics into a single row by a common source. If set to false, each source is displayed in its own row. If set to true, multiple metrics for the same host are displayed as different columns in the same row.
InvertDynamicLegendHoverControl bool: (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
LineType string: Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.
Max float64: Max value of the Y-axis. Set to null or leave blank for auto.
Min float64: Min value of the Y-axis. Set to null or leave blank for auto.
NumTags int: For the tabular view defines how many point tags to display.
PlainMarkdownContent string: The markdown content for a Markdown display, in plain text.
ShowHosts bool: For the tabular view, whether to display sources. Default is true.
ShowLabels bool: For the tabular view, whether to display labels. Default is true.
ShowRawValues bool: For the tabular view, whether to display raw values. Default is false.
SortValuesDescending bool: For the tabular view, whether to display values in descending order. Default is false.
SparklineDecimalPrecision int: For the single stat view, the decimal precision of the displayed number.
SparklineDisplayColor string: For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
SparklineDisplayFontSize string: For the single stat view, the font size of the displayed text, in percent.
SparklineDisplayHorizontalPosition string: For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.
SparklineDisplayPostfix string: For the single stat view, a string to append to the displayed text.
SparklineDisplayPrefix string: For the single stat view, a string to add before the displayed text.
SparklineDisplayValueType string: For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.
SparklineDisplayVerticalPosition string: This setting is deprecated.
SparklineFillColor string: For the single stat view, the color of the background fill. Values should be in RGBA format.
SparklineLineColor string: For the single stat view, the color of the line. Values should be in RGBA format.
SparklineSize string: For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.
SparklineValueColorMapApplyTo string: For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.
SparklineValueColorMapColors []string: For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in RGBA format.
SparklineValueColorMapValues []int: This setting is deprecated.
SparklineValueColorMapValuesV2s []float64: For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.
SparklineValueTextMapTexts []string: For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.
SparklineValueTextMapThresholds []float64: For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.
StackType string: Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.
TagMode string: For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.
TimeBasedColoring bool: For x-y scatterplots, whether to color more recent points as darker than older points.
Type string: Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options areline, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.
WindowSize int: Width, in minutes, of the time window to use for last windowing.
Windowing string: For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.
Xmax float64: For x-y scatterplots, max value for the X-axis. Set to null for auto.
Xmin float64: For x-y scatterplots, min value for the X-axis. Set to null for auto.
Y0ScaleSiBy1024 bool
Y0UnitAutoscaling bool: (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
Y1Max float64
Y1Min float64
Y1ScaleSiBy1024 bool
Y1UnitAutoscaling bool: (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
Y1Units string: For plots with multiple Y-axes, units for right side Y-axis.
Ymax float64: For x-y scatterplots, max value for the Y-axis. Set to null for auto.
Ymin float64: For x-y scatterplots, min value for the Y-axis. Set to null for auto.

autoColumnTags Boolean: This setting is deprecated.
columnTags String: This setting is deprecated.
customTags List<String>: For the tabular view, a list of point tags to display when using the custom tag display mode.
expectedDataSpacing Integer: Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
fixedLegendDisplayStats List<String>: (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
fixedLegendEnabled Boolean: (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
fixedLegendFilterField String: (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.
fixedLegendFilterLimit Integer: (Optional) Number of series to include in the fixed legend.
fixedLegendFilterSort String: (Optional) Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.
fixedLegendHideLabel Boolean: (Optional) This setting is deprecated.
fixedLegendPosition String: (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.
fixedLegendUseRawStats Boolean: (Optional) If true, the legend uses non-summarized stats instead of summarized.
groupBySource Boolean: For the tabular view, whether to group multi metrics into a single row by a common source. If set to false, each source is displayed in its own row. If set to true, multiple metrics for the same host are displayed as different columns in the same row.
invertDynamicLegendHoverControl Boolean: (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
lineType String: Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.
max Double: Max value of the Y-axis. Set to null or leave blank for auto.
min Double: Min value of the Y-axis. Set to null or leave blank for auto.
numTags Integer: For the tabular view defines how many point tags to display.
plainMarkdownContent String: The markdown content for a Markdown display, in plain text.
showHosts Boolean: For the tabular view, whether to display sources. Default is true.
showLabels Boolean: For the tabular view, whether to display labels. Default is true.
showRawValues Boolean: For the tabular view, whether to display raw values. Default is false.
sortValuesDescending Boolean: For the tabular view, whether to display values in descending order. Default is false.
sparklineDecimalPrecision Integer: For the single stat view, the decimal precision of the displayed number.
sparklineDisplayColor String: For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
sparklineDisplayFontSize String: For the single stat view, the font size of the displayed text, in percent.
sparklineDisplayHorizontalPosition String: For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.
sparklineDisplayPostfix String: For the single stat view, a string to append to the displayed text.
sparklineDisplayPrefix String: For the single stat view, a string to add before the displayed text.
sparklineDisplayValueType String: For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.
sparklineDisplayVerticalPosition String: This setting is deprecated.
sparklineFillColor String: For the single stat view, the color of the background fill. Values should be in RGBA format.
sparklineLineColor String: For the single stat view, the color of the line. Values should be in RGBA format.
sparklineSize String: For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.
sparklineValueColorMapApplyTo String: For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.
sparklineValueColorMapColors List<String>: For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in RGBA format.
sparklineValueColorMapValues List<Integer>: This setting is deprecated.
sparklineValueColorMapValuesV2s List<Double>: For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.
sparklineValueTextMapTexts List<String>: For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.
sparklineValueTextMapThresholds List<Double>: For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.
stackType String: Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.
tagMode String: For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.
timeBasedColoring Boolean: For x-y scatterplots, whether to color more recent points as darker than older points.
type String: Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options areline, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.
windowSize Integer: Width, in minutes, of the time window to use for last windowing.
windowing String: For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.
xmax Double: For x-y scatterplots, max value for the X-axis. Set to null for auto.
xmin Double: For x-y scatterplots, min value for the X-axis. Set to null for auto.
y0ScaleSiBy1024 Boolean
y0UnitAutoscaling Boolean: (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
y1Max Double
y1Min Double
y1ScaleSiBy1024 Boolean
y1UnitAutoscaling Boolean: (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
y1Units String: For plots with multiple Y-axes, units for right side Y-axis.
ymax Double: For x-y scatterplots, max value for the Y-axis. Set to null for auto.
ymin Double: For x-y scatterplots, min value for the Y-axis. Set to null for auto.

autoColumnTags boolean: This setting is deprecated.
columnTags string: This setting is deprecated.
customTags string[]: For the tabular view, a list of point tags to display when using the custom tag display mode.
expectedDataSpacing number: Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
fixedLegendDisplayStats string[]: (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
fixedLegendEnabled boolean: (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
fixedLegendFilterField string: (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.
fixedLegendFilterLimit number: (Optional) Number of series to include in the fixed legend.
fixedLegendFilterSort string: (Optional) Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.
fixedLegendHideLabel boolean: (Optional) This setting is deprecated.
fixedLegendPosition string: (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.
fixedLegendUseRawStats boolean: (Optional) If true, the legend uses non-summarized stats instead of summarized.
groupBySource boolean: For the tabular view, whether to group multi metrics into a single row by a common source. If set to false, each source is displayed in its own row. If set to true, multiple metrics for the same host are displayed as different columns in the same row.
invertDynamicLegendHoverControl boolean: (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
lineType string: Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.
max number: Max value of the Y-axis. Set to null or leave blank for auto.
min number: Min value of the Y-axis. Set to null or leave blank for auto.
numTags number: For the tabular view defines how many point tags to display.
plainMarkdownContent string: The markdown content for a Markdown display, in plain text.
showHosts boolean: For the tabular view, whether to display sources. Default is true.
showLabels boolean: For the tabular view, whether to display labels. Default is true.
showRawValues boolean: For the tabular view, whether to display raw values. Default is false.
sortValuesDescending boolean: For the tabular view, whether to display values in descending order. Default is false.
sparklineDecimalPrecision number: For the single stat view, the decimal precision of the displayed number.
sparklineDisplayColor string: For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
sparklineDisplayFontSize string: For the single stat view, the font size of the displayed text, in percent.
sparklineDisplayHorizontalPosition string: For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.
sparklineDisplayPostfix string: For the single stat view, a string to append to the displayed text.
sparklineDisplayPrefix string: For the single stat view, a string to add before the displayed text.
sparklineDisplayValueType string: For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.
sparklineDisplayVerticalPosition string: This setting is deprecated.
sparklineFillColor string: For the single stat view, the color of the background fill. Values should be in RGBA format.
sparklineLineColor string: For the single stat view, the color of the line. Values should be in RGBA format.
sparklineSize string: For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.
sparklineValueColorMapApplyTo string: For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.
sparklineValueColorMapColors string[]: For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in RGBA format.
sparklineValueColorMapValues number[]: This setting is deprecated.
sparklineValueColorMapValuesV2s number[]: For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.
sparklineValueTextMapTexts string[]: For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.
sparklineValueTextMapThresholds number[]: For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.
stackType string: Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.
tagMode string: For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.
timeBasedColoring boolean: For x-y scatterplots, whether to color more recent points as darker than older points.
type string: Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options areline, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.
windowSize number: Width, in minutes, of the time window to use for last windowing.
windowing string: For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.
xmax number: For x-y scatterplots, max value for the X-axis. Set to null for auto.
xmin number: For x-y scatterplots, min value for the X-axis. Set to null for auto.
y0ScaleSiBy1024 boolean
y0UnitAutoscaling boolean: (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
y1Max number
y1Min number
y1ScaleSiBy1024 boolean
y1UnitAutoscaling boolean: (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
y1Units string: For plots with multiple Y-axes, units for right side Y-axis.
ymax number: For x-y scatterplots, max value for the Y-axis. Set to null for auto.
ymin number: For x-y scatterplots, min value for the Y-axis. Set to null for auto.

auto_column_tags bool: This setting is deprecated.
column_tags str: This setting is deprecated.
custom_tags Sequence[str]: For the tabular view, a list of point tags to display when using the custom tag display mode.
expected_data_spacing int: Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
fixed_legend_display_stats Sequence[str]: (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
fixed_legend_enabled bool: (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
fixed_legend_filter_field str: (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.
fixed_legend_filter_limit int: (Optional) Number of series to include in the fixed legend.
fixed_legend_filter_sort str: (Optional) Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.
fixed_legend_hide_label bool: (Optional) This setting is deprecated.
fixed_legend_position str: (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.
fixed_legend_use_raw_stats bool: (Optional) If true, the legend uses non-summarized stats instead of summarized.
group_by_source bool: For the tabular view, whether to group multi metrics into a single row by a common source. If set to false, each source is displayed in its own row. If set to true, multiple metrics for the same host are displayed as different columns in the same row.
invert_dynamic_legend_hover_control bool: (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
line_type str: Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.
max float: Max value of the Y-axis. Set to null or leave blank for auto.
min float: Min value of the Y-axis. Set to null or leave blank for auto.
num_tags int: For the tabular view defines how many point tags to display.
plain_markdown_content str: The markdown content for a Markdown display, in plain text.
show_hosts bool: For the tabular view, whether to display sources. Default is true.
show_labels bool: For the tabular view, whether to display labels. Default is true.
show_raw_values bool: For the tabular view, whether to display raw values. Default is false.
sort_values_descending bool: For the tabular view, whether to display values in descending order. Default is false.
sparkline_decimal_precision int: For the single stat view, the decimal precision of the displayed number.
sparkline_display_color str: For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
sparkline_display_font_size str: For the single stat view, the font size of the displayed text, in percent.
sparkline_display_horizontal_position str: For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.
sparkline_display_postfix str: For the single stat view, a string to append to the displayed text.
sparkline_display_prefix str: For the single stat view, a string to add before the displayed text.
sparkline_display_value_type str: For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.
sparkline_display_vertical_position str: This setting is deprecated.
sparkline_fill_color str: For the single stat view, the color of the background fill. Values should be in RGBA format.
sparkline_line_color str: For the single stat view, the color of the line. Values should be in RGBA format.
sparkline_size str: For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.
sparkline_value_color_map_apply_to str: For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.
sparkline_value_color_map_colors Sequence[str]: For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in RGBA format.
sparkline_value_color_map_values Sequence[int]: This setting is deprecated.
sparkline_value_color_map_values_v2s Sequence[float]: For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.
sparkline_value_text_map_texts Sequence[str]: For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.
sparkline_value_text_map_thresholds Sequence[float]: For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.
stack_type str: Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.
tag_mode str: For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.
time_based_coloring bool: For x-y scatterplots, whether to color more recent points as darker than older points.
type str: Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options areline, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.
window_size int: Width, in minutes, of the time window to use for last windowing.
windowing str: For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.
xmax float: For x-y scatterplots, max value for the X-axis. Set to null for auto.
xmin float: For x-y scatterplots, min value for the X-axis. Set to null for auto.
y0_scale_si_by1024 bool
y0_unit_autoscaling bool: (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
y1_max float
y1_min float
y1_scale_si_by1024 bool
y1_unit_autoscaling bool: (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
y1_units str: For plots with multiple Y-axes, units for right side Y-axis.
ymax float: For x-y scatterplots, max value for the Y-axis. Set to null for auto.
ymin float: For x-y scatterplots, min value for the Y-axis. Set to null for auto.

autoColumnTags Boolean: This setting is deprecated.
columnTags String: This setting is deprecated.
customTags List<String>: For the tabular view, a list of point tags to display when using the custom tag display mode.
expectedDataSpacing Number: Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
fixedLegendDisplayStats List<String>: (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
fixedLegendEnabled Boolean: (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
fixedLegendFilterField String: (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.
fixedLegendFilterLimit Number: (Optional) Number of series to include in the fixed legend.
fixedLegendFilterSort String: (Optional) Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.
fixedLegendHideLabel Boolean: (Optional) This setting is deprecated.
fixedLegendPosition String: (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.
fixedLegendUseRawStats Boolean: (Optional) If true, the legend uses non-summarized stats instead of summarized.
groupBySource Boolean: For the tabular view, whether to group multi metrics into a single row by a common source. If set to false, each source is displayed in its own row. If set to true, multiple metrics for the same host are displayed as different columns in the same row.
invertDynamicLegendHoverControl Boolean: (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
lineType String: Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.
max Number: Max value of the Y-axis. Set to null or leave blank for auto.
min Number: Min value of the Y-axis. Set to null or leave blank for auto.
numTags Number: For the tabular view defines how many point tags to display.
plainMarkdownContent String: The markdown content for a Markdown display, in plain text.
showHosts Boolean: For the tabular view, whether to display sources. Default is true.
showLabels Boolean: For the tabular view, whether to display labels. Default is true.
showRawValues Boolean: For the tabular view, whether to display raw values. Default is false.
sortValuesDescending Boolean: For the tabular view, whether to display values in descending order. Default is false.
sparklineDecimalPrecision Number: For the single stat view, the decimal precision of the displayed number.
sparklineDisplayColor String: For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
sparklineDisplayFontSize String: For the single stat view, the font size of the displayed text, in percent.
sparklineDisplayHorizontalPosition String: For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.
sparklineDisplayPostfix String: For the single stat view, a string to append to the displayed text.
sparklineDisplayPrefix String: For the single stat view, a string to add before the displayed text.
sparklineDisplayValueType String: For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.
sparklineDisplayVerticalPosition String: This setting is deprecated.
sparklineFillColor String: For the single stat view, the color of the background fill. Values should be in RGBA format.
sparklineLineColor String: For the single stat view, the color of the line. Values should be in RGBA format.
sparklineSize String: For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.
sparklineValueColorMapApplyTo String: For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.
sparklineValueColorMapColors List<String>: For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in RGBA format.
sparklineValueColorMapValues List<Number>: This setting is deprecated.
sparklineValueColorMapValuesV2s List<Number>: For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.
sparklineValueTextMapTexts List<String>: For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.
sparklineValueTextMapThresholds List<Number>: For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.
stackType String: Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.
tagMode String: For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.
timeBasedColoring Boolean: For x-y scatterplots, whether to color more recent points as darker than older points.
type String: Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options areline, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.
windowSize Number: Width, in minutes, of the time window to use for last windowing.
windowing String: For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.
xmax Number: For x-y scatterplots, max value for the X-axis. Set to null for auto.
xmin Number: For x-y scatterplots, min value for the X-axis. Set to null for auto.
y0ScaleSiBy1024 Boolean
y0UnitAutoscaling Boolean: (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
y1Max Number
y1Min Number
y1ScaleSiBy1024 Boolean
y1UnitAutoscaling Boolean: (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
y1Units String: For plots with multiple Y-axes, units for right side Y-axis.
ymax Number: For x-y scatterplots, max value for the Y-axis. Set to null for auto.
ymin Number: For x-y scatterplots, min value for the Y-axis. Set to null for auto.

GetDashboardsDashboardSectionRowChartSource

Disabled bool: Whether the source is disabled.
Name string: The name of the parameters.
Query string: Query expression to plot on the chart.
QuerybuilderEnabled bool
ScatterPlotSource string: For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.
SecondaryAxis bool
SourceColor string
SourceDescription string: A description for the purpose of this source.

Disabled bool: Whether the source is disabled.
Name string: The name of the parameters.
Query string: Query expression to plot on the chart.
QuerybuilderEnabled bool
ScatterPlotSource string: For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.
SecondaryAxis bool
SourceColor string
SourceDescription string: A description for the purpose of this source.

disabled Boolean: Whether the source is disabled.
name String: The name of the parameters.
query String: Query expression to plot on the chart.
querybuilderEnabled Boolean
scatterPlotSource String: For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.
secondaryAxis Boolean
sourceColor String
sourceDescription String: A description for the purpose of this source.

disabled boolean: Whether the source is disabled.
name string: The name of the parameters.
query string: Query expression to plot on the chart.
querybuilderEnabled boolean
scatterPlotSource string: For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.
secondaryAxis boolean
sourceColor string
sourceDescription string: A description for the purpose of this source.

disabled bool: Whether the source is disabled.
name str: The name of the parameters.
query str: Query expression to plot on the chart.
querybuilder_enabled bool
scatter_plot_source str: For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.
secondary_axis bool
source_color str
source_description str: A description for the purpose of this source.

disabled Boolean: Whether the source is disabled.
name String: The name of the parameters.
query String: Query expression to plot on the chart.
querybuilderEnabled Boolean
scatterPlotSource String: For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.
secondaryAxis Boolean
sourceColor String
sourceDescription String: A description for the purpose of this source.

Package Details

Repository: Wavefront pulumi/pulumi-wavefront
License: Apache-2.0
Notes: This Pulumi package is based on the wavefront Terraform Provider.

Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi

pulumi/pulumi-wavefront

wavefront.getDashboards

On this page

On this page

Example Usage

Using getDashboards

getDashboards Result

Supporting Types

GetDashboardsDashboard

GetDashboardsDashboardParameterDetail

GetDashboardsDashboardSection

GetDashboardsDashboardSectionRow

GetDashboardsDashboardSectionRowChart

GetDashboardsDashboardSectionRowChartChartSetting

GetDashboardsDashboardSectionRowChartSource

Package Details

On this page

On this page