Release notes for ThousandEyes API v7.

API Changelog

The following list documents a running list of changes to version 7 of the ThousandEyes API. Each release date is linked to the specific release notes for that release. For details related to other versions of the ThousandEyes API, see the links on the left sidebar.

For more information, see the Changelog

December 19, 2024 - v7.0.34

Updates

Updated the ThousandEyes for OpenTelemetry API to add support for updating the streamEndpointUrl field via the Update Data Stream API operation.
Updated the Alerts API to add three additional test types to the RuleDetail schema. For more information, see AlertSimpleTest and AlertTestType.

December 17, 2024 - v7.0.33

Updates

Updated the Dashboards API to add the following experience score metrics to DashboardMetric:
- ENDPOINT_GATEWAY_AGENT_SCORE
- ENDPOINT_GATEWAY_SCORE
- ENDPOINT_GATEWAY_CONNECTION_SCORE
- ENDPOINT_GATEWAY_PROXY_SCORE
- ENDPOINT_GATEWAY_VPN_SCORE
- ENDPOINT_AST_TEST_APPLICATION_SCORE
- ENDPOINT_TEST_APPLICATION_SCORE
- ENDPOINT_TEST_HTTP_APPLICATION_SCORE
Added rate limits to the Deploy template API operation. For more information, see Template Deployment Rate Limits.

December 11, 2024 - v7.0.31

Updates

Extended Local Network Topology APIs to optionally include top applications by CPU and memory usage in the system metric details. This data is not included by default and can be accessed using the ?expand=system-metric-detail query parameter. For more information, see ExpandLocalNetworkTopologyOptions.

November 26, 2024 - v7.0.29

New

Randomized Start Time for Tests

You can now enable tests to use a randomized start time via the API. This feature is useful for environments with a large number of Cloud Agents or Enterprise Agents testing the same target. It reduces the concurrent load on targets by distributing test start times within a configurable interval. By default, this feature is disabled for all tests but can be enabled via the API when needed. For more information, see TestRandomizedStartTime.

Updates

Added OAuth2 authentication support for the API test type

November 19, 2024 - v7.0.28

Updates

Added a new field, resourceInclusion, to the Templates API. This field can be used in the template definition or deployment payload to specify which assets should be excluded during a template deployment.

October 25, 2024 - v7.0.26

Updates

Added a new field, throughput, to the Test Results API response for agent-to-agent test results. This field reports the measured throughput in Mbps for each test round. Note that throughput was previously included in the v6 API response but had not been documented until now.

October 8, 2024 - v7.0.25

Updates

Custom Webhook and ServiceNow Incident Management Integrations for Alert Rules:
You can now assign Custom Webhook and ServiceNow Incident Management integration types to alert rules using the following API endpoints:
- POST /v7/alerts/rules: Create a new alert rule with these integration types.
- PUT /v7/alerts/rules/{ruleId}: Update an existing alert rule with these options.
This update enhances flexibility in managing notifications for alert rules.
Resolved an issue where incorrect Custom Webhook Integration IDs were displayed.

October 7, 2024 - v7.0.24

Updates

Updated the Templates API to introduce a new groupings property in the Template model. This property allows the grouping of related user inputs or tests when creating or updating a template. This grouping is for display purposes in the UI and does not affect template deployment. Supported resource types include tests and user-inputs. Grouped tests are displayed under a shared title in the template test list, while grouped user inputs are organized into sections within the Global Inputs area, using the provided title and description.

September 26, 2024 - v7.0.22

Updates

Updated the ThousandEyes for OpenTelemetry API to allow filtering data points by test type.vThis filtering can be set when creating or updating a Stream, and is only available via the API.

For example, if a user is only interested in the HTTP test type and wants to exclude NETWORK or BGP layers, the filter can be configured as follows:
```
"filters": {
  "testTypes": {
      "values": [
        "http_server"
      ]
  }
}
```

September 24, 2024

Updates

Updated the Tags API so you can now add or update the icon and description fields for tags.
- Supported icon values: "LABEL", "CIRCLE", "TRIANGLE", "SQUARE", "STAR", "LIGHTNING_BOLT", "MAP_PIN", "DASHBOARD", "WEB_APPLICATION".
- The description field is optional.

