POST   checks/url-v2/{checkId}/results

Gets composite URL check (version 2) results in json format.

URL Parameters

NameDescription
checkId

Check identifier. Type: numeric.

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.

Request body model example and description

{
  "include": {
    "result_details": {},
    "urls": {
      "include_headers": true
    }
  },
  "filter": {
    "range": {
      "mostrecent": 10,
      "milliseconds_utc": [
        1376980667000,
        1376980667001
      ],
      "period": {
        "from_utc": "2013-08-20T13:32:08",
        "to_utc": "2013-08-21T13:32:08"
      },
      "result_ids": [
        "9a0cb850-686f-4144-8608-381d5296fb65",
        "01f8b7b9-1aa7-40d7-8ea8-f2145c18fc2f",
        "408ca3aa-87de-4808-9320-20777048ba7b"
      ]
    }
  }
}
NameType Required Description
include Object No

The include section defines additional URL check (version 2) results information to include into the response (if it exists and can be retrieved). If this section omitted or empty, the response will only contain basic data.

result_details Object No

Specify the result_details section to include result details. For including, use values: {} or true. For not including do not specify this section or use value: false.

urls Object No

Specify the urls section to include data from URLs.

include_headers Boolean No

The include_headers flag indicates if information about request and response headers should be included. Default value: false.

filter Object Yes

The filter section defines the criteria for selecting the check results.

range Object Yes

This section allows to define the aggregate range of the results by combining different filters. It must contain at least one filter.

mostrecent Integer No

Number of most recent results.

milliseconds_utc Array No

Array of timestamps associated with results. Each item is represented by a UNIX Epoch timestamp (milliseconds after 1970).

period Object No

The period section defines the date range to obtain results for.

from_utc DateTime Yes

Starting timestamp (in UTC) for the date range.

to_utc DateTime Yes

Ending timestamp (in UTC) for the date range.

result_ids Array No

Array of result identifiers to specific results.

Response body model example and description

{
  "check_id": 1,
  "check_results": [
    {
      "result_id": "dd002798-5067-4a58-aee4-2b25d885d5f2",
      "timestamp_utc": "2019-08-21T12:30:02",
      "severity": "sample string 3",
      "value": 1,
      "unit": "sample string 4",
      "result_details": {
        "message": "sample string 1",
        "attempts": 1,
        "result_code": 1
      },
      "urls": [
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        },
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        },
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        }
      ]
    },
    {
      "result_id": "dd002798-5067-4a58-aee4-2b25d885d5f2",
      "timestamp_utc": "2019-08-21T12:30:02",
      "severity": "sample string 3",
      "value": 1,
      "unit": "sample string 4",
      "result_details": {
        "message": "sample string 1",
        "attempts": 1,
        "result_code": 1
      },
      "urls": [
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        },
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        },
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        }
      ]
    },
    {
      "result_id": "dd002798-5067-4a58-aee4-2b25d885d5f2",
      "timestamp_utc": "2019-08-21T12:30:02",
      "severity": "sample string 3",
      "value": 1,
      "unit": "sample string 4",
      "result_details": {
        "message": "sample string 1",
        "attempts": 1,
        "result_code": 1
      },
      "urls": [
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        },
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        },
        {
          "step": 1,
          "url_number": 2,
          "url": "sample string 3",
          "offset_ms": 4,
          "started_utc": "2019-08-21T12:30:02",
          "elapsed_ms": 6,
          "received_bytes": 7,
          "sent_bytes": 8,
          "error_code": 9,
          "error_message": "sample string 10",
          "complete": true,
          "redirect": true,
          "redirect_url": "sample string 13",
          "http_method": "sample string 14",
          "http_result": "sample string 15",
          "http_status_code": 16,
          "content_from_cache": true,
          "content_mime_type": "sample string 18",
          "content_size_bytes": 19,
          "request_cookie_count": 20,
          "request_header_count": 21,
          "response_cookie_count": 22,
          "response_header_count": 23,
          "response_status_line": "sample string 24",
          "blocked_duration_ms": 25,
          "blocked_url_offset_ms": 26,
          "dns_lookup_duration_ms": 27,
          "dns_lookup_url_offset_ms": 28,
          "connect_duration_ms": 29,
          "connect_url_offset_ms": 30,
          "receive_duration_ms": 31,
          "receive_url_offset_ms": 32,
          "send_duration_ms": 33,
          "send_url_offset_ms": 34,
          "ttfb_duration_ms": 35,
          "ttfb_url_offset_ms": 36,
          "wait_duration_ms": 37,
          "wait_offset_ms": 38,
          "step_duration_ms": 161,
          "response_time_ms": 157,
          "started_utc_iso_8601": "2019-08-21T12:30:02",
          "headers": {
            "request_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ],
            "response_headers": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        }
      ]
    }
  ]
}
NameType Description
check_id Integer

No documentation available.

check_results Array

No documentation available.

CheckId Integer

No documentation available.

result_id Guid

No documentation available.

timestamp_utc DateTime

No documentation available.

severity String

No documentation available.

value Integer

No documentation available.

unit String

No documentation available.

result_details Object

No documentation available.

message String

No documentation available.

attempts Integer

No documentation available.

result_code Integer

No documentation available.

urls Array

No documentation available.

headers Object

No documentation available.

request_headers Object

No documentation available.

response_headers Object

No documentation available.

step Integer

No documentation available.

url_number Integer

No documentation available.

url String

No documentation available.

offset_ms Integer

No documentation available.

started_utc DateTime

No documentation available.

elapsed_ms Integer

No documentation available.

received_bytes Integer

No documentation available.

sent_bytes Integer

No documentation available.

error_code Integer

No documentation available.

error_message String

No documentation available.

complete Boolean

No documentation available.

redirect Boolean

No documentation available.

redirect_url String

No documentation available.

http_method String

No documentation available.

http_result String

No documentation available.

http_status_code Integer

No documentation available.

content_from_cache Boolean

No documentation available.

content_mime_type String

No documentation available.

content_size_bytes Integer

No documentation available.

request_cookie_count Integer

No documentation available.

request_header_count Integer

No documentation available.

response_cookie_count Integer

No documentation available.

response_header_count Integer

No documentation available.

response_status_line String

No documentation available.

blocked_duration_ms Integer

No documentation available.

blocked_url_offset_ms Integer

No documentation available.

dns_lookup_duration_ms Integer

No documentation available.

dns_lookup_url_offset_ms Integer

No documentation available.

connect_duration_ms Integer

No documentation available.

connect_url_offset_ms Integer

No documentation available.

receive_duration_ms Integer

No documentation available.

receive_url_offset_ms Integer

No documentation available.

send_duration_ms Integer

No documentation available.

send_url_offset_ms Integer

No documentation available.

ttfb_duration_ms Integer

No documentation available.

ttfb_url_offset_ms Integer

No documentation available.

wait_duration_ms Integer

No documentation available.

wait_offset_ms Integer

No documentation available.

step_duration_ms Integer

No documentation available.

response_time_ms Integer

No documentation available.

started_utc_iso_8601 String

No documentation available.