POST checks/url-v2/{checkId}/results
Gets URL check (version 2) results in json format.
URL Parameters
| Name | Description |
|---|---|
| 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 example and description
curl --request POST "https://api-asm1.apica.io/v3/checks/url-v2/12345/results?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{
\"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\": [
\"fa481f4a-46bc-4e0c-82e0-76e784e0ee47\",
\"1701d90f-c064-4889-b302-dc6f632ab99b\",
\"cee12c42-c178-4526-b073-93be213c131a\"
]
}
}
}"
| Name | Type | 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": 12345,
"check_results": [
{
"result_id": "4790f596-be1d-4096-919e-77c89f02e0fc",
"timestamp_utc": "2024-11-21T04:22:23",
"severity": "I",
"value": 3000,
"unit": "byte",
"result_details": {
"message": "1 step, 1 page, 19 urls, 3990/482261 sent/received bytes",
"attempts": 1,
"result_code": 200
},
"urls": [
{
"step": 3,
"url_number": 2,
"url": "1",
"offset_ms": 200,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 200000,
"sent_bytes": 10000,
"error_code": 500,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": null,
"http_method": "PUT",
"http_result": "No Content",
"http_status_code": 201,
"content_from_cache": true,
"content_mime_type": "image/gif",
"content_size_bytes": 45678,
"request_cookie_count": 6,
"request_header_count": 6,
"response_cookie_count": 5,
"response_header_count": 6,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 897,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
},
{
"step": 2,
"url_number": 2,
"url": "1",
"offset_ms": 300,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 100000,
"sent_bytes": 30000,
"error_code": 404,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": null,
"http_method": "GET",
"http_result": "OK",
"http_status_code": 500,
"content_from_cache": true,
"content_mime_type": "text/css",
"content_size_bytes": 12345,
"request_cookie_count": 5,
"request_header_count": 5,
"response_cookie_count": 7,
"response_header_count": 5,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 997,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
},
{
"step": 3,
"url_number": 1,
"url": "2",
"offset_ms": 100,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 300000,
"sent_bytes": 20000,
"error_code": 404,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": "https://fast.com",
"http_method": "GET",
"http_result": "No Content",
"http_status_code": 201,
"content_from_cache": true,
"content_mime_type": "image/gif",
"content_size_bytes": 23456,
"request_cookie_count": 7,
"request_header_count": 7,
"response_cookie_count": 7,
"response_header_count": 5,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 797,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
}
]
},
{
"result_id": "3bd17687-eb12-4916-8e8e-58d17d71a85b",
"timestamp_utc": "2024-11-21T04:22:23",
"severity": "F",
"value": 1000,
"unit": "byte",
"result_details": {
"message": "1 url, 148/6797 sent/received bytes.",
"attempts": 3,
"result_code": 0
},
"urls": [
{
"step": 3,
"url_number": 1,
"url": "2",
"offset_ms": 100,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 300000,
"sent_bytes": 20000,
"error_code": 404,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": "https://fast.com",
"http_method": "GET",
"http_result": "No Content",
"http_status_code": 201,
"content_from_cache": true,
"content_mime_type": "image/gif",
"content_size_bytes": 23456,
"request_cookie_count": 7,
"request_header_count": 7,
"response_cookie_count": 7,
"response_header_count": 5,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 797,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
},
{
"step": 3,
"url_number": 1,
"url": "2",
"offset_ms": 100,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 300000,
"sent_bytes": 20000,
"error_code": 404,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": "https://fast.com",
"http_method": "GET",
"http_result": "No Content",
"http_status_code": 201,
"content_from_cache": true,
"content_mime_type": "image/gif",
"content_size_bytes": 23456,
"request_cookie_count": 7,
"request_header_count": 7,
"response_cookie_count": 7,
"response_header_count": 5,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 797,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
},
{
"step": 2,
"url_number": 2,
"url": "1",
"offset_ms": 300,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 100000,
"sent_bytes": 30000,
"error_code": 404,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": null,
"http_method": "GET",
"http_result": "OK",
"http_status_code": 500,
"content_from_cache": true,
"content_mime_type": "text/css",
"content_size_bytes": 12345,
"request_cookie_count": 5,
"request_header_count": 5,
"response_cookie_count": 7,
"response_header_count": 5,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 997,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
}
]
},
{
"result_id": "961c1c03-aa36-435f-83db-aa371a770e23",
"timestamp_utc": "2024-11-21T04:22:23",
"severity": "U",
"value": 3000,
"unit": "byte",
"result_details": {
"message": "1 step, 1 page, 19 urls, 3990/482261 sent/received bytes",
"attempts": 1,
"result_code": 200
},
"urls": [
{
"step": 3,
"url_number": 2,
"url": "1",
"offset_ms": 200,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 200000,
"sent_bytes": 10000,
"error_code": 500,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": null,
"http_method": "PUT",
"http_result": "No Content",
"http_status_code": 201,
"content_from_cache": true,
"content_mime_type": "image/gif",
"content_size_bytes": 45678,
"request_cookie_count": 6,
"request_header_count": 6,
"response_cookie_count": 5,
"response_header_count": 6,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 897,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
},
{
"step": 2,
"url_number": 2,
"url": "1",
"offset_ms": 300,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 100000,
"sent_bytes": 30000,
"error_code": 404,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": null,
"http_method": "GET",
"http_result": "OK",
"http_status_code": 500,
"content_from_cache": true,
"content_mime_type": "text/css",
"content_size_bytes": 12345,
"request_cookie_count": 5,
"request_header_count": 5,
"response_cookie_count": 7,
"response_header_count": 5,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 997,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
},
{
"step": 3,
"url_number": 2,
"url": "1",
"offset_ms": 200,
"started_utc": "2024-11-21T04:22:23",
"elapsed_ms": 3000,
"received_bytes": 200000,
"sent_bytes": 10000,
"error_code": 500,
"error_message": "",
"complete": true,
"redirect": true,
"redirect_url": null,
"http_method": "PUT",
"http_result": "No Content",
"http_status_code": 201,
"content_from_cache": true,
"content_mime_type": "image/gif",
"content_size_bytes": 45678,
"request_cookie_count": 6,
"request_header_count": 6,
"response_cookie_count": 5,
"response_header_count": 6,
"response_status_line": "HTTP/1.1 200 OK",
"blocked_duration_ms": 1345,
"blocked_url_offset_ms": 102,
"dns_lookup_duration_ms": 4,
"dns_lookup_url_offset_ms": 0,
"connect_duration_ms": 24,
"connect_url_offset_ms": 4,
"receive_duration_ms": 53,
"receive_url_offset_ms": 1038,
"send_duration_ms": 394,
"send_url_offset_ms": 422,
"ttfb_duration_ms": 900,
"ttfb_url_offset_ms": 900,
"wait_duration_ms": 222,
"wait_offset_ms": 816,
"step_duration_ms": 897,
"response_time_ms": 697,
"started_utc_iso_8601": "2024-11-21T04:22:23",
"canceled": false,
"headers": {
"request_headers": [
{
"Key": "accept",
"Value": "*/*"
},
{
"Key": "user-agent",
"Value": "Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20140101 Firefox/28.0 Apica/2.0"
}
],
"response_headers": [
{
"Key": "connection",
"Value": "Upgrade"
},
{
"Key": "content-type",
"Value": "text/html; charset=UTF-8"
},
{
"Key": "location",
"Value": "?type=redirected"
}
]
}
}
]
}
]
}
| Name | Type | Description |
|---|---|---|
| check_id | Integer |
The numeric identifier of the check. |
| check_results | Array |
The check results. |
| CheckId | Integer |
No documentation available. |
| result_id | Guid |
The result identifier. |
| timestamp_utc | DateTime |
The result timestamp in UTC. |
| severity | String |
The result severity. |
| value | Integer |
The result's value. |
| unit | String |
The result value measures unit. |
| result_details | Object |
The result details. |
| message | String |
The result message. |
| attempts | Integer |
The number of attempts. |
| result_code | Integer |
The code of result. |
| urls | Array |
The result URLs details. |
| headers | Object |
The URL headers. |
| request_headers | Object |
The URL request headers. |
| response_headers | Object |
The URL response headers. |
| step | Integer |
The number of the step. |
| url_number | Integer |
The number of the URL. |
| url | String |
The number of the URL. |
| offset_ms | Integer |
The URL request time offset. |
| started_utc | DateTime |
The URL request start time. |
| elapsed_ms | Integer |
The elapsed time. |
| received_bytes | Integer |
The received bytes. |
| sent_bytes | Integer |
The sent bytes. |
| error_code | Integer |
The error code. |
| error_message | String |
The error message. |
| complete | Boolean |
The request complete status. |
| redirect | Boolean |
Response with a redirect. |
| redirect_url | String |
The redirect URL. |
| http_method | String |
The HTTP method. |
| http_result | String |
The HTTP result. |
| http_status_code | Integer |
The HTTP status code. |
| content_from_cache | Boolean |
The content was loaded from the cache. |
| content_mime_type | String |
The content type. |
| content_size_bytes | Integer |
The content size in bytes. |
| request_cookie_count | Integer |
The request cookie count. |
| request_header_count | Integer |
The request headers count. |
| response_cookie_count | Integer |
The response cookie count. |
| response_header_count | Integer |
The response headers count. |
| response_status_line | String |
The response status line. |
| blocked_duration_ms | Integer |
The browser block duration. |
| blocked_url_offset_ms | Integer |
The block start offset. |
| dns_lookup_duration_ms | Integer |
The DNS Lookup duration. |
| dns_lookup_url_offset_ms | Integer |
The DNS Lookup offset. |
| connect_duration_ms | Integer |
The connect duration. |
| connect_url_offset_ms | Integer |
The connect URL offset. |
| receive_duration_ms | Integer |
The receive duration. |
| receive_url_offset_ms | Integer |
The receive URL offset. |
| send_duration_ms | Integer |
The send duration. |
| send_url_offset_ms | Integer |
The send URL offset. |
| ttfb_duration_ms | Integer |
The time to first byte duration. |
| ttfb_url_offset_ms | Integer |
The time to first byte offset. |
| wait_duration_ms | Integer |
The wait duration. |
| wait_offset_ms | Integer |
The wait offset. |
| step_duration_ms | Integer |
The step duration. |
| response_time_ms | Integer |
The response time. |
| started_utc_iso_8601 | String |
The start timestamp in UTC ISO 8601 format. |
| canceled | Boolean |
The request 'cancelled' status. |