stats

Returns historical data for the sensor or web check with given check id, for the time range indicated.

Authentication required. User should be part of the check's organization. <br><br>For example: <br><code>/stats/check/9cca5615-b654-4e6e-96d2-f5db89805a83/from/2016-03-04T00:00:00Z/until/2016-03-14T00:00:00Z </code> <br><br>returns a date histogram with the data for the given sensor from 4 March 2016 to 14 March 2016: <br><br>{<br> "1457049600000": {<br> "timestamp-as-string": "2016-03-04T00:00:00.000Z",<br> "angle.x": 0.5166666666666667,<br> "angle.z": 92,<br> "axis.x": 0,<br> "axis.y": 0,<br> "axis.z": 1<br> },<br> "1457053200000": {<br> "timestamp-as-string": "2016-03-04T01:00:00.000Z",<br> "angle.x": 0.9,<br> "angle.z": 91.96666666666667,<br> "axis.x": 0,<br> "axis.y": 0,<br> "axis.z": 1<br> },<br> ... <br><br>Note that angle.x, angle.z, axis.x/y/z are fields specific for the kind of sensor requested. Other type of sensors will return other data.

get/stats/check/{checkId}/from/{startDate}/until/{endDate}

Request

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

Path parameters

checkIdstring required

The id of the sensor

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

statisticTypestring required

Current statistics supported : averages, counts, maxs, mins, sums.

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

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

fieldsstring

Optional - list of json fields for which the values should be returned. Separated by comma (,).

cumulativeboolean

Optional - accumulate the values.

derivativeboolean

Optional - derivative of the values.

debugboolean

Send debug info in the response, such as timestamp in a user friendly format.

partOfDaystring

Optional - filter by daytime or nighttime.

cultivationIdstring

Optional - filter data by returning datapoints for when the data source is in the cultivation.

Response

Historical data of the check at the requested period

object required

Changes

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