dashboard

package
v1.34.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 5, 2024 License: Apache-2.0 Imports: 2 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AclEntry added in v1.9.0

type AclEntry struct {
	// ID of the user, team, or organization for which you're granting permissions.
	PrincipalId string `json:"principalId"`
	// Clarify whether this permission configuration is for a user, a team, or an organization. Enum: [USER, TEAM, ORG]
	PrincipalType string `json:"principalType"`
	// Action the user, team, or organization can take with the dashboard group. Enum: [READ, WRITE]
	Actions []string `json:"actions"`
}

AclEntry - a single permission configuration entry

type AuthorizedWriters

type AuthorizedWriters struct {
	// An array of team IDs that have write access to this dashboard
	Teams []string `json:"teams,omitempty"`
	// An array of user IDs that have write access to this dashboard
	Users []string `json:"users,omitempty"`
}

If your organization has the \"write permissions\" feature enabled, you can use this object to specify the user and team IDs that have write access to the object you're specifying.

type ChartEventOverlay

type ChartEventOverlay struct {
	// Controls the display of vertical event lines in the charts that belong to the dashboard. If `true`, the system displays event lines; otherwise, no event lines appear.
	EventLine   bool                  `json:"eventLine,omitempty"`
	EventSignal *DashboardEventSignal `json:"eventSignal"`
	// The color used to display the event marker in charts. If you set `eventLine` to `true`, the system also uses this color for the event line it displays in charts. The value is an index into an array of 16 pre-defined colors shown in the following table:<br> <table> <thead> <th style=\"text-align:center;\">Index</th><th>RGB hex value</th> </thead> <tbody> <tr><td>0</td><td>#999999</td></tr> <tr><td>1</td><td>#0077c2</td></tr> <tr><td>2</td><td>#00b9ff</td></tr> <tr><td>3</td><td>#6ca2b7</td></tr> <tr><td>4</td><td>#b04600</td></tr> <tr><td>5</td><td>#f47e00</td></tr> <tr><td>6</td><td>#e5b312</td></tr> <tr><td>7</td><td>#bd468d</td></tr> <tr><td>8</td><td>#e9008a</td></tr> <tr><td>9</td><td>#ff8dd1</td></tr> <tr><td>10</td><td>#876ff3</td></tr> <tr><td>11</td><td>#a747ff</td></tr> <tr><td>12</td><td>#ab99bc</td></tr> <tr><td>13</td><td>#007c1d</td></tr> <tr><td>14</td><td>#05ce00</td></tr> <tr><td>15</td><td>#0dba8f</td></tr> </tbody> </table> **Note:** Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, refer to the color palette documentation at the end of the [Charts Overview](https://developers.signalfx.com/reference#charts-overview-1).
	EventColorIndex *int32 `json:"eventColorIndex,omitempty"`
	// Text that identifies this event overlay in the dropdown menu you use to select an overlay for the dashboard
	Label string `json:"label,omitempty"`
	// Unique ID for this event overlay. Use this ID with any element of the `selectedEventOverlays` property to apply this overlay to a dashboard.<br> **Note:** The system generates this value if you don't specify one.
	OverlayId string `json:"overlayId,omitempty"`
	// An array of objects that specify filters to apply to events for this event overlay.
	Sources []*EventOverlayFilter `json:"sources,omitempty"`
}

An object that contains the settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: * `CreateDashboardBody.EventOverlays`: Inactive event overlays that you want to define for use at a laster time. * `CreateDashboardBody.selectedEventOverlays`: Active event overlays that you want to apply immediately to charts in the dashboard.

type ChartsFilters

type ChartsFilters struct {
	// List of filter objects to apply to the charts in the dashboard. Each object specifies a single filter for a default or user-defined dimension or custom property.
	Sources []*ChartsSingleFilter `json:"sources,omitempty"`
	Time    *ChartsFiltersTime    `json:"time,omitempty"`
	// Array of web UI-oriented filters that appear at the top of the dashboard. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the web UI, and other properties that control the web UI display. To see a more detailed description of the options, see the property descriptions for the `ChartsWebUIFilter` model.
	Variables []*ChartsWebUiFilter `json:"variables,omitempty"`
}

Specifies the properties of filters to apply to the dashboard.<br> Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify *ad hoc* filters or save them as variables for repeated use of the filter criteria. <br> You can also use filters to apply a custom time window to all of the charts in the dashboard.

