JSON File Widget Parameters
reports dashboard JSON file parameters when creating a custom widget.
The following table describes the parameters for a JSON file when creating a widget. For an example of a JSON file, see JSON File Widget Example.
The unique identifier for the widget.
The display name of the widget.
The data source of the widget. Must be one of the following:
Queries query data in the Lucene query syntax form relating to the dataType. For example when dataType is incidents and the query is: -status:closed and owner:"" it queries all incidents that are not closed, which does not have an owner.
For script based widgets, the query is the name of the script.
Sorts the data, when displaying the widgetType (such as table, list, bar, column, pie) according to the following:
The type of widget you want to create. Must be one of the following:
The maximum number of returning elements. Use 0 for the widgetType's default. Note the following:
Adds a category name. The widget appears under a category instead of being classified by dataType.
The time period for which to return data. The time period is overridden by the dashboard or report time period. Default is all times.
The description of the widget in the Widget Library.
Enriches the widget with specific parameters, mainly based on the widgetType. Includes the following:
An array of objects that consists of a name and color. The name must match a group name. The color can be the name of the color, the hexadecimal representation of the color, or the rgb color value.
Recommended For You
Recommended videos not found.