thousandeyes-sdk-event-detection
Event detection occurs when ThousandEyes identifies that error signals related to a component (proxy, network node, AS, server etc) have deviated from the baselines established by events.
- To determine this, ThousandEyes takes the test results from all accounts groups within an organization, and analyzes that data.
- Noisy test results (those that have too many errors in a short window) are removed until they stabilize, and the rest of the results are tagged with the components associated with that test result (for example, proxy, network, or server).
- Next, any increase in failures from the test results and each component helps in determining the problem domain and which component may be at fault.
- When this failure rate increases beyond a pre-defined threshold (set by the algorithm), an event is triggered and an email notification is sent to the user (if they've enabled email alerts).
With the Events API, you can perform the following tasks on the ThousandEyes platform:
- Retrieve Events: Obtain a list of events and detailed information for each event. For more information about events, see Event Detection.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 7.0.110
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
Requirements.
Python 3.9+
Installation & Usage
pip install
Install directly via PyPi:
pip install thousandeyes-sdk-event-detection
(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-event-detection)
Then import the package:
import thousandeyes_sdk.event_detection
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import thousandeyes_sdk.event_detection
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import thousandeyes_sdk.core
import thousandeyes_sdk.event_detection
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com/v7"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = thousandeyes_sdk.event_detection.EventsApi(api_client)
id = 'e9c3bf02-a48c-4aa8-9e5f-898800d6f569' # str | Unique event ID.
aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)
try:
# Retrieve event
api_response = api_instance.get_event(id, aid=aid)
print("The response of EventsApi->get_event:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling EventsApi->get_event: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.thousandeyes.com/v7
| Class | Method | HTTP request | Description |
|---|---|---|---|
| EventsApi | get_event | GET /events/{id} | Retrieve event |
| EventsApi | get_events | GET /events | List events |
Documentation For Models
- AffectedAgents
- AffectedCount
- AffectedTargets
- AffectedTests
- AgentBranchEventDetail
- AgentBranchEventGrouping
- AgentEventDetail
- AgentEventGrouping
- AgentLinks
- AgentLocalEventDetail
- AgentLocalEventGrouping
- ApiAffectedTarget
- ApplicationEventDetail
- ApplicationEventGrouping
- DnsEventDetail
- DnsEventGrouping
- DnsNameEventDetail
- DnsNameEventGrouping
- DnsServerEventDetail
- DnsServerEventGrouping
- DomainEventDetail
- DomainEventGrouping
- Error
- Event
- EventAffectedAgentType
- EventAgentType
- EventAlertSeverity
- EventApiAffectedAgent
- EventApiAffectedTest
- EventDetail
- EventDetailBase
- EventState
- EventTestLinks
- EventType
- Events
- GatewayEventDetail
- GatewayEventGrouping
- Link
- NameServerEventDetail
- NameServerEventGrouping
- NetworkEventDetail
- NetworkEventGrouping
- NetworkPopEventDetail
- PaginationNextAndSelfLinks
- ProxyEventDetail
- ProxyEventGrouping
- SelfLinks
- SimpleEventDetail
- TargetEventDetail
- TargetEventGrouping
- TargetNetworkEventDetail
- TargetNetworkEventGrouping
- TestType
- UnauthorizedError
- ValidationError
- ValidationErrorItem
- VpnEventDetail
- VpnEventGrouping
- WirelessEventDetail
- WirelessEventGrouping
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
1 maintainer
Metadata
1 maintainer
Release files for thousandeyes-sdk-event-detection 6.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| thousandeyes_sdk_event_detection-6.0.0.tar.gz | 54.8 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| thousandeyes_sdk_event_detection-6.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 209.6 kB
Release files / thousandeyes_sdk_event_detection-6.0.0.tar.gz
| Download URL | thousandeyes_sdk_event_detection-6.0.0.tar.gz |
|---|---|
| Size | 54.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b20dc1df3fd71ce4e9775e4f4e246e12bee5298370bb70d627b6ef2de813920a
|
|
BLAKE2b-256 checksum How to use checksums |
3cd4e657474b7b6c61de876382bca8e57c6d82d093ccdf04f2b3418abd63c828
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / thousandeyes_sdk_event_detection-6.0.0-py3-none-any.whl
| Download URL | thousandeyes_sdk_event_detection-6.0.0-py3-none-any.whl |
|---|---|
| Size | 154.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
275188f414663765e491792870998945851cc5b190248e0ebc2fdd0f09651976
|
|
BLAKE2b-256 checksum How to use checksums |
08ad71271ffa2ddda5ddbc6ec4902409a82b31422a8826196eeaca3d382a5077
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logSecurity for thousandeyes-sdk-event-detection 6.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for thousandeyes_sdk_event_detection-6.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