type ChartsFiltersTime

type ChartsFiltersTime struct {
	// The end of the time range to show for all charts in the dashboard. If you don't specify a value for this property, the system defaults to the value for each chart's `end` property.<br> **Note:** The specified type for `end` is `string`, but the system also accepts a 64-bit signed integer that represents a time in Unix time format (milliseconds since the Unix epoch UTC+0)
	End util.StringOrInteger `json:"end,omitempty"`
	// The start of the time range to show for all charts in the dashboard. If you don't specify a value for this property, the system defaults to the value for each chart's `start` property.<br> **Note:** The specified type for `start` is `string`, but the system also accepts a 64-bit signed integer that represents a time in Unix time format (milliseconds since the Unix epoch UTC+0)
	Start util.StringOrInteger `json:"start,omitempty"`
}

Time range to show in all of the charts in the dashboard. The specifications in this object override those in each individual chart. If you don't specify values, the system defaults to using the individual time setting for each chart.

type ChartsSingleFilter

type ChartsSingleFilter struct {
	// Flag that indicates how the filter should operate. If `true`, data that matches the criteria is _excluded_ from charts; otherwise, data that matches the criteria is included.
	NOT bool `json:"NOT,omitempty"`
	// Name of the dimension or custom property to match to the data.<br> **Note:** If the dimension or custom property doesn't exist in any of the charts for the dashboard, and `ChartsFilterObject.NOT` is `true`, the system doesn't display any data in the charts.
	Property string `json:"property"`
	// A list of values to compare to the value of the dimension or custom property specified in `ChartsFilterObject.property`. If the list contains more than one value, the filter becomes a set of queries between the value of `property` and each element of `value`. The system joins these queries with an implicit OR.
	Value         util.StringOrSlice `json:"value"`
	ApplyIfExists bool               `json:"applyIfExists,omitempty"`
}

A single filter object to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.

type ChartsWebUiFilter

type ChartsWebUiFilter struct {
	// A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the web UI. <br> **Note:** A good way to indicate that the string is a label is to append a space and a colon (\":\") to it.
	Alias         string `json:"alias,omitempty"`
	ApplyIfExists bool   `json:"applyIfExists,omitempty"`
	Description   string `json:"description,omitempty"`
	// Array of strings containing values to place at the top of the **Suggested Values** dropdown in web UI for the dashboard. If `ChartsWebUIFilter.restricted`  is `true`, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.
	PreferredSuggestions []string `json:"preferredSuggestions,omitempty"`
	// Name of a custom property or dimension to filter against.<br> **Note:** If the dimension or custom property doesn't exist in any of the charts for the dashboard, the system doesn't display any data in the charts.
	Property string `json:"property"`
	// Flag that controls the display of chart data. If `true`, users must use this filter in order to see data; otherwise, users can delete the filter.
	Required    bool `json:"required,omitempty"`
	ReplaceOnly bool `json:"replaceOnly,omitempty"`
	// Flag that controls the values allowed in the filter. If `true`, the only allowable values are those specified in the `ChartsWebUIFilter.preferredSuggestsions` array; otherwise, any value is allowed.
	Restricted bool `json:"restricted,omitempty"`
	// A list of values to compare to the value of the dimension or custom property specified in `ChartsWebUIFilter.property`. If the list contains more than one value, the filter becomes a set of queries between the value of `property` and each element of `value`. The system joins these queries with an implicit OR.
	Value util.StringOrSlice `json:"value"`
}

The specification for a filter that appears in the web UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter:<br> * A default value * A list of suggested values to display in the web UI * A flag that controls user input; if set to `true`, users are limited to the default and suggested values. <br> You can also force users to choose this filter in order to see data in the dashboard's charts.

type CreateUpdateDashboardRequest

