stats

Returns historical data for the sensors or web checks with given check ids, for the time range indicated.

Authentication required. User should be part of the check's organization. <br><br>

post/stats/from/{startDate}/until/{endDate}

Request

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

Path parameters

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.

Request body

checkIdsstring[]

Check ids for returning the historical data.

collectionIdsPerFieldobject

Filter/group values based on fields and collection ids

daysOfMonthinteger[]

Day (1-31) list parameter, e.g. [1] for the first of the month.

daysOfWeekinteger[]

Day of the week (1-7) list parameter, e.g. [1] for Monday.

hoursOfDayinteger[]

Hour (0-23) list parameter, e.g. [2, 3] for 2:00 am and 3:00 am.

minutesOfHourinteger[]

Minute within the hour (0-59) list parameter, e.g. [20, 30] for 20th and 30th minute.

organizationIdstring

The id of an organization (when tags are set).

sensorTypestring

The id of a sensor type (when tags are set).

tagsstring[]

Set tags to automatically select checks based on their tags.

tagsOperatorstring

Tags boolean operator (and/or).

Response

Historical data of the checks at the requested period

object required

Changes

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