Get Dashboards By Dashboard Type

Get Dashboards By Dashboard Type

Gets a list of dashboards by dashboard type. It includes USER_DEFINED

Request
URI
GET
https://{api_host}//vrlic/api/v1/content/dashboards/{type}
COPY
Path Parameters
string
type
Required

Type refers to dashboard type here


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns DashboardResponseDto of type(s) */*
{
    "dashboards": [
        {
            "id": "908gt432c-b164-4754-b531-49b8539c5492",
            "name": "test_dashboard",
            "widgets": [
                {
                    "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": "[email protected]",
                        "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": "[email protected]",
                        "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"
                    }
                }
            ],
            "contentPackId": "com.vmware.test.4-0-8",
            "dashboardType": "USER_DEFINED",
            "createdBy": "[email protected]",
            "createdAt": "2022-06-15T09:47:35.647Z",
            "lastUpdatedBy": "[email protected]",
            "lastUpdatedAt": "2022-06-15T09:47:35.647Z",
            "cspOrgId": "90d2932c-1274-4495-b7f5-a78jhc0ec69",
            "owner": "owner",
            "allowedAction": "UPDATE",
            "isFavourite": true,
            "entityTagAssociation": [
                {
                    "tagId": "4c454315-e469-432b-a302-3e8eb0e10690",
                    "tagName": "test_tag_1"
                },
                {
                    "tagId": "7795d0ee-4d0b-496b-b48b-fc5b7c6f4e89",
                    "tagName": "test_tag_2"
                }
            ]
        }
    ]
}
dashboards
Optional

List of dashboards