downtime

Returns the date histogram aggregations recorded downtimes of the check at the request 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 check id will be queried. <br>The periodic data response is by default (when not specified) 200 times sliced.

get/downtime/{checkId}/interval/{interval}

Request

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

Path parameters

checkIdstring required

The check id

intervalstring required

Intervals allowed : c, today, (f)1h, (f)2h, ..., (f)xh, (f)1d, (f)2d, ..., (f)xd, (f)1w, (f)2w, ..., (f)xw, (f)1M, (f)2M, ..., (f)xM.

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

timezoneOffsetinteger

The timezone offset, in hours, for which to return the data. For example, 2 for Europe/Amsterdam. -3 for America/Argentina/Buenos_Aires. If empty, then UTC/GMT time is assumed, but it's probably not what you want. See list of timezones: <a>https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a>

Response

Parsed downtime aggregations of the check at the requested interval

responseobject

Changes

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