DashboardWidget

DashboardWidget
DashboardWidget

Dashboard widget

JSON Example
{
    "name": "test_dashboard_widget",
    "description": "test_dashboard_widget description",
    "queryDefinitionLink": "/vrlic/api/v1/query-definitions/9lk786b4-2086-4dbf-b906-b6b34ae546c6",
    "queryDefinitionState": {
        "aggregationFunctions": [
            {
                "fieldName": "text",
                "functionName": "AVG"
            },
            {
                "fieldName": "text",
                "functionName": "MIN"
            },
            {
                "fieldName": "build_number",
                "functionName": "MAX"
            }
        ],
        "constraints": {
            "constraints": [
                {
                    "constraints": [],
                    "fieldName": "text",
                    "operator": "EXISTS",
                    "tags": [],
                    "value": "error"
                },
                {
                    "constraints": [],
                    "fieldName": "text",
                    "operator": "EXISTS",
                    "tags": [],
                    "value": "exception"
                },
                {
                    "constraints": [],
                    "fieldName": "build_number",
                    "operator": "LESS_THAN",
                    "tags": [],
                    "value": "7408"
                }
            ],
            "fieldName": null,
            "operator": "AND",
            "tags": [],
            "value": null
        },
        "contentPackId": "et4671072-94a6-4106-8d20-c153896e91c5",
        "createdAt": "2023-05-09T21:25:15.934Z",
        "createdBy": "test@gmail.com",
        "description": "Note: details about this query definition",
        "documentSelfLink": "/vrlic/api/v1/query-definitions/789kl5b3c6-2434-457e-8fcb-b75abcceefa7",
        "groupByTerms": [
            {
                "fieldName": "timestamp",
                "groupByType": "FIXED_BUCKET"
            }
        ],
        "isAnnotation": false,
        "isFavorite": false,
        "isSearchable": false,
        "lastUpdatedAt": "2023-05-09T21:25:15.934Z",
        "lastUpdatedBy": "test@gamil.com",
        "name": "test_query_definition",
        "relationFunctions": [
            {
                "relationName": "9876ed31-fe70-4c61-8db7-917a1a2636f1",
                "relationType": "LOGS"
            }
        ],
        "source": "USER_DEFINED",
        "sourceName": "testing_source",
        "url": "http://kb.vmware.com/kb/778652729092us8",
        "widget": {
            "analysisFunctions": null,
            "filter": null,
            "name": "test_widget",
            "visualization": {
                "options": {
                    "logaxis": "false",
                    "pielabelstyle": "legend",
                    "piepercentage": "false",
                    "piestyle": "normal"
                },
                "type": "AREA"
            },
            "widgetType": "CHART"
        }
    },
    "widgetType": "CHART",
    "widgetPlacement": {
        "x": 3,
        "y": 0,
        "width": 4,
        "height": 4
    },
    "visualization": {
        "type": "AREA",
        "options": {
            "logaxis": "false",
            "pielabelstyle": "legend",
            "piepercentage": "false",
            "piestyle": "normal"
        }
    },
    "widgetProperties": {
        "constraints": {
            "operator": "OR",
            "tags": null,
            "constraints": [
                {
                    "fieldName": "text",
                    "operator": "EQUAL",
                    "value": "error"
                }
            ]
        }
    },
    "analysisFunctions": null,
    "filter": {
        "type": "KEY_VALUE",
        "options": {
            "logaxis": "false"
        }
    },
    "chartType": "line",
    "chartOptions": {
        "stacking": "normal"
    }
}
string
name
Required

Name of the widget

string
description
Optional

Description of the widget

string
queryDefinitionLink
Required

Self link for the query definition

queryDefinitionState
Optional

queryDefinitionState

string
widgetType
Required

Specifies the widget type, which includes: CHART, LIST, FIELD_TABLE, EVENT_TYPE, EVENT_TREND, ALERT

Possible values are : CHART, LIST, FIELD_TABLE, EVENT_TYPE, EVENT_TREND, ALERT,
object
widgetPlacement
Required

This map contains the placement details for eg. x, y, width, height (widget placement coordiantes)

visualization
Optional

visualization

object
widgetProperties
Optional

This map contains any additional properties and query criteria that the widget needs.

analysisFunctions
Optional

A list of analysis functions.

filter
Optional

filter

string
chartType
Optional

If the widget is of the type chart, this field specifies the corresponding chart type E.g., pie, bar, solidGauge, line, column, fieldTable

object
chartOptions
Optional

If the widget is of the type chart, this field specifies the corresponding chart options E.g., logaxis, trendline, spline