ManageEngine® Applications Manager


Get Group Availability API

<< Prev

Home

Next >>

Get Monitor Group Availabilty

 

This API allows the user to pull up availability data on a monitor group in Applications Manager.

 

Sample Request

http://[hostname]:[port]/AppManager/json/getMonitorGroupAvailability?apikey=[REST API Key]

 

Request Parameters


The parameters involved in the API request are described below:

 

Field Description        
apikey* The key generated from the Generate API Key option in the 'Admin' tab.
IncludeSubGroup Specify IncludeSubGroup = true if you also wish to know the availability status of the sub-group within the monitor group.
CustomTime Specify CustomTime=true for custom time availability report. If CustomTime is true then you must provide StartTime and EndTime
StartTime The start time of the report in milliseconds.
EndTime The end time of the report in milliseconds.
ReportPeriod

The time period for which the report should be created. If this parameter is not provided then today's availability is shown. Possible Values are:

  • 0 = Todays Availability
  • 1 = Last 7 Days Availability
  • 2 = Last 30 Days Availability
  • 3 = Yesterday Availability
  • 5 = Last 1 Year Availability
  • 6 = This week Availability
  • 7 = This month Availability
  • 8 = This year Availability
  • 9 = This quarter Availability
  • 11= Last month Availability
  • 12= Last week Availability

* - mandatory

 

Examples:

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d

 

To include sub-group -

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&IncludeSubGroup=true

 

For service availability calculation:

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&ServiceAvailability=true

 

For custom time availability report:

http://localhost:9090/AppManager/json/GetMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&CustomTime=true&StartTime=2&EndTime=4

 

To set the Report Period:

http://localhost:9090/AppManager/json/GetMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&ReportPeriod=1

<< Prev

Home

Next >>

Edit Monitor Group API

Move Monitor Group API