ThousandEyes API v6
ThousandEyes API v6

(Web) Page Load

ThousandEyes API v6 has been deprecated as of May 27, 2024. We strongly recommend that you migrate to ThousandEyes API v7 to ensure continued support and access to new features. For more information, see the deprecation notice.

GET /v6/web/page-load/{testId}

Returns response time, total size, count of objects and errors, and provides page and DOM load times for a web page.

Parameters

Querystring

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • window=[0-9]+[smhdw]? specifies a window of time for the result set. See Time Ranges for more information.
  • from=YYYY-mm-ddTHH:MM:SS&to=YYYY-mm-ddTHH:MM:SS specifies an explicit start (and optionally, end) for your range of data. See Time Ranges for more information.
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

  • {testId} the ID of the page load test you for wish to retrieve data
  • There is no request body for this request.

Response

Field Data Type Units Notes
agentId integer n/a unique ID of agent, from /agents endpoint
agentName string n/a display name of the agent responding
countryId string n/a ISO-3166-1 alpha-2 country code of the agent
date dateTime n/a yyyy-MM-dd hh:mm:ss, in UTC
roundId long seconds epoch time (seconds) indicating the start time of the round
permalink url n/a link to jump to this result in the front end
responseTime integer milliseconds time to first byte
totalSize integer bytes sum of wire size of all objects on page
numObjects integer n/a number of objects found on the page
numErrors integer n/a number of objects which encountered errors during download
domLoadTime integer milliseconds time to interaction
pageLoadTime integer milliseconds time to completely load page

Example

curl
Copy$ curl https://api.thousandeyes.com/v6/web/page-load/818.json \
  -u {email}:{authToken}
Code Snippet
CopyHTTP/1.1 200 OK
Server: nginx
Date: Thu, 08 Nov 2013 07:32:48 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 240
X-Organization-Rate-Limit-Remaining: 228
X-Organization-Rate-Limit-Reset: 1493288220
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-3

Body

json
Copy{
    "web": {
        "test": {
            "createdDate": "2012-06-28 19:34:33",
            "modifiedDate": "2016-09-20 23:01:55",
            "createdBy": "API Sandbox User (noreply@thousandeyes.com)",
            "modifiedBy": "API Sandbox User (noreply@thousandeyes.com)",
            "enabled": 1,
            "savedEvent": 0,
            "testId": 818,
            "testName": "http://www.google.com",
            "type": "page-load",
            "interval": 900,
            "httpInterval": 900,
            "url": "http://www.google.com",
            "protocol": "TCP",
            "networkMeasurements": 1,
            "mtuMeasurements": 1,
            "bandwidthMeasurements": 0,
            "bgpMeasurements": 1,
            "usePublicBgp": 1,
            "alertsEnabled": 0,
            "liveShare": 0,
            "httpTimeLimit": 5,
            "httpTargetTime": 1000,
            "httpVersion": 2,
            "pageLoadTimeLimit": 30,
            "pageLoadTargetTime": 2,
            "followRedirects": 1,
            "includeHeaders": 0,
            "sslVersionId": 0,
            "sslVersion": "Auto"
            "verifyCertificate": 1,
            "useNtlm": 0,
            "authType": "NONE",
            "contentRegex": "",
            "probeMode": "AUTO",
            "pathTraceMode": "classic",
            "apiLinks": [...]
        },
        "pageLoad": [
            {
                "agentName": "Kwai Chung, Hong Kong",
                "countryId": "HK",
                "date": "2018-07-12 14:00:24",
                "agentId": 12,
                "roundId": 1531404000,
                "responseTime": 34,
                "totalSize": 403301,
                "numObjects": 17,
                "numErrors": 0,
                "domLoadTime": 352,
                "pageLoadTime": 352,
                "permalink": "https://app.thousandeyes.com/web/page-load?__a=75&testId=818&roundId=1531404000&agentId=12"
            },
            ...
        ]
    },
    "pages": {
        "current": 1
    }
}

For more information on our HTTP response status codes, see the response status codes documentation.

Next