ManageEngine® Applications Manager

ShowPolledData API

This API allows the user to fetch the polled data from a monitor or monitor group for the time period specified by the user.

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/ShowPolledData?apikey=[ API Key ]

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/ShowPolledData?apikey=[ API Key ]

Request Parameters:

Field Description

resourceid This value is the resourceid of the monitor from which the data has to be fetched.

attributeID This is the value of the attribute id for which the polled or archived data has to be shown.

period This value specifies the the type of data that needs to be returned. its values are : 20 for show polled data, -7 for 7 days archieved data and -30 for 30 days archieved data.

Example urls:

Polled Data:

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=20&attributeID=310

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=20&attributeID=3102

Last 7 days Data:

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=-7&attributeID=3102

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=-7&attributeID=3102

Last 30 days Data:

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=-30&attributeID=3102

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=-30&attributeID=3102

Response Details:

Field Description

StartTime
This is the start time in milli seconds format from which 7/30/ show polled data report is generated

EndTime
This is the end time in milli seconds format from which 7/30/ show polled data report is generated

StartDateTime This is the start time in date time format from which 7/30/ show polled data report is generated

EndDateTime This is the end time in date time format from which 7/30/ show polled data report is generated

ResourceName This is the monitor name from which the data is returned

ResourceType This is the type of the resource for which the data is returned

AttributeName This is the name of the attribute

Unit This is the units of the attribute

AttributeID This is the ID of the user

ReportType This is the type of data this API call is returning (Polled data / 7 days data / 30 days data).

BusinessPeriod This represents the business period name

ResourceId This is the monitor resourceid

AttributeImage This is the attribute graph for the data returned along with this response.

Status This is the status of the REST API call to get the show polled data

Period This value specifies the the type of data that needs to be returned. its values are : 20 for show polled data, -7 for 7 days archieved data and -30 for 30 days archieved data.

RawData

CollectionTime -- represents the time stamp in ms at which the data is collected

DateTime -- represents the time stamp in date time format at which the data is collected

Value -- this represents the value of the attribute

ArchiveData

ArchivedTime -- represents the archived time in ms

DateTime -- represents the archived time in data time format

AvgValue -- this is the avg time of the value in that archived period

MinValue -- this is the minimum value in that archived period

MaxValue -- this is the maximum value in that archived period

<AppManager-response uri="/AppManager/xml/ShowPolledData">
<result>
<response response-code="4000">
<Monitorinfo StartTime="1328775260450" EndDateTime="Mar 29, 2012 3:00 PM" ResourceName="APM-Windows" Unit="ms" EndTime="1333013434474" BusinessPeriod="NA" MonitorType="Response Time" ReportType="Polled data" ResourceId="10001267" AttributeID="4602" AttributeImage="/webclient/temp/images/RSVmYs.jpg" ServerType="GlassFish" Status="SUCCESS" StartDateTime="Feb 9, 2012 1:44 PM" Period="20">
<RawData CollectionTime="1333013434474" Value="1" DateTime="Mar 29, 2012 3:00 PM"/>
<RawData CollectionTime="1333013134022" Value="1" DateTime="Mar 29, 2012 2:55 PM"/>
<RawData CollectionTime="1333012833497" Value="1" DateTime="Mar 29, 2012 2:50 PM"/>
<RawData CollectionTime="1333012532708" Value="1" DateTime="Mar 29, 2012 2:45 PM"/>
<RawData CollectionTime="1333012227193" Value="1" DateTime="Mar 29, 2012 2:40 PM"/>
<RawData CollectionTime="1328775260450" Value="1" DateTime="Feb 9, 2012 1:44 PM"/>
</Monitorinfo>
</response>
</result>
</AppManager-response>

JSON Input

http://apm-prod1:9090/AppManager/json/ShowPolledData?apikey=c4e547c2330e2eb92d3e7af2262da9e9&resourceid=20000039&period=20&attributeID=1957

JSON Response