type CreateUpdateDashboardRequest struct {
	AuthorizedWriters *AuthorizedWriters    `json:"authorizedWriters,omitempty"`
	Permissions       *ObjectPermissions    `json:"permissions,omitempty"`
	ChartDensity      DashboardChartDensity `json:"chartDensity,omitempty"`
	Charts            []*DashboardChart     `json:"charts,omitempty"`
	// Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the web UI.
	Description string `json:"description,omitempty"`

	DiscoveryOptions *DiscoveryOptions `json:"discoveryOptions,omitempty"`
	// Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.<br> **Note:** The objects in this array correspond to the *suggested* event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the `selectedEventOverlays` property instead.
	EventOverlays []*ChartEventOverlay `json:"eventOverlays,omitempty"`
	Filters       *ChartsFilters       `json:"filters,omitempty"`
	// ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.
	GroupId string `json:"groupId,omitempty"`
	// Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value *overrides* but doesn't *change* the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.<br> For individual charts, you can force the system to calculate a sensible value by removing the chart's `maxDelayOverride` property. To force the system to do this for all charts in a dashboard, set `CreateDashboardBody.maxDelayOverride` to 0.
	MaxDelayOverride *int32 `json:"maxDelayOverride,omitempty"`
	// A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.
	Name string `json:"name,omitempty"`
	// Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the `eventOverlays` property instead.
	SelectedEventOverlays []*ChartEventOverlay `json:"selectedEventOverlays,omitempty"`
	// Array of dashboard tags. Reserved for future use.
	Tags []string `json:"tags,omitempty"`
}

type Dashboard

type Dashboard struct {
	AuthorizedWriters *AuthorizedWriters     `json:"authorizedWriters,omitempty"`
	Permissions       *ObjectPermissions     `json:"permissions,omitempty"`
	ChartDensity      *DashboardChartDensity `json:"chartDensity,omitempty"`
	// Array of chart objects associated with the dashboard. Each chart object must exist and be unique across all dashboards.
	Charts []*DashboardChart `json:"charts,omitempty"`
	// The dashboard creation date and time, in the form of a Unix time value (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0). The system sets this value, and you can't modify it.
	Created int64 `json:"created,omitempty"`
	// SignalFx-assigned user ID of the user that created the dashboard. If the system created this dashboard, the value is \"AAAAAAAAAA\". The system sets this value, and you can't modify it.
	Creator string `json:"creator,omitempty"`
	// Custom properties for the dashboard, in the form of a JSON object that contains key-value pairs. Custom properties must follow these syntax restrictions:<br> **Key:**<br>   * ASCII characters only   * Length <= 128 characters   * Can only contain upper and lower case alphanumeric characters,     underscores (\"_\"), and hyphens (\"-\")   * Must start with an alphabetic character, upper or lower case.   * Can't start with any of the following strings, which are     reserved for system use: \"_\", \"sf_\", \"aws_\", or \"gcp_\". <br> **Value:**<br>   * Must be present if you specify a key   * Must not be empty   * ASCII characters only   * Length <= 256 characters
	CustomProperties map[string]interface{} `json:"customProperties,omitempty"`
	// Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the web UI.
	Description      string            `json:"description,omitempty"`
	DiscoveryOptions *DiscoveryOptions `json:"discoveryOptions,omitempty"`
	// Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.<br> **Note:** The objects in this array correspond to the *suggested* event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the `selectedEventOverlays` property instead.
	EventOverlays []*ChartEventOverlay `json:"eventOverlays,omitempty"`
	Filters       *ChartsFilters       `json:"filters,omitempty"`
	// ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.
	GroupId string `json:"groupId,omitempty"`
	// The dashboard's SignalFx-assigned ID. This value is \"read-only\" for a create request. The system assigns it and returns it to you in the response.
	Id string `json:"id,omitempty"`
	// The last time the dashboard was updated, in the form of a Unix timestamp (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0) This value is \"read-only\".
	LastUpdated int64 `json:"lastUpdated,omitempty"`
	// SignalFx-assigned ID of the last user who updated the dashboard. If the last update was by the system, the value is \"AAAAAAAAAA\". This value is \"read-only\".
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// Flag that controls modification of the dashboard. If `true`, users can't modify the dashboard. If `false`, users that have authorization to access the dashboard can edit it.
	Locked bool `json:"locked,omitempty"`
	// Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value *overrides* but doesn't *change* the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.<br> For individual charts, you can force the system to calculate a sensible value by removing the chart's `maxDelayOverride` property. To force the system to do this for all charts in a dashboard, set `CreateDashboardBody.maxDelayOverride` to 0.
	MaxDelayOverride *int32 `json:"maxDelayOverride,omitempty"`
	// A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.
	Name string `json:"name,omitempty"`
	// Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the `eventOverlays` property instead.
	SelectedEventOverlays []*ChartEventOverlay `json:"selectedEventOverlays,omitempty"`
	// Array of dashboard tags. Reserved for future use.
	Tags []string `json:"tags,omitempty"`
}

