1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. DashboardPanel
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.DashboardPanel

rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Example Usage

    resource "rootly_dashboard" "overview" {
  name = "my_dashboard"
}

resource "rootly_dashboard_panel" "incidents_by_severity" {
  dashboard_id = rootly_dashboard.foo.id
  name         = "test"
  params {
    display = "line_chart"
    datasets {
      collection = "incidents"
      filter {
        operation = "and"
        rules {
          operation = "and"
          condition = "="
          key       = "status"
          value     = "started"
        }
      }
      group_by = "severity"
      aggregate {
        cumulative = false
        key        = "results"
        operation  = "count"
      }
    }
  }
}

    Create DashboardPanel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DashboardPanel(name: string, args: DashboardPanelArgs, opts?: CustomResourceOptions);
    @overload
def DashboardPanel(resource_name: str,
                   args: DashboardPanelArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def DashboardPanel(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   dashboard_id: Optional[str] = None,
                   params: Optional[DashboardPanelParamsArgs] = None,
                   name: Optional[str] = None,
                   position: Optional[DashboardPanelPositionArgs] = None)
    func NewDashboardPanel(ctx *Context, name string, args DashboardPanelArgs, opts ...ResourceOption) (*DashboardPanel, error)
    public DashboardPanel(string name, DashboardPanelArgs args, CustomResourceOptions? opts = null)
    public DashboardPanel(String name, DashboardPanelArgs args)
public DashboardPanel(String name, DashboardPanelArgs args, CustomResourceOptions options)

    type: rootly:DashboardPanel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DashboardPanelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DashboardPanelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DashboardPanelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardPanelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardPanelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dashboardPanelResource = new Rootly.DashboardPanel("dashboardPanelResource", new()
{
    DashboardId = "string",
    Params = new Rootly.Inputs.DashboardPanelParamsArgs
    {
        Datalabels = new Rootly.Inputs.DashboardPanelParamsDatalabelsArgs
        {
            Enabled = false,
        },
        Datasets = new[]
        {
            new Rootly.Inputs.DashboardPanelParamsDatasetArgs
            {
                Aggregate = new Rootly.Inputs.DashboardPanelParamsDatasetAggregateArgs
                {
                    Cumulative = false,
                    Key = "string",
                    Operation = "string",
                },
                Collection = "string",
                Filters = new[]
                {
                    new Rootly.Inputs.DashboardPanelParamsDatasetFilterArgs
                    {
                        Operation = "string",
                        Rules = new[]
                        {
                            new Rootly.Inputs.DashboardPanelParamsDatasetFilterRuleArgs
                            {
                                Condition = "string",
                                Key = "string",
                                Operation = "string",
                                Value = "string",
                            },
                        },
                    },
                },
                GroupBy = "string",
                Name = "string",
            },
        },
        Description = "string",
        Display = "string",
        Legend = new Rootly.Inputs.DashboardPanelParamsLegendArgs
        {
            Groups = "string",
        },
        TableFields = new[]
        {
            "string",
        },
    },
    Name = "string",
    Position = new Rootly.Inputs.DashboardPanelPositionArgs
    {
        H = 0,
        W = 0,
        X = 0,
        Y = 0,
    },
});

    example, err := rootly.NewDashboardPanel(ctx, "dashboardPanelResource", &rootly.DashboardPanelArgs{
	DashboardId: pulumi.String("string"),
	Params: &rootly.DashboardPanelParamsArgs{
		Datalabels: &rootly.DashboardPanelParamsDatalabelsArgs{
			Enabled: pulumi.Bool(false),
		},
		Datasets: rootly.DashboardPanelParamsDatasetArray{
			&rootly.DashboardPanelParamsDatasetArgs{
				Aggregate: &rootly.DashboardPanelParamsDatasetAggregateArgs{
					Cumulative: pulumi.Bool(false),
					Key:        pulumi.String("string"),
					Operation:  pulumi.String("string"),
				},
				Collection: pulumi.String("string"),
				Filters: rootly.DashboardPanelParamsDatasetFilterArray{
					&rootly.DashboardPanelParamsDatasetFilterArgs{
						Operation: pulumi.String("string"),
						Rules: rootly.DashboardPanelParamsDatasetFilterRuleArray{
							&rootly.DashboardPanelParamsDatasetFilterRuleArgs{
								Condition: pulumi.String("string"),
								Key:       pulumi.String("string"),
								Operation: pulumi.String("string"),
								Value:     pulumi.String("string"),
							},
						},
					},
				},
				GroupBy: pulumi.String("string"),
				Name:    pulumi.String("string"),
			},
		},
		Description: pulumi.String("string"),
		Display:     pulumi.String("string"),
		Legend: &rootly.DashboardPanelParamsLegendArgs{
			Groups: pulumi.String("string"),
		},
		TableFields: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Position: &rootly.DashboardPanelPositionArgs{
		H: pulumi.Float64(0),
		W: pulumi.Float64(0),
		X: pulumi.Float64(0),
		Y: pulumi.Float64(0),
	},
})

    var dashboardPanelResource = new DashboardPanel("dashboardPanelResource", DashboardPanelArgs.builder()
    .dashboardId("string")
    .params(DashboardPanelParamsArgs.builder()
        .datalabels(DashboardPanelParamsDatalabelsArgs.builder()
            .enabled(false)
            .build())
        .datasets(DashboardPanelParamsDatasetArgs.builder()
            .aggregate(DashboardPanelParamsDatasetAggregateArgs.builder()
                .cumulative(false)
                .key("string")
                .operation("string")
                .build())
            .collection("string")
            .filters(DashboardPanelParamsDatasetFilterArgs.builder()
                .operation("string")
                .rules(DashboardPanelParamsDatasetFilterRuleArgs.builder()
                    .condition("string")
                    .key("string")
                    .operation("string")
                    .value("string")
                    .build())
                .build())
            .groupBy("string")
            .name("string")
            .build())
        .description("string")
        .display("string")
        .legend(DashboardPanelParamsLegendArgs.builder()
            .groups("string")
            .build())
        .tableFields("string")
        .build())
    .name("string")
    .position(DashboardPanelPositionArgs.builder()
        .h(0.0)
        .w(0.0)
        .x(0.0)
        .y(0.0)
        .build())
    .build());

    dashboard_panel_resource = rootly.DashboardPanel("dashboardPanelResource",
    dashboard_id="string",
    params={
        "datalabels": {
            "enabled": False,
        },
        "datasets": [{
            "aggregate": {
                "cumulative": False,
                "key": "string",
                "operation": "string",
            },
            "collection": "string",
            "filters": [{
                "operation": "string",
                "rules": [{
                    "condition": "string",
                    "key": "string",
                    "operation": "string",
                    "value": "string",
                }],
            }],
            "group_by": "string",
            "name": "string",
        }],
        "description": "string",
        "display": "string",
        "legend": {
            "groups": "string",
        },
        "table_fields": ["string"],
    },
    name="string",
    position={
        "h": float(0),
        "w": float(0),
        "x": float(0),
        "y": float(0),
    })

    const dashboardPanelResource = new rootly.DashboardPanel("dashboardPanelResource", {
    dashboardId: "string",
    params: {
        datalabels: {
            enabled: false,
        },
        datasets: [{
            aggregate: {
                cumulative: false,
                key: "string",
                operation: "string",
            },
            collection: "string",
            filters: [{
                operation: "string",
                rules: [{
                    condition: "string",
                    key: "string",
                    operation: "string",
                    value: "string",
                }],
            }],
            groupBy: "string",
            name: "string",
        }],
        description: "string",
        display: "string",
        legend: {
            groups: "string",
        },
        tableFields: ["string"],
    },
    name: "string",
    position: {
        h: 0,
        w: 0,
        x: 0,
        y: 0,
    },
});

    type: rootly:DashboardPanel
properties:
    dashboardId: string
    name: string
    params:
        datalabels:
            enabled: false
        datasets:
            - aggregate:
                cumulative: false
                key: string
                operation: string
              collection: string
              filters:
                - operation: string
                  rules:
                    - condition: string
                      key: string
                      operation: string
                      value: string
              groupBy: string
              name: string
        description: string
        display: string
        legend:
            groups: string
        tableFields:
            - string
    position:
        h: 0
        w: 0
        x: 0
        "y": 0

    DashboardPanel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DashboardPanel resource accepts the following input properties:

    DashboardId string
    The panel dashboard
    Params DashboardPanelParams
    Name string
    The name of the dashboard_panel
    Position DashboardPanelPosition
    DashboardId string
    The panel dashboard
    Params DashboardPanelParamsArgs
    Name string
    The name of the dashboard_panel
    Position DashboardPanelPositionArgs
    dashboardId String
    The panel dashboard
    params DashboardPanelParams
    name String
    The name of the dashboard_panel
    position DashboardPanelPosition
    dashboardId string
    The panel dashboard
    params DashboardPanelParams
    name string
    The name of the dashboard_panel
    position DashboardPanelPosition
    dashboard_id str
    The panel dashboard
    params DashboardPanelParamsArgs
    name str
    The name of the dashboard_panel
    position DashboardPanelPositionArgs
    dashboardId String
    The panel dashboard
    params Property Map
    name String
    The name of the dashboard_panel
    position Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DashboardPanel resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DashboardPanel Resource

    Get an existing DashboardPanel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DashboardPanelState, opts?: CustomResourceOptions): DashboardPanel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dashboard_id: Optional[str] = None,
        name: Optional[str] = None,
        params: Optional[DashboardPanelParamsArgs] = None,
        position: Optional[DashboardPanelPositionArgs] = None) -> DashboardPanel
    func GetDashboardPanel(ctx *Context, name string, id IDInput, state *DashboardPanelState, opts ...ResourceOption) (*DashboardPanel, error)
    public static DashboardPanel Get(string name, Input<string> id, DashboardPanelState? state, CustomResourceOptions? opts = null)
    public static DashboardPanel get(String name, Output<String> id, DashboardPanelState state, CustomResourceOptions options)
    resources:  _:    type: rootly:DashboardPanel    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DashboardId string
    The panel dashboard
    Name string
    The name of the dashboard_panel
    Params DashboardPanelParams
    Position DashboardPanelPosition
    DashboardId string
    The panel dashboard
    Name string
    The name of the dashboard_panel
    Params DashboardPanelParamsArgs
    Position DashboardPanelPositionArgs
    dashboardId String
    The panel dashboard
    name String
    The name of the dashboard_panel
    params DashboardPanelParams
    position DashboardPanelPosition
    dashboardId string
    The panel dashboard
    name string
    The name of the dashboard_panel
    params DashboardPanelParams
    position DashboardPanelPosition
    dashboard_id str
    The panel dashboard
    name str
    The name of the dashboard_panel
    params DashboardPanelParamsArgs
    position DashboardPanelPositionArgs
    dashboardId String
    The panel dashboard
    name String
    The name of the dashboard_panel
    params Property Map
    position Property Map

    Supporting Types

    DashboardPanelParams, DashboardPanelParamsArgs

    Datalabels DashboardPanelParamsDatalabels
    Datasets List<DashboardPanelParamsDataset>
    Description string
    Display string
    Value must be one of lineChart, lineSteppedChart, columnChart, stackedColumnChart, monitoringChart, pieChart, table, aggregateValue.
    Legend DashboardPanelParamsLegend
    TableFields List<string>
    Datalabels DashboardPanelParamsDatalabels
    Datasets []DashboardPanelParamsDataset
    Description string
    Display string
    Value must be one of lineChart, lineSteppedChart, columnChart, stackedColumnChart, monitoringChart, pieChart, table, aggregateValue.
    Legend DashboardPanelParamsLegend
    TableFields []string
    datalabels DashboardPanelParamsDatalabels
    datasets List<DashboardPanelParamsDataset>
    description String
    display String
    Value must be one of lineChart, lineSteppedChart, columnChart, stackedColumnChart, monitoringChart, pieChart, table, aggregateValue.
    legend DashboardPanelParamsLegend
    tableFields List<String>
    datalabels DashboardPanelParamsDatalabels
    datasets DashboardPanelParamsDataset[]
    description string
    display string
    Value must be one of lineChart, lineSteppedChart, columnChart, stackedColumnChart, monitoringChart, pieChart, table, aggregateValue.
    legend DashboardPanelParamsLegend
    tableFields string[]
    datalabels DashboardPanelParamsDatalabels
    datasets Sequence[DashboardPanelParamsDataset]
    description str
    display str
    Value must be one of lineChart, lineSteppedChart, columnChart, stackedColumnChart, monitoringChart, pieChart, table, aggregateValue.
    legend DashboardPanelParamsLegend
    table_fields Sequence[str]
    datalabels Property Map
    datasets List<Property Map>
    description String
    display String
    Value must be one of lineChart, lineSteppedChart, columnChart, stackedColumnChart, monitoringChart, pieChart, table, aggregateValue.
    legend Property Map
    tableFields List<String>

    DashboardPanelParamsDatalabels, DashboardPanelParamsDatalabelsArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    DashboardPanelParamsDataset, DashboardPanelParamsDatasetArgs

    Aggregate DashboardPanelParamsDatasetAggregate
    Collection string
    Value must be one of alerts, incidents, incidentPostMortems, incidentActionItems, users.
    Filters List<DashboardPanelParamsDatasetFilter>
    GroupBy string
    Name string
    Aggregate DashboardPanelParamsDatasetAggregate
    Collection string
    Value must be one of alerts, incidents, incidentPostMortems, incidentActionItems, users.
    Filters []DashboardPanelParamsDatasetFilter
    GroupBy string
    Name string
    aggregate DashboardPanelParamsDatasetAggregate
    collection String
    Value must be one of alerts, incidents, incidentPostMortems, incidentActionItems, users.
    filters List<DashboardPanelParamsDatasetFilter>
    groupBy String
    name String
    aggregate DashboardPanelParamsDatasetAggregate
    collection string
    Value must be one of alerts, incidents, incidentPostMortems, incidentActionItems, users.
    filters DashboardPanelParamsDatasetFilter[]
    groupBy string
    name string
    aggregate DashboardPanelParamsDatasetAggregate
    collection str
    Value must be one of alerts, incidents, incidentPostMortems, incidentActionItems, users.
    filters Sequence[DashboardPanelParamsDatasetFilter]
    group_by str
    name str
    aggregate Property Map
    collection String
    Value must be one of alerts, incidents, incidentPostMortems, incidentActionItems, users.
    filters List<Property Map>
    groupBy String
    name String

    DashboardPanelParamsDatasetAggregate, DashboardPanelParamsDatasetAggregateArgs

    Cumulative bool
    Value must be one of true or false
    Key string
    Operation string
    Value must be one of count, sum, average.
    Cumulative bool
    Value must be one of true or false
    Key string
    Operation string
    Value must be one of count, sum, average.
    cumulative Boolean
    Value must be one of true or false
    key String
    operation String
    Value must be one of count, sum, average.
    cumulative boolean
    Value must be one of true or false
    key string
    operation string
    Value must be one of count, sum, average.
    cumulative bool
    Value must be one of true or false
    key str
    operation str
    Value must be one of count, sum, average.
    cumulative Boolean
    Value must be one of true or false
    key String
    operation String
    Value must be one of count, sum, average.

    DashboardPanelParamsDatasetFilter, DashboardPanelParamsDatasetFilterArgs

    Operation string
    Value must be one of and, or.
    Rules []DashboardPanelParamsDatasetFilterRule
    operation string
    Value must be one of and, or.
    rules DashboardPanelParamsDatasetFilterRule[]
    operation String
    Value must be one of and, or.
    rules List<Property Map>

    DashboardPanelParamsDatasetFilterRule, DashboardPanelParamsDatasetFilterRuleArgs

    Condition string
    Value must be one of =, !=, >=, <=, exists, notExists, contains, notContains, assigned, unassigned.
    Key string
    Operation string
    Value must be one of and, or.
    Value string
    Condition string
    Value must be one of =, !=, >=, <=, exists, notExists, contains, notContains, assigned, unassigned.
    Key string
    Operation string
    Value must be one of and, or.
    Value string
    condition String
    Value must be one of =, !=, >=, <=, exists, notExists, contains, notContains, assigned, unassigned.
    key String
    operation String
    Value must be one of and, or.
    value String
    condition string
    Value must be one of =, !=, >=, <=, exists, notExists, contains, notContains, assigned, unassigned.
    key string
    operation string
    Value must be one of and, or.
    value string
    condition str
    Value must be one of =, !=, >=, <=, exists, notExists, contains, notContains, assigned, unassigned.
    key str
    operation str
    Value must be one of and, or.
    value str
    condition String
    Value must be one of =, !=, >=, <=, exists, notExists, contains, notContains, assigned, unassigned.
    key String
    operation String
    Value must be one of and, or.
    value String

    DashboardPanelParamsLegend, DashboardPanelParamsLegendArgs

    Groups string
    Value must be one of all, charted.
    Groups string
    Value must be one of all, charted.
    groups String
    Value must be one of all, charted.
    groups string
    Value must be one of all, charted.
    groups str
    Value must be one of all, charted.
    groups String
    Value must be one of all, charted.

    DashboardPanelPosition, DashboardPanelPositionArgs

    H double
    W double
    X double
    Y double
    H float64
    W float64
    X float64
    Y float64
    h Double
    w Double
    x Double
    y Double
    h number
    w number
    x number
    y number
    h float
    w float
    x float
    y float
    h Number
    w Number
    x Number
    y Number

    Import

    rootly.DashboardPanel can be imported using the import command.

    $ pulumi import rootly:index/dashboardPanel:DashboardPanel primary a816421c-6ceb-481a-87c4-585e47451f24

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
    Schema (JSON)
    rootlyhq/pulumi-rootly
      Try Pulumi Cloud free. Your team will thank you.