Forum Discussion
JKobert
12 years agoStaff
Hello Russell,
You are correct, http://help.alertsite.com is the current location for the API documentation. Although we don't document a description for each API call, I think I can offer a way for you to generate such a description.
Let's use your SLA Detail report as an example. Navigate to the tab "Performance Reports" within the AlertSite Console, you can then run an SLA Detail report specifying the desired parameters from the report screen (i.e. Site Name, Report Date, Locations, etc) and when generating that report, we will also give you the corresponding Report API call.
It would look something like this:
https://www.alertsite.com/report-api/sla/C#####?obj_device=#####&location=25,5040,85,75,40,80,20,6020,65&rdate=Today&showrecs=&sort_order=asc
The output of this call, either in XML or JSON, would contain the data as well as the data descriptors. Here is a snippet:
<Report Type="SLA Report" SiteName="SLA Monitor" SLA_Name="AlertSite SLA" SLA_Description="Server" From="2013-08-20 00:00" Thru="2013-08-20 11:43" obj_device="#####" locations="25,5040,85,75,40,80,20,6020,65">
<Objective Type="Availability">
<Goal>98.00</Goal>
<Actual>100.00</Actual>
<Compliant>Yes</Compliant>
<Errors>0</Errors>
<Checks>54</Checks>
</Objective>
I hope this helps you get to the data you require!
You are correct, http://help.alertsite.com is the current location for the API documentation. Although we don't document a description for each API call, I think I can offer a way for you to generate such a description.
Let's use your SLA Detail report as an example. Navigate to the tab "Performance Reports" within the AlertSite Console, you can then run an SLA Detail report specifying the desired parameters from the report screen (i.e. Site Name, Report Date, Locations, etc) and when generating that report, we will also give you the corresponding Report API call.
It would look something like this:
https://www.alertsite.com/report-api/sla/C#####?obj_device=#####&location=25,5040,85,75,40,80,20,6020,65&rdate=Today&showrecs=&sort_order=asc
The output of this call, either in XML or JSON, would contain the data as well as the data descriptors. Here is a snippet:
<Report Type="SLA Report" SiteName="SLA Monitor" SLA_Name="AlertSite SLA" SLA_Description="Server" From="2013-08-20 00:00" Thru="2013-08-20 11:43" obj_device="#####" locations="25,5040,85,75,40,80,20,6020,65">
<Objective Type="Availability">
<Goal>98.00</Goal>
<Actual>100.00</Actual>
<Compliant>Yes</Compliant>
<Errors>0</Errors>
<Checks>54</Checks>
</Objective>
I hope this helps you get to the data you require!
Related Content
- 2 years ago
- 2 years ago
- 6 years ago
Recent Discussions
- 4 months ago
- 4 months ago
- 6 months ago
- 9 months ago