type DashboardChart

type DashboardChart struct {
	// ID of a existing chart object. Because charts can only belong to one dashboard, you can't associate this ID with any other dashboard.
	ChartId string `json:"chartId"`
	// 0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there's space, the dashboard retains the column value and spreads out over additional rows.<br> **Note:** The API doesn't validate the maximum value. However, if you specify a value greater than 11, the chart displays in the web UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.
	Column int32 `json:"column"`
	// Number of rows this chart should span.<br> **Note:** The API doesn't validate the maximum value. However, if you specify a value greater than 3, the chart displays in the web UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.
	Height int32 `json:"height"`
	// 0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there's space, the dashboard retains the column value and spreads out over additional rows. <br> The API doesn't validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the in the first free row from the top in the specified column.
	Row int32 `json:"row"`
	// Number of columns this chart should span.<br> The API doesn't validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.
	Width int32 `json:"width"`
}

One of the charts associated with the dashboard. Specify the chart with the chart ID of an existing chart. The ID must be unique across the entire dashboard.

type DashboardChartDensity

type DashboardChartDensity string

DashboardChartDensity : Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts:<br> * DEFAULT maps to approximately 60 data points * LOW maps to approximately 30 data points * HIGH maps to approximately 120 data points * HIGHEST maps to approximately 240 data points

const (
	DEFAULT DashboardChartDensity = "DEFAULT"
	LOW     DashboardChartDensity = "LOW"
	HIGH    DashboardChartDensity = "HIGH"
	HIGHEST DashboardChartDensity = "HIGHEST"
)

List of DashboardChartDensity

type DashboardEventSignal

type DashboardEventSignal struct {
	// The event name or partial name that the system uses to selecct events to suggest as overlays on the charts in the dashboard.
	EventSearchText string `json:"eventSearchText"`
	// Controls the source of the event. You can specify the following: <br>   * detectorEvents: Select events that come from a detector   * eventTimeSeries: Select events that come from a time series <br> The API doesn't accept other event types.
	EventType  string `json:"eventType,omitempty"`
	DetectorId string `json:"detectorId,omitempty"`
}

A filter that selects charts to overlay with events, based on event names and types.

type DiscoveryOptions added in v1.6.23

type DiscoveryOptions struct {
	Query     string    `json:"query,omitempty"`
	Selectors *[]string `json:"selectors,omitempty"`
}

type EventOverlayFilter

type EventOverlayFilter struct {
	// Controls the action of the filter. If set to `true`, then the system only selects events that *don't* match the filter.
	NOT bool `json:"NOT,omitempty"`
	// The custom property or dimension name that provides the value to test in the filter.<br> If the name you specify isn't defined in one or more of the events associated with the dashboard, the filter never matches anything. If the `NOT` property for this filter is set to `true` and the filter never matches, all event overlays are suppressed.
	Property string `json:"property"`
	// An array of values to test against the specified property. If any of the values match, the system includes the event.<br> **Note:** You must specify at least one element.
	Value util.StringOrSlice `json:"value"`
}

Object containing a filter to apply to event overlays, in the form of a comparison expression. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.

type ObjectPermissions added in v1.9.0

type ObjectPermissions struct {
	// The ID of the dashboard group you want your dashboard to inherit permissions from.
	Parent string `json:"parent,omitempty"`
	// List of custom permission configurations if you don't inherit permissions
	Acl []*AclEntry `json:"acl,omitempty"`
}

ObjectPermissions - available if your organization has the \"access_control\" feature enabled. Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group.

type SearchResult

type SearchResult struct {
	// Number of dashboard objects that matched the provided search criteria.<br> **Note:** This value is a count of the total number of objects in the result set. The number of objects that the system returns is affected by the `limit` and `offset` query parameters. In summary:<br>   * `count`: Size of result set   * number of returned objects:       * (`limit` - `offset`) >= `count`: `count`       * (`limit` - `offset`) < `count`: `limit` - `offset`
	Count int32 `json:"count,omitempty"`
	// Array of dashboard objects that the system returns as the result of the request. These objects represent dashboards that match the search query. The number and location of the objects within the result set depend on the query parameters you specify in the request. To learn more, see the top-level description of the API and the description of the `count` response property
	Results []Dashboard `json:"results,omitempty"`
}

