ThousandEyes API v6
ThousandEyes API v6

(Network) BGP Metrics

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/net/bgp-metrics/{testId}

Returns a list of BGP monitors observing the target prefix of the destination, and returns the prefix, AS Number, and reachability, path updates, and path changes for the target network.

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 test for which BGP data is of interest
  • There is no request body for this request.

Response

Note: Monitors are not agents. Not all agents are in a network being monitored, and not all monitors have associated agents.

Field Data Type Units Notes
monitorId integer n/a unique ID of monitor, from /bgp-monitors endpoint
monitorName string n/a display name used for the monitor
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
prefixId integer n/a internally tracked prefix ID
prefix string n/a prefix being tracked
updates float n/a number of updates tracked against this prefix by this monitor
pathChanges float n/a number of path changes tracked against this prefix by this monitor
reachability float percentage percentage reachability

Example

curl
Copy$ curl https://api.thousandeyes.com/v6/net/bgp-metrics/817.json \
  -u {email}:{authToken}
Code Snippet
CopyHTTP/1.1 200 OK
Server: nginx
Date: Thu, 07 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: 1493233860
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-3

Body

json
Copy{
    "net": {
        "test": {
            "enabled": 1,
            "testId": 817,
            "testName": "http://www.thousandeyes.com",
            "type": "http-server",
            "interval": 900,
            "url": "http://www.thousandeyes.com",
            "modifiedDate": "2013-05-11 02:02:21",
            "networkMeasurements": 1,
            "createdBy": "API Sandbox User (noreply@thousandeyes.com)",
            "modifiedBy": "API Sandbox User (noreply@thousandeyes.com)",
            "createdDate": "2012-06-28 19:33:12",
            "apiLinks": [...]
        },
        "bgpMetrics": [
            {
                "countryId": "CA",
                "date": "2013-11-13 03:45:00",
                "prefixId": 215,
                "prefix": "50.16.0.0/14",
                "monitorName": "Vancouver, Canada - Bell Canada (AS 6539)",
                "monitorId": 45,
                "reachability": 100,
                "roundId": 1384314300,
                "updates": 0.0,
                "permalink": "https://app.thousandeyes.com/net/bgp-vis?__a=75&testId=817&roundId=1384314300&prefixId=215",
                "pathChanges": 0.0
            },
            ...
        ]
    },
    "pages": {
        "current": 1
    }
}

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

Next