GET   checks/{checkId}/aggregated?fromUtc={fromUtc}&toUtc={toUtc}&detail_level={detail_level}&include_step_metrics={include_step_metrics}&scope={scope}

For a specific check - gets aggregated data and SLA between two dates.

URL Parameters

NameDescription
checkId

Check identifier. Type: numeric.

fromUtc

Timestamp in UTC format. Example: 2013-08-20T13:32:08.

toUtc

Timestamp in UTC format. Example: 2013-08-20T13:32:08.

detail_level

Result detalization level. Allowed values: 0, 1. Default value: 0.

include_step_metrics

Include aggregated data for check steps. Allowed values: true, false. Default value: false.

scope

String representation of scope. Allowed values: y, q, m, w, d, h (where "y" is year, "h" is hour, etc). Default value: h.

Remarks

The default context for the route is the user context. To enable customer context (if it's allowed for the user) use the request query parameter customer_context=1.

Responses

Response body model examples and descriptions

When result detalization level is 0

{
  "check_id": 1,
  "check_name": "sample string 2",
  "sla_records": [
    {
      "unit": "ms",
      "avg_attempts": 1.2,
      "avg": 583.0,
      "mdn": 522.0,
      "max": 1187,
      "min": 347,
      "std": 201.0,
      "from_utc": "2013-09-26T15:00:00",
      "to_utc": "2013-09-26T15:59:59",
      "sla_percent": 90.0,
      "total_count": 10,
      "i_count": 7,
      "w_count": 2,
      "e_count": 0,
      "f_count": 1,
      "u_count": 0,
      "step_metrics": [
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        }
      ]
    },
    {
      "unit": "ms",
      "avg_attempts": 1.2,
      "avg": 583.0,
      "mdn": 522.0,
      "max": 1187,
      "min": 347,
      "std": 201.0,
      "from_utc": "2013-09-26T15:00:00",
      "to_utc": "2013-09-26T15:59:59",
      "sla_percent": 90.0,
      "total_count": 10,
      "i_count": 7,
      "w_count": 2,
      "e_count": 0,
      "f_count": 1,
      "u_count": 0,
      "step_metrics": [
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        }
      ]
    },
    {
      "unit": "ms",
      "avg_attempts": 1.2,
      "avg": 583.0,
      "mdn": 522.0,
      "max": 1187,
      "min": 347,
      "std": 201.0,
      "from_utc": "2013-09-26T15:00:00",
      "to_utc": "2013-09-26T15:59:59",
      "sla_percent": 90.0,
      "total_count": 10,
      "i_count": 7,
      "w_count": 2,
      "e_count": 0,
      "f_count": 1,
      "u_count": 0,
      "step_metrics": [
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        }
      ]
    }
  ],
  "from_utc": "2013-09-26T15:00:00",
  "to_utc": "2013-09-26T15:59:59"
}
NameType Description
check_id Integer

No documentation available.

check_name String

No documentation available.

sla_records Array

No documentation available.

unit String

The unit of the check return value.

avg_attempts Float

The average number of attempts performed per check run during the period.

avg Float

The average check return value during the period.

mdn Float

The median check return value during the period.

max Integer

The maximum check return value during the period.

min Integer

The minumum check return value during the period.

std Float

The standard deviation for the check return value during the period.

from_utc DateTime

Start of the time period (UTC).

to_utc DateTime

End of the time period (UTC).

sla_percent Float

The ratio of successful (i.e. I and W severity) runs to total runs.

total_count Integer

Total number of check runs during the period.

i_count Integer

Number of check runs with severity=I during the period.

w_count Integer

Number of check runs with severity=W during the period.

e_count Integer

Number of check runs with severity=E during the period.

f_count Integer

Number of check runs with severity=F during the period.

u_count Integer

Number of check runs with unknown severity (U) during the period.

step_metrics Array

Array of step metrics.

step Integer

The number of step.

dom_complete Object

DOM Complete

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

dom_interactive Object

DOM Interactive

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

dom_content_loaded Object

DOM Content Loaded

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