{"response-code":"4000","response":{"uri":"/AppManager/json/ShowPolledData","result":[{"StartTime":"1337928634448","EndDateTime":"May 25, 2012 3:32 PM","ResourceName":"apm-prod1_Windows Vista","Unit":"%","EndTime":"1337940130413","BusinessPeriod":"NA","ReportType":"Polled data","ThresholdDetails":[],"ResourceId":"20000039","AttributeName":"CPU Utilization","AttributeID":"1957","AttributeImage":"/webclient/temp/images/fjrEKg.jpg","Status":"SUCCESS","RawData":[{"CollectionTime":"1337940130413","Value":"18","DateTime":"May 25, 2012 3:32 PM"},{"CollectionTime":"1337939525577","Value":"11","DateTime":"May 25, 2012 3:22 PM"},{"CollectionTime":"1337938920641","Value":"5","DateTime":"May 25, 2012 3:12 PM"},{"CollectionTime":"1337938315808","Value":"6","DateTime":"May 25, 2012 3:01 PM"},{"CollectionTime":"1337937710788","Value":"7","DateTime":"May 25, 2012 2:51 PM"},{"CollectionTime":"1337937105838","Value":"7","DateTime":"May 25, 2012 2:41 PM"},{"CollectionTime":"1337936500971","Value":"9","DateTime":"May 25, 2012 2:31 PM"},{"CollectionTime":"1337935895963","Value":"18","DateTime":"May 25, 2012 2:21 PM"},{"CollectionTime":"1337935291160","Value":"7","DateTime":"May 25, 2012 2:11 PM"},{"CollectionTime":"1337934686297","Value":"31","DateTime":"May 25, 2012 2:01 PM"},{"CollectionTime":"1337934079880","Value":"13","DateTime":"May 25, 2012 1:51 PM"},{"CollectionTime":"1337933475084","Value":"16","DateTime":"May 25, 2012 1:41 PM"},{"CollectionTime":"1337932869853","Value":"34","DateTime":"May 25, 2012 1:31 PM"},{"CollectionTime":"1337932263739","Value":"8","DateTime":"May 25, 2012 1:21 PM"},{"CollectionTime":"1337931658583","Value":"7","DateTime":"May 25, 2012 1:10 PM"},{"CollectionTime":"1337931053751","Value":"17","DateTime":"May 25, 2012 1:00 PM"},{"CollectionTime":"1337930448921","Value":"9","DateTime":"May 25, 2012 12:50 PM"},{"CollectionTime":"1337929844110","Value":"6","DateTime":"May 25, 2012 12:40 PM"},{"CollectionTime":"1337929239270","Value":"3","DateTime":"May 25, 2012 12:30 PM"},{"CollectionTime":"1337928634448","Value":"9","DateTime":"May 25, 2012 12:20 PM"}],"ResourceType":"Windows Vista","StartDateTime":"May 25, 2012 12:20 PM","Period":"20"}]}}

<< Prev	Home	Next >>
Search API		User Management API

Field	Description
resourceid	This value is the resourceid of the monitor from which the data has to be fetched.
attributeID	This is the value of the attribute id for which the polled or archived data has to be shown.
period	This value specifies the the type of data that needs to be returned. its values are : 20 for show polled data, -7 for 7 days archieved data and -30 for 30 days archieved data.

Field	Description
StartTime	This is the start time in milli seconds format from which 7/30/ show polled data report is generated
EndTime	This is the end time in milli seconds format from which 7/30/ show polled data report is generated
StartDateTime	This is the start time in date time format from which 7/30/ show polled data report is generated
EndDateTime	This is the end time in date time format from which 7/30/ show polled data report is generated
ResourceName	This is the monitor name from which the data is returned
ResourceType	This is the type of the resource for which the data is returned
AttributeName	This is the name of the attribute
Unit	This is the units of the attribute
AttributeID	This is the ID of the user
ReportType	This is the type of data this API call is returning (Polled data / 7 days data / 30 days data).
BusinessPeriod	This represents the business period name
ResourceId	This is the monitor resourceid
AttributeImage	This is the attribute graph for the data returned along with this response.
Status	This is the status of the REST API call to get the show polled data
Period	This value specifies the the type of data that needs to be returned. its values are : 20 for show polled data, -7 for 7 days archieved data and -30 for 30 days archieved data.
RawData	CollectionTime -- represents the time stamp in ms at which the data is collected DateTime -- represents the time stamp in date time format at which the data is collected Value -- this represents the value of the attribute
ArchiveData	ArchivedTime -- represents the archived time in ms DateTime -- represents the archived time in data time format AvgValue -- this is the avg time of the value in that archived period MinValue -- this is the minimum value in that archived period MaxValue -- this is the maximum value in that archived period