downtime

Returns the date histogram aggregations related to the recorded downtimes of the sensor at the requested from/until period interval

Default oauth authentication mechanism required for this operation. <br>The current user should be authorized to the check. <br>When there is no location specified at the query parameter all the locations associated to that sensor will be queried. <br>The date validation process will include the precedence validation, so if endDate is previous to startDate the dates will be switched. <br>The periodic data response is by default (when not specified) 200 times sliced.

get/downtime/{checkId}/from/{startDate}/until/{endDate}

Request

  • Base URL: https://api.30mhz.com/api
  • URL: https://api.30mhz.com/api/downtime/{checkId}/from/{startDate}/until/{endDate}
  • Auth: API key in header Authorization

Path parameters

checkIdstring required

The check id

startDatestring required

Initial date string.ISO 8601 date. E.g.: '2016-03-03T00:00:00Z'

endDatestring required

Final date string.ISO 8601 date. E.g.: '2016-03-03T00:00:00Z'

Query parameters

intervalSizestring

Size of the time intervals in which to aggregate the data. This parameter is given as a number of minutes, hours, days or weeks, or monthly, e.g. '5m' is five minutes, '1h' is one hour, '5d' is five days, '2w' is two weeks and 'M' is monthly. The optional 'f' prefix is used to retrieve the full interval according to the provided unit, e.g. 'f1w' will retrieve the last full week (Mon to Sun), 'f2d' will retrieve the last two full days (Wed and Thu if it is Fri).

locationstring required

Optionally filter only the data from one location. Leave empty or set to 'all' to get all locations

Response

Parsed downtime aggregations of the check at the requested period

responseobject

Changes

No recorded changes to this operation across all 1 revision of this API.