response Object

Response Time

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

render Object

Total Browser Render Time

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

from_utc DateTime

No documentation available.

to_utc DateTime

No documentation available.

When result detalization level is 1

{
  "check_guid": "17499c69-74b8-4b9b-b203-bc6a9b29189f",
  "check_type": "sample string 2",
  "target_sla": "sample string 3",
  "check_id": 4,
  "check_name": "sample string 5",
  "sla_records": [
    {
      "unit": "ms",
      "avg_attempts": 1.2,
      "avg": 583.0,
      "mdn": 522.0,
      "max": 1187,
      "min": 347,
      "std": 201.0,
      "from_utc": "2013-09-26T15:00:00",
      "to_utc": "2013-09-26T15:59:59",
      "sla_percent": 90.0,
      "total_count": 10,
      "i_count": 7,
      "w_count": 2,
      "e_count": 0,
      "f_count": 1,
      "u_count": 0,
      "step_metrics": [
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        }
      ]
    },
    {
      "unit": "ms",
      "avg_attempts": 1.2,
      "avg": 583.0,
      "mdn": 522.0,
      "max": 1187,
      "min": 347,
      "std": 201.0,
      "from_utc": "2013-09-26T15:00:00",
      "to_utc": "2013-09-26T15:59:59",
      "sla_percent": 90.0,
      "total_count": 10,
      "i_count": 7,
      "w_count": 2,
      "e_count": 0,
      "f_count": 1,
      "u_count": 0,
      "step_metrics": [
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        }
      ]
    },
    {
      "unit": "ms",
      "avg_attempts": 1.2,
      "avg": 583.0,
      "mdn": 522.0,
      "max": 1187,
      "min": 347,
      "std": 201.0,
      "from_utc": "2013-09-26T15:00:00",
      "to_utc": "2013-09-26T15:59:59",
      "sla_percent": 90.0,
      "total_count": 10,
      "i_count": 7,
      "w_count": 2,
      "e_count": 0,
      "f_count": 1,
      "u_count": 0,
      "step_metrics": [
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        },
        {
          "step": 1,
          "dom_complete": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_interactive": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "dom_content_loaded": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "response": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          },
          "render": {
            "std": 0.9,
            "min": 1,
            "max": 1,
            "avg": 0.9
          }
        }
      ]
    }
  ],
  "from_utc": "2013-09-26T15:00:00",
  "to_utc": "2013-09-26T15:59:59"
}
NameType Description
check_guid Guid

No documentation available.

check_type String

No documentation available.

target_sla String

No documentation available.

check_id Integer

No documentation available.

check_name String

No documentation available.

sla_records Array

No documentation available.

unit String

The unit of the check return value.

avg_attempts Float

The average number of attempts performed per check run during the period.

avg Float

The average check return value during the period.

mdn Float

The median check return value during the period.

max Integer

The maximum check return value during the period.

min Integer

The minumum check return value during the period.

std Float

The standard deviation for the check return value during the period.

from_utc DateTime

Start of the time period (UTC).

to_utc DateTime

End of the time period (UTC).

sla_percent Float

The ratio of successful (i.e. I and W severity) runs to total runs.

total_count Integer

Total number of check runs during the period.

i_count Integer

Number of check runs with severity=I during the period.

w_count Integer

Number of check runs with severity=W during the period.

e_count Integer

Number of check runs with severity=E during the period.

f_count Integer

Number of check runs with severity=F during the period.

u_count Integer

Number of check runs with unknown severity (U) during the period.

step_metrics Array

Array of step metrics.

step Integer

The number of step.

dom_complete Object

DOM Complete

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

dom_interactive Object

DOM Interactive

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

dom_content_loaded Object

DOM Content Loaded

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

response Object

Response Time

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

render Object

Total Browser Render Time

std Float

The standard deviation for the step metric value.

min Integer

The minimum step metric value.

max Integer

The maximum step metric value.

avg Float

The average step metric value.

from_utc DateTime

No documentation available.

to_utc DateTime

No documentation available.