September 18, 2024

New

Configure Splunk HEC Exporter in ThousandEyes for OpenTelemetry:

You can now configure the following fields in the Splunk HEC exporter stream: token, source, sourceType, and index. For more details, visit the Splunk integration guide.

With the new capability to configure the Splunk HEC index, you can choose whether to export ThousandEyes telemetry data as events or metrics to Splunk. Learn more here.

Additionally, setting the Splunk HEC token in customerHeaders["token"] is now deprecated. The token should be specified in exporterConfig.SplunkHec.token going forward. This functionality will be removed in 3 months.

Updates

Updated the Alerts API to support the AUTO window grouping for CEA Agents, enabling Adaptive Alerting.

With the AUTO window grouping, you can now configure the sensitivityLevel parameter to control the alert sensitivity. The available options are:
- LOW
- MEDIUM (default)
- HIGH

September 5, 2024

New

ThousandEyes for OpenTelemetry Introduces dataModelVersion v2: ThousandEyes for OpenTelemetry now supports dataModelVersion v2. As part of this update, ThousandEyes for OpenTelemetry now uses dataModelVersion v2 as the default version. Both dataModelVersion v1 and v2 remain available for use. For more details, refer to the ThousandEyes for OpenTelemetry Data Model documentation.

Updates

Updated the Usage API operation to add a new deviceAgentsIncluded field to the UsageQuota object. This field indicates the amount of allocated device agents (connected devices product) in the customer's contract.

August 30, 2024

New

Unified OpenAPI Document Now Available: We have released a unified OpenAPI document that consolidates all API endpoints into a single file. You can download the unified OpenAPI document here.

Updates

Proxy Configuration for API Tests via ThousandEyes Public API: You can now configure proxy settings for API tests using the ThousandEyes public API, enabling successful testing of API targets behind a proxy. This update also introduces the ability to gather network metrics, including proxy loss, latency, and jitter, as well as visualize proxy server paths and details in your test results.
Updated the Dashboards API to add rate limit.

August 23, 2024

Updates

Updated Scheduled and Dynamic Tests API Operations to Align with the Endpoint UI for Test Creation
- Updated the following APIs to better align with the endpoint UI for test creation:
- Key changes include:
  - interval defaults to 60.
  - maxMachines defaults to 25.
  - agentSelectorType defaults to all-agents.
  - The request fields hasPing and hasTraceroute are deprecated. For the create HTTP-server endpoint scheduled test API, use the networkMeasurements field to enable or disable ping and traceroute.
Updated Endpoint Instant Test and HTTP-Server Scheduled Test API Operations to Align with the UI
- Updated the following APIs to better align with the UI.
  - create http-server endpoint scheduled test
  - create http-server endpoint instant test
- Key changes include:
  - sslVersionID defaults to '0'.
  - httpTimeLimit defaults to 5000ms.
  - targetResponseTime defaults to 1000ms.
  - verifyCertificate defaults to true.
  - request fields hasPing and hasTraceroute are deprecated. Use networkMeasurements instead for enabling/disabling running ping and traceroute.

August 13, 2024

New

AUTO Window Grouping Support now available for both Cloud and Enterprise Agents (CEA), and Endpoint Agents:
- Cloud and Enterprise Agents: When selecting AUTO window grouping, you can now set the sensitivityLevel parameter to LOW, MEDIUM, or HIGH (default is MEDIUM).
- Endpoint Agents: AUTO window grouping is automatically applied when you specify a sensitivityLevel parameter value.

August 6, 2024

New

Added a new endpoint (/v7/endpoint/test-results/scheduled-tests/http-server/filter) to the Endpoint Test Results API. This endpoint allows filtering and sorting of data across multiple HTTP tests, including filtering by timing and response codes.

July 30, 2024

Updates

Updated the ThousandEyes for OpenTelemetry API to add a new DataModelVersion field to the Stream object. This field indicates the version of the data model used in the data stream, currently fixed at v1. This enhancement provides users with a clearer understanding of the data structure and the version of the data model in use.
Updated the Endpoint Test Results API with the following:
- Added protocol, tcpPathTraceMode and udpPathTraceMode to the PathVisRoute object.
- Added EndpointTestResultProtocol to differentiate the network protocol in the test results and the protocol configured in the test