JSON object containing the query results

type SetsDataTableOptions

type SetsDataTableOptions struct {
	// An array of data table settings for properties in the chart. Each element of the array is an object containing a property key name and a flag. If the flag for the object is set to `true`, the property is displayed; otherwise, it's hidden.
	Fields []SetsDataTableOptionsFields `json:"fields,omitempty"`
}

Sets options for the data table, including which properties are omitted.

type SetsDataTableOptionsFields

type SetsDataTableOptionsFields struct {
	// Determines if the property specified by `legendOptions.properties.property` for this element is displayed in the data table.<br> **Note** Only available if `options.type` is `TimeSeriesChart` or `List`.
	Enabled bool `json:"enabled,omitempty"`
	// The key name of a property to hide or show in the data table
	Property string `json:"property,omitempty"`
}

type SimpleDashboardModel

type SimpleDashboardModel struct {
	ChartDensity DashboardChartDensity `json:"chartDensity,omitempty"`
	Charts       []*chart.Chart        `json:"charts,omitempty"`
	// The dashboard creation date and time, in the form of a Unix time value (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0). The system sets this value, and you can't modify it.
	Created int64 `json:"created,omitempty"`
	// SignalFx-assigned user ID of the user that created the dashboard. If the system created this dashboard, the value is \"AAAAAAAAAA\". The system sets this value, and you can't modify it.
	Creator string `json:"creator,omitempty"`
	// Custom properties for the dashboard, in the form of a JSON object that contains key-value pairs. Custom properties must follow these syntax restrictions:<br> **Key:**<br>   * ASCII characters only   * Length <= 128 characters   * Can only contain upper and lower case alphanumeric characters,     underscores (\"_\"), and hyphens (\"-\")   * Must start with an alphabetic character, upper or lower case.   * Can't start with any of the following strings, which are     reserved for system use: \"_\", \"sf_\", \"aws_\", or \"gcp_\". <br> **Value:**<br>   * Must be present if you specify a key   * Must not be empty   * ASCII characters only   * Length <= 256 characters
	CustomProperties map[string]interface{} `json:"customProperties,omitempty"`
	// Description of the chart. This value appears underneath the chart name in the SignalFx web UI.
	Description string `json:"description,omitempty"`
	// Reserved for system use
	DiscoveryOptions map[string]interface{} `json:"discoveryOptions,omitempty"`
	// Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.<br> **Note:** The objects in this array correspond to the *suggested* event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the `selectedEventOverlays` property instead.
	EventOverlays []*EventOverlayFilter `json:"eventOverlays,omitempty"`
	Filters       ChartsFilters         `json:"filters,omitempty"`
	// ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.
	GroupId string `json:"groupId,omitempty"`
	// The dashboard's SignalFx-assigned ID. This value is \"read-only\" for a create request. The system assigns it and returns it to you in the response.
	Id string `json:"id,omitempty"`
	// The last time the dashboard was updated, in the form of a Unix timestamp (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0) This value is \"read-only\".
	LastUpdated int64 `json:"lastUpdated,omitempty"`
	// SignalFx-assigned ID of the last user who updated the dashboard. If the last update was by the system, the value is \"AAAAAAAAAA\". This value is \"read-only\".
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// Flag that controls modification of the dashboard. If `true`, users can't modify the dashboard. If `false`, users that have authorization to access the dashboard can edit it.
	Locked bool `json:"locked,omitempty"`
	// Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value *overrides* but doesn't *change* the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.<br> For individual charts, you can force the system to calculate a sensible value by removing the chart's `maxDelayOverride` property. To force the system to do this for all charts in a dashboard, set `CreateDashboardBody.maxDelayOverride` to 0.
	MaxDelayOverride int32 `json:"maxDelayOverride,omitempty"`
	// The displayed name of the chart in the dashboard
	Name string `json:"name,omitempty"`
	// Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the `eventOverlays` property instead.
	SelectedEventOverlays []*ChartEventOverlay `json:"selectedEventOverlays,omitempty"`
	// An array that contains tag values. You can use tags to search for or filter charts. One use is to tag charts that are in production with the value `prod`. <br> **NOTE:** You can't have more than 50 tags per chart.
	Tags []string `json:"tags,omitempty"`
}

Dashboard object that describes the properties needed for a simple dashboard that's specified only by the charts it contains

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL