dashboard_group

Documentation

Index

• type AclEntry
• type AuthorizedWriters
• type CloneDashboardGroupRequest
• type CreateUpdateDashboardGroupRequest
• type DashboardConfig
• type DashboardGroup
• type Filter
• type Filters
• type ImportFilter
• type ImportQualifier
• type ObjectPermissions
• type SearchResult
• type WebUiFilter

Types

type AclEntry

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 object
	Teams []string `json:"teams,omitempty"`
	// An array of user IDs that have write access to this object
	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 CloneDashboardGroupRequest

type CloneDashboardGroupRequest struct {
	// Updated description of the cloned dashboard. If you omit this property, the system uses the description of the source dashboard
	Description string   `json:"description,omitempty"`
	Filters     *Filters `json:"filters,omitempty"`
	// A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.
	Name string `json:"name,omitempty"`
	// The ID of the dashboard to clone into the dashboard group whose ID is specified in the `{id}` path parameter
	SourceDashboard string `json:"sourceDashboard,omitempty"`
}

type CreateUpdateDashboardGroupRequest

type CreateUpdateDashboardGroupRequest struct {
	AuthorizedWriters *AuthorizedWriters `json:"authorizedWriters,omitempty"`
	Permissions       *ObjectPermissions `json:"permissions,omitempty"`
	// Array of dashboard IDs. The system adds the specified dashboards to the dashboard group you're creating. If you omit the property, the system creates a new dashboard and assigns it to the new dashboard group.
	Dashboards       []string           `json:"dashboards,omitempty"`
	DashboardConfigs []*DashboardConfig `json:"dashboardConfigs,omitempty"`
	// Description of the dashboard group. This value appears in the tooltip for the dashboard group on the Dashboards page in the web UI.
	Description string `json:"description,omitempty"`

	ImportQualifiers []*ImportQualifier `json:"importQualifiers,omitempty"`
	// Name of the dashboard group. This value identifies the dashboard group in the web UI. It appears on the dashboards page and in the catalog. It also appears at the top left corner of the screen whenever you're viewing a dashboard that the group contains.
	Name string `json:"name"`
	// Array of existing team object ID. The dashboard group appears on the team landing page for any team in the list.
	Teams []string `json:"teams,omitempty"`
}

type DashboardConfig

type DashboardConfig struct {
	ConfigId string `json:"configId,omitempty"`
	// DashboardId is SignalFx-assigned identifier for a dashboard. In a dashboard group, dashboard IDs track the dashboards associated with the group. If you try to update the ID of an existing configuration entry or use a non-existent ID, the system returns an error.
	DashboardId string `json:"dashboardId,omitempty"`
	// String that provides a description override for a mirrored dashboard
	DescriptionOverride string `json:"descriptionOverride,omitempty"`
	// Filter and dashboard variable overrides for the mirrored dashboard
	FiltersOverride *Filters `json:"filtersOverride,omitempty"`
	// String that overrides the name of the dashboard specified in dashboardId. This property is primarily intended to provide a unique name for a mirrored dashboard.
	NameOverride string `json:"nameOverride,omitempty"`
}

DashboardConfig is configurations associated with the dashboard group.

type DashboardGroup

type DashboardGroup struct {
	AuthorizedWriters *AuthorizedWriters `json:"authorizedWriters,omitempty"`
	Permissions       *ObjectPermissions `json:"permissions,omitempty"`
	// The dashboard group 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 group. If the system created this dashboard group, the value is \"AAAAAAAAAA\". The system sets this value, and you can't modify it.
	Creator          string             `json:"creator,omitempty"`
	DashboardConfigs []*DashboardConfig `json:"dashboardConfigs,omitempty"`
	// Array of dashboard IDs. The system adds the specified dashboards to the dashboard group you're creating. If you omit the property, the system creates a new dashboard and assigns it to the new dashboard group.
	Dashboards []string `json:"dashboards,omitempty"`
	// Description of the dashboard group. This value appears in the tooltip for the dashboard group on the Dashboards page in the web UI.
	Description string `json:"description,omitempty"`
	// The SignalFx-assigned ID for this dashboard.
	Id string `json:"id,omitempty"`

	ImportQualifiers []*ImportQualifier `json:"importQualifiers,omitempty"`
	// The last time the dashboard group 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 group. If the last update was by the system, the value is \"AAAAAAAAAA\". This value is \"read-only\".
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// Name of the dashboard group. This value identifies the dashboard group in the web UI. It appears on the dashboards page and in the catalog. It also appears at the top left corner of the screen whenever you're viewing a dashboard that the group contains.
	Name string `json:"name"`
	// Array of existing team object ID. The dashboard group appears on the team landing page for any team in the list.
	Teams []string `json:"teams,omitempty"`
}

type Filter

type Filter 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.
	Values util.StringOrSlice `json:"value"`
}

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 Filters

type Filters 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 []*Filter `json:"sources,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 []*WebUiFilter `json:"variables,omitempty"`
}

Specifies the properties of filters to apply to the cloned dashboard. <br> This is an *optional* property that you only need to use if you want to override the `filters` property of the dashboard you're cloning. 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 ImportFilter

type ImportFilter 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.
	Values []string `json:"values,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 ImportQualifier

type ImportQualifier struct {
	Metric  string          `json:"metric,omitempty"`
	Filters []*ImportFilter `json:"filters,omitempty"`
}

type ObjectPermissions

type ObjectPermissions struct {
	// The parent property is null by default for dashboard groups and can't be changed
	Parent string `json:"parent,omitempty"`
	// List of permission configurations
	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 group 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 group objects that the system returns as the result of the request. These objects represent dashboard groups 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 []*DashboardGroup `json:"results,omitempty"`
}

type WebUiFilter

type WebUiFilter struct {
	// 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 util.StringOrSlice `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.
	// 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.