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.
The ThousandEyes API supports the following formats for responses:
- JSON (JavaScript Object Notation)
- XML (Extensible Markup Language)
It is possible to control the output of the API's results using the following options, in descending order of precedence.
In the event that multiple, conflicting formats are specified, the order of precedence is:
- Request
- Accept Header
- Querystring Parameter.
There are three ways to specify the response format:
- Append an extension to the endpoint in the request URL path.
- Include the
Accept header in your request.
- Use the
format URL query parameter.
To specify response format using the request URL, append either .json or .xml to the endpoint in the URL (before any URL query parameters). For example, you can get the list of tests from the /v6/tests endpoint in JSON format by sending a request to https://api.thousandeyes.com/v6/tests.json, or get the same list in XML format by sending a request to https://api.thousandeyes.com/v6/tests.xml.
JSON
To request a JSON response:
XML
To request an XML response:
Modifying the header to accept different response types is themost recommended approach.
JSON
Set the value to Accept: application/json for JSON.
XML
Set the value to Accept: text/xml for XML.
QueryString Parameter
Append a format parameter to the end of a QueryString to change the response format. The parameter and values must be in lowercase. Acceptable options include:
JSON
XML