chartbeat

 

alerts

Page history last edited by Kushal 1 mo ago

About this call


 

Returns any alerts that were fired regarding a monitored domain.  This call returns historical data.

 

Format


 

http://chartbeat.com/dashapi/alerts/?host=[host]&since=[timestamp]&apikey=[apikey] 
  • host - Required.  The domain name to get alerts about.
  • since - Required.  Unix timestamp.  Returns all alerts since this time.
  • apikey - Required.  An api key generated here that gives access to this call.
  • jsonp - Optional.  Give the name of a function to wrap the return data in. Learn more here

 

Example


 

http://chartbeat.com/dashapi/alerts/?host=chartbeat.com&since=1231194225&apikey=abc123

 

Example return:

 

[
{
"direction": "above",
"url": "chartbeat.com",
"metric": "people",
"dynthreshold": "",
"time": "2009-01-06 01:37",
"threshold": 50,
"value": 51,
"seconds": 1254426208.0,

},
{
"direction": "above",
"url": "chartbeat.com",
"metric": "people",
"dynthreshold": "max",
"time": "2009-01-23 12:47",
"threshold": 50,
"value": 51,
"seconds": 1254426208.0
}
]

 

Return variables


 

Returns an array of objects, each object describes one alert.

 

  • direction - (possible values: above, below).  The direction that should fire the alert with regards to the threshold or dynthreshold.
  • url - The url that fired the alert.
  • metric - (possible values: people, new, return, read, write, idle)  The metric that the alert was based on.
  • threshold - The number that the alert was based on. For dynamic alerts, the value of the dynamic threshold at the time the alert fired. For uptime alerts, 0 or not present.
  • dynthreshold - A dynamic threshold, based on min/max/avg on a metric. If empty, the threshold is a fixed value or this is an uptime alert.
  • value - The value of the metric at the time of firing. For uptime alerts, 0 or not present.
  • time - The time the alert was fired.
  • seconds - The number of seconds since the epoch.

     

Comments (0)

You don't have permission to comment on this page.