AgentLocalEventDetail - ThousandEyes API v7

{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/0e1b2b85-7871-3637-a9de-ff5d8b677c7e","info":{"description":"\nEvent 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.\n* To determine this, ThousandEyes takes the test results from all accounts groups within an organization, and analyzes that data.\n* 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).\n* 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.\n* 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).\n\nWith the Events API, you can perform the following tasks on the ThousandEyes platform:\n* **Retrieve Events**: Obtain a list of events and detailed information for each event. For more information about events, see [Event Detection](https://docs.thousandeyes.com/product-documentation/event-detection).\n","title":"Event Detection API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"name":"Events"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"description":"Bearer authentication token","scheme":"bearer","type":"http"}}},"spec":{"properties":{"id":{"description":"A unique ID for each event.","example":"e9c3bf02-a48c-4aa8-9e5f-898800d6f569","format":"uuid","readOnly":true,"type":"string"},"typeName":{"description":"Event type name. Examples include, Local Agent Issue, Network Path Issue, Network Outage, DNS Issue, Server Issue, and Proxy Issue.","example":"Network Issue","readOnly":true,"type":"string"},"state":{"description":"Indicates the state of the event, whether it is ongoing (active) or has been resolved.","enum":["active","resolved"],"example":"resolved","readOnly":true,"type":"string","$$ref":"#/components/schemas/EventState"},"startDate":{"description":"The start date and time (in UTC, ISO 8601 format) when the event was first detected.","example":"2020-04-23T13:43:16Z","format":"date-time","readOnly":true,"type":"string"},"endDate":{"description":"The end date and time (in UTC, ISO 8601 format) when the event was resolved (due to timeout). This value is populated for \"ongoing\" events.","example":"2020-04-23T13:43:16Z","format":"date-time","readOnly":true,"type":"string"},"severity":{"description":"The severity of the alert.","enum":["high","medium","low"],"example":"medium","type":"string","$$ref":"#/components/schemas/EventAlertSeverity"},"aid":{"description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","type":"string","$$ref":"#/components/schemas/AccountGroupId"},"summary":{"description":"A brief summary describing the cause of the event.","example":"Significant number of issues detected with 66.29.146.15","readOnly":true,"type":"string"},"affectedTests":{"properties":{"total":{"description":"The total number affected.","example":5,"readOnly":true,"type":"integer"},"inAccountGroup":{"description":"Indicates if in the affected account group.","example":2,"readOnly":true,"type":"integer"},"tests":{"description":"List of affected tests.","items":{"properties":{"testId":{"description":"The ID of the affected test.","example":"226770","readOnly":true,"type":"string"},"testType":{"description":"This is a read only value, as test type is implicit in the test creation url.","enum":["api","agent-to-agent","agent-to-server","bgp","http-server","page-load","web-transactions","ftp-server","dns-trace","dns-server","dnssec","sip-server","voice"],"example":"agent-to-server","readOnly":true,"type":"string","$$ref":"#/components/schemas/TestType"},"name":{"description":"The test name as configured in the test settings.","example":"Google test","readOnly":true,"type":"string"},"affectedTargetIds":{"description":"An array of unique target IDs contributed data points which generated the signal for the event.","example":["123","1234"],"items":{"type":"string"},"type":"array"},"affectedAgentIds":{"description":"An array of unique agent IDs that contributed data points which generated the signal for the event.","example":["2954","2953"],"items":{"type":"string"},"type":"array"},"_links":{"description":"A links object containing the self link.","properties":{"test":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/EventTestLinks"}},"type":"object","$$ref":"#/components/schemas/EventApiAffectedTest"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/AffectedTests"},"affectedTargets":{"properties":{"total":{"description":"The total number affected.","example":5,"readOnly":true,"type":"integer"},"inAccountGroup":{"description":"Indicates if in the affected account group.","example":2,"readOnly":true,"type":"integer"},"targets":{"description":"List of affected targets.","items":{"properties":{"serverId":{"description":"The ID of the target server.","example":"123","readOnly":true,"type":"string"},"name":{"description":"The target name as configured in the test settings.","example":"google.com","readOnly":true,"type":"string"},"ip":{"description":"The target server IP resolved by the agent. Depending on the failure type, the IP may not be present. For example, if the agent failed to resolve it or if the requests were routed through the proxy.","example":"216.239.32.10","readOnly":true,"type":"string"},"affectedTestIds":{"description":"An array of unique test IDs that contributed data points which generated the signal for the event.","example":["123","1234"],"items":{"type":"string"},"type":"array"},"affectedAgentIds":{"description":"An array of unique agent IDs that contributed data points which generated the signal for the event.","example":["2954","2953"],"items":{"type":"string"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiAffectedTarget"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/AffectedTargets"},"affectedAgents":{"properties":{"total":{"description":"The total number affected.","example":5,"readOnly":true,"type":"integer"},"inAccountGroup":{"description":"Indicates if in the affected account group.","example":2,"readOnly":true,"type":"integer"},"agents":{"description":"List of affected agents.","items":{"properties":{"agentId":{"description":"The ID of the virtual agent.","example":"2954","readOnly":true,"type":"string"},"type":{"description":"Type of the agent.","enum":["cloud","enterprise-cluster","enterprise"],"example":"enterprise-cluster","readOnly":true,"type":"string","$$ref":"#/components/schemas/CloudEnterpriseAgentType"},"name":{"description":"The name of the agent as defined in settings.","example":"São Paulo, Brazil - agent","readOnly":true,"type":"string"},"location":{"description":"The name of the agent's location.","example":"São Paulo, Brazil","readOnly":true,"type":"string"},"countryCode":{"description":"The country code of the agent's location .","example":"BR","readOnly":true,"type":"string"},"affectedTargetIds":{"description":"An array of unique target IDs that contributed data points which generated the signal for the event.","example":["123","1234"],"items":{"type":"string"},"type":"array"},"affectedTestIds":{"description":"An array of unique agent IDs that contributed data points which generated the signal for the event.","example":["2954","2953"],"items":{"type":"string"},"type":"array"},"_links":{"description":"A links object containing the agent link.","properties":{"agent":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/AgentLinks"}},"type":"object","$$ref":"#/components/schemas/EventApiAffectedAgent"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/AffectedAgents"},"cause":{"description":"The cause of the error.","example":["Network Loss and/or High RTT"],"items":{"type":"string"},"type":"array","uniqueItems":true,"$$ref":"#/components/schemas/Cause"},"_links":{"description":"A links object containing the self link.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/SelfLinks"},"type":{"description":"Agent local event type.","example":"agent-local","pattern":"^agent-local$","type":"string","$$ref":"#/components/schemas/AgentLocalEventType"},"grouping":{"properties":{"agentId":{"description":"Numeric Agent ID (for agent-local events).","example":"123456","readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/AgentLocalEventGrouping"}},"type":"object","$$ref":"#/components/schemas/AgentLocalEventDetail","required":["type"],"title":"AgentLocalEventDetail"}}