Dashboards and reporting (REST)

The AppMon Server provides a set of RESTful interfaces to create dashboard reports using HTTP requests. Use this interface to retrieve the information contained in dashboards in various file formats and with flexible options to choose the source and timeframe of the reported data.

See Reporting for a general overview of the reporting functionality of AppMon.

Generate a dashboard report

Generate a report

The syntax to generate reports using REST is:

GET https://<server>:8021/rest/management/reports/create/<dashboardname>

Examples

Dashboard information

List available dashboards

To get a list of dashboards available, send the following RESTful request:

GET https://<server>:8021/rest/management/dashboards produces text/xml

The returned XML contains a dashboards root node and dashboard sub-nodes that list available dashboards. The href attribute contains a link for reporting this dashboard. In specific cases, a dashboard references an icon that can be requested with the link of the icon attribute.

Note

Only dashboards that are available for the logged-in user are listed. Dashboards to which the user does not have access permissions are not listed.

Dashboard icon

Some preconfigured dashboards reference an icon of the type PNG, GIF, or JPEG. Use the following request to download the icon of a specified dashboard:

GET https://<server>:8021/rest/management/dashboards/<dashboardname>/icon

Types and formats

List supported reporting types

A reporting type is an output that is supported by the reporting functionality of the AppMon Server, such as PDF or HTML. Reporting types can support multiple reporting formats like the different layouts for HTML, although usually only one reporting format is provided per reporting type.

GET https://<server>:8021/rest/management/reports/types produces text/xml

The returning XML contains a reporttypes root node and reporttype sub-nodes that list available types.

List supported formats per type

A reporting type is an output supported by the reporting functionality of the AppMon Server, such as PDF or HTML. A reporting type can support multiple reporting formats like the different layout for HTML, although usually only one reporting format is provided per reporting type.

GET https://<server>:8021/rest/management/reports/formats produces text/xml

The returning XML contains a reporttypes root node and reporttype sub-nodes that list available dashboards.

Example

To get the available formats for HTML reports:

URI https://localhost:8021/rest/management/reports/formats/HTML

which returns:

Extended XML reporting

XML reports can be created like any other report. There is also a special reporting interface for XML only that supports some additional parameters.