July 26, 2024

Updates

Updated the get alert rule endpoint GET /v7/alerts/rules/{ruleId} to now include custom webhook integrations under the customWebhook field in notifications. The endpoint now provides integration ID, type, name, and target URL for custom webhook integrations, in addition to existing webhook and third-party integrations under the notifications header.

July 22, 2024

New

Added support for agentInterfaces, downloadLimit, dnsOverride, and oAuth to web-based CEA tests.

July 12, 2024

Updates

Updated the supported assignment types for tags to include test, v-agent, endpoint-test, and dashboard. Additionally, updated the legacyId attribute type in TagInfo to number.

June 25, 2024

New

We've updated ThousandEyes for OpenTelemetry API to support streaming data from ThousandEyes to Splunk Cloud Platform and Splunk Enterprise using the splunk-hec StreamType. For more information, see Configuring ThousandEyes for Splunk Cloud or Enterprise Using the API.

June 14, 2024

Updates

Labels to Tags Migration: Starting June 24, 2024, all existing labels in the ThousandEyes backend will be migrated to tags. When querying the v7 API (e.g., /v7/tags), labels will now appear as tags in the format key:value. For example, a label with the value webex will be displayed as webex:webex. Migrated labels will include a legacyID field in the API response, indicating their original label ID. Tags created natively will have an empty legacyID field. This migration affects CEA Tests, CEA Agents, Endpoint Scheduled Tests, and Dashboards, but not Endpoint Agents. Note that this change only impacts the API; the UI will continue to display labels as they are until tags are introduced in a future release.

June 11, 2024

Deprecated

The objectType field of the tagMatch in the creation of a stream for the ThousandEyes for OpenTelemetry API is now deprecated and will be removed after August 2024.

May 23, 2024

Updates

The Emulation API now uses lowercase characters for the emulated device category values, such as desktop, laptop, phone, and tablet.
Added the testMatch array to the ThousandEyes for OpenTelemetry API, enabling direct association of ThousandEyes tests with a stream integration to simplify the setup process.

May 8, 2024

New

New Emulation API, at /v7/user-agents,/v7/emulated-devices

March 26, 2024

New

Templates API (formerly Test Templates API) is now available at /v7/templates

March 11, 2024

New

New Dashboard API operation, at /v7/dashboards:
- List dashboard filters: /v7/dashboards/filters
New Usage API operations, at /v7/usage:
- Get enterprise agent usage: /v7/usage/units/enterprise-agents
- Get cloud and enterprise agents units usage: /v7/usage/units/tests

March 4, 2024

New

New Event Detection API, at /v7/events

March 1, 2024

Updates

Templates API (formerly Test Templates API) is temporarily unavailable. It is being updated to be in compliance with the rest of the ThousandEyes API

February 20, 2024

New

New Test Results API operation, at /v7/endpoint-test-results:
- Retrieve network scheduled test results from multiple tests: /v7/endpoint/test-results/scheduled-tests/network/filter

November 30, 2023

New

New Snapshots API, at /v7/snapshots
New Usage API, at /v7/usage
New Tests API, at /v7/tests
New Test Results API, at /v7/test-results
New Agents API, at /v7/agents
New Instant Tests API, at /v7/instant-tests
New Endpoint Agents API, at /v7/endpoint-agents
New Endpoint Labels API, at /v7/endpoint-labels
New Endpoint Test Results API, at /v7/endpoint-test-results
New Endpoint Tests API, at /v7/endpoint-tests
New Credentials API, at /v7/credentials
New Dashboards API, at /v7/dashboards

October 27, 2023

New

New Alerts API, at /v7/alerts

August 17, 2023

New

New BGP Monitors API, at /v7/bgp-monitors

July 24, 2023

New

New Admin API, at /v7/admin

Updates

The alertId attribute in the alerts and alertdetail API has been converted from an integer to a string. This update takes effect from 1st August, 2023.