ThousandEyes API v6

Saved Events

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.

While there is no specific endpoint for Saved Events, ThousandEyes allows users to retrieve data for saved events through the normal test data endpoints. See the Test Data section for a list of endpoints that can be used to retrieve data for saved events. Unlike standard tests, saved events MUST be queried with the date range you wish to retrieve. See the window= and from= parameters in the list below.

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

Without specifying a time range parameter, your query will return only the last round of data available. In the two examples below, the first request returns the test's first round of data, whereas the second request (where a date range is specified) returns the data for the requested range.

Example 1 (no time range specified)

Note in this circumstance, the last round of data is returned (since a request without a time range was specified)

curl

json

Copy$ curl https://api.thousandeyes.com/v6/web/page-load/35199.json \
  -u {email}:{authToken}

Copy{
    "web": {
        "test": {
            "createdDate": "2014-10-28 16:15:10",
            "createdBy": "API Sandbox Admin (api.sandbox+admin@thousandeyes.com)",
            "enabled": 1,
            "savedEvent": 1,
            "testId": 35199,
            "testName": "Google Event",
            "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",
            "apiLinks": [...]
        },
        "pageLoad": [
            {
                "agentName": "Kwai Chung, Hong Kong",
                "countryId": "HK",
                "date": "2014-10-22 10:03:04",
                "agentId": 12,
                "roundId": 1413972000,
                "responseTime": 35,
                "totalSize": 7278,
                "numObjects": 4,
                "numErrors": 0,
                "domLoadTime": 171,
                "pageLoadTime": 205,
                "permalink": "https://app.thousandeyes.com/web/page-load?__a=75&testId=35199&roundId=1413972000&agentId=12"
            },
            ...
        ]
    },
    "pages": {
        "current": 1
    }
}

Example 2 (time range specified)

Note in this circumstance, the full set of data is returned, and may involve paging - since a specific range was specified. If the time range used in the query did not overlap with the available data, no data would be returned.

curl

json

Copy$ curl https://api.thousandeyes.com{{ site.version_url_prefix_request}}/web/page-load/35199.json?from=2014-10-22+06:00:00&to=2014-10-22+10:00:00 \
  -u {email}:{authToken}

Copy{
    "from": "2014-10-22 06:00:00",
    "to": "2014-10-22 10:00:00",
    "web": {
        "test": {
            "createdDate": "2014-10-28 16:15:10",
            "createdBy": "API Sandbox Admin (api.sandbox+admin@thousandeyes.com)",
            "enabled": 1,
            "savedEvent": 1,
            "testId": 35199,
            "testName": "Google Event",
            "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",
            "apiLinks": [...]
        },
        "pageLoad": [
            {
                "agentName": "Kwai Chung, Hong Kong",
                "countryId": "HK",
                "date": "2014-10-22 06:01:00",
                "agentId": 12,
                "roundId": 1413957600,
                "responseTime": 37,
                "totalSize": 7281,
                "numObjects": 4,
                "numErrors": 0,
                "domLoadTime": 341,
                "pageLoadTime": 384,
                "permalink": "https://app.thousandeyes.com/web/page-load?__a=75&testId=35199&roundId=1413957600&agentId=12"
            },
            ...
        ]
    },
    "pages": {
        "current": 1
    }
}