v1

latestOpenAPI 3.0.02026-08-0650184174.6 KB

Summary.performance

For a given interval return a list of subintervals

For a given interval in time, return a list of sub intervals with the given resolution. Useful for generating graphs. A sub interval may be a week, a day or an hour depending on the choosen resolution.

get/summary.performance/{checkid}

Path parameters

checkidinteger required

Query parameters

frominteger

Start time of period. Format is UNIX timestamp. Default value is 10 intervals earlier than to.

tointeger

End time of period. Format is UNIX timestamp. Default value is the current time.

resolution'hour' | 'day' | 'week'

Interval size

includeuptimeboolean

Include uptime information.

probesstring

Filter to only use results from a list of probes. Format is a comma separated list of probe identifiers. Can not be used if includeuptime is set to true. Also note that this can cause intervals to be omitted, since there may be no results from the desired probes in them. By deafult results from all probes are returned.

order'asc' | 'desc'

Sorting order of sub intervals. Ascending or descending.

Response

Successful HTTP Response

Example response

{
  "summary": {
    "weeks": [
      {
        "starttime": 1287957600,
        "avgresponse": 468,
        "uptime": 608400
      }
    ]
  }
}