This API fetches the List of Dashboards created in the Server which includes all the widgets configured in the Dashboards as there is no concept of assigning the dashboards/widgets to operators. But the data which is to be populated will be based on the monitors assigned for the user.
API for XML Response:
http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListDashboards?apikey=[ Api Key ]
API for JSON Response:
http://[ APM Host ]:[ APM Port ]/AppManager/json/ListDashboards?apikey=[ API Key ]
Response Details:
| Field | Description |
|---|---|
| DashboardId | This is the username. |
| DashboardName | This is the description of the user account given at the time of creation of user account |
| Widget | WidgetName -- This represents the display name of the widget WidgetId -- This is the id of the widget created in this dashboard. WidgetURL -- This is the link to the widget of this dashboard |
|
<AppManager-response uri="/AppManager/xml/ListDashboards"> |
|
JSON Input http://apm-prod1:9090/AppManager/json/ListDashboards?apikey=c4e547c2330e2eb92d3e7af2262da9e9 JSON Response {"response-code":"4000","response":{"uri":"/AppManager/json/ListDashboards","result":[{"Widget":[{"WidgetName":"Monitor Groups","WidgetId":"20000001","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000001"},{"WidgetName":"Infrastructure Snapshot","WidgetId":"20000002","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000002"},{"WidgetName":"Recent 10 Alarms","WidgetId":"20000003","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000003"}],"DashboardId":"20000001","DashboardName":"Default Dashboard"}]}}
|
