Qodex.ai

List active alerts

GET {{baseUrl}}/alerts?aid=1234&window=12h&startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&max=5&state=active

Returns a list of active alerts. If no alerts are active within the specified time range, an empty response is returned. Note that time filters (window, startDate, or endDate) are only applied to cleared alerts.

Request Params

KeyDatatypeRequiredDescription
aidnumberA 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.
windowstringA dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: s for seconds (default if no type is specified), m for minutes, h for hours, d for days, and w for weeks.
For a precise date range, use startDate and endDate.
startDatestringUse with the endDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window.
endDatestringDefaults to current time the request is made. Use with the startDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window.
maxnumber(Optional) Maximum number of objects to return.
statestringOptional parameter to match a specific alert state. If not specified, it defaults to trigger.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"alerts":[{"id":"e9c3bf02-a48c-4aa8-9e5f-898800d6f569","alertType":"http-server","startDate":"2022-07-17T22:00:54Z","endDate":"2022-07-18T22:00:54Z","violationCount":2,"duration":60,"suppressed":false,"meta":{"version":1},"_links":{"test":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"aliquip sunt et nulla","deprecation":"occaeca","name":"aliqua est quis eu ad","profile":"Lorem cupidatat anim officia","title":"sunt sed voluptate magna","hreflang":"eiusmod eni"},"rule":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"ut nisi dolore","deprecation":"irure","name":"aute nulla occaecat culpa","profile":"elit proident","title":"elit proiden","hreflang":"Ut reprehenderit cillum enim occaecat"},"appLink":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"amet et non","deprecation":"id amet sit irure","name":"nisi ad Excepteur","profile":"occaecat quis et","title":"id nulla ullamco","hreflang":"veniam"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"ad dolor ex laborum laboris","deprecation":"veniam quis sed","name":"in in cillum magna","profile":"mollit dolore pariatur","title":"dolor n","hreflang":"consequat laborum"}},"alertId":"e9c3bf02-a48c-4aa8-9e5f-898800d6f569","dateStart":"2020-04-23 13:43:16","dateEnd":"2020-04-23 13:43:16","ruleId":127094,"state":"ACTIVE","severity":"MAJOR","permalink":"https://app.thousandeyes.com/alerts/list?__a=75\u0026alertId=2783\u0026agentId=12","apiLinks":[{"eiusmod_7ad":83622697.57455835,"nostrud0":true,"ex_a9f":true},{"nisi_d0":false,"Duis2":false}],"alertRuleId":"127094","alertState":"active","alertSeverity":"major"},{"id":"e9c3bf02-a48c-4aa8-9e5f-898800d6f569","alertType":"http-server","startDate":"2022-07-17T22:00:54Z","endDate":"2022-07-18T22:00:54Z","violationCount":2,"duration":60,"suppressed":false,"meta":{"version":1},"_links":{"test":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"tempor laborum","deprecation":"consectetur voluptate ullamco ad","name":"fugiat aliquip","profile":"tempor in sint mi","title":"in ut","hreflang":"deserunt ut ad in"},"rule":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"nisi deserunt consectetur","deprecation":"id deserunt enim cillum Excepteur","name":"sed","profile":"ad reprehenderit labore in","title":"fugiat velit","hreflang":"est Lorem ullamco in"},"appLink":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"","deprecation":"proident ad laborum aliqua mollit","name":"ex Ut quis","profile":"qui voluptate Ut","title":"sunt nostrud","hreflang":"culpa qui"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"do Lorem laborum","deprecation":"ut ad incididunt amet","name":"Ut quis","profile":"magna","title":"officia nulla Ut","hreflang":"dolore sint sunt"}},"alertId":"e9c3bf02-a48c-4aa8-9e5f-898800d6f569","dateStart":"2020-04-23 13:43:16","dateEnd":"2020-04-23 13:43:16","ruleId":127094,"state":"ACTIVE","severity":"MAJOR","permalink":"https://app.thousandeyes.com/alerts/list?__a=75\u0026alertId=2783\u0026agentId=12","apiLinks":[{"in_41_":-62214153.7558508,"laborumc":48633882,"fugiat_26":"aliquip occaecat magna et"},{"elit_b4":81381423}],"alertRuleId":"127094","alertState":"active","alertSeverity":"major"}],"_links":{"previous":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"minim","deprecation":"culpa","name":"Ut est","profile":"quis eiusmod nostrud","title":"reprehenderit consectetur cupidatat proident dolore","hreflang":"sint voluptate exercitation"},"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"labore ut proident dolor qui","deprecation":"veniam sunt nisi","name":"fugiat Duis","profile":"dolor in ipsum sed quis","title":"laboris Duis enim","hreflang":"ut consectetur"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"aute ea in aliqua do","deprecation":"exercitation nostrud dolor Duis","name":"fugiat laboris","profile":"tempor cupidatat in non ad","title":"nisi id","hreflang":"aute qui"}}}