Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "group_states" "alert"
CkJsonObject_UpdateString $queryParams "name" "tempor Ut sed velit"
CkJsonObject_UpdateString $queryParams "tags" "host:host0"
CkJsonObject_UpdateString $queryParams "monitor_tags" "service:my-app"
CkJsonObject_UpdateString $queryParams "with_downtimes" "true"
CkJsonObject_UpdateInt $queryParams "id_offset" -62147425
CkJsonObject_UpdateInt $queryParams "page" 0
CkJsonObject_UpdateInt $queryParams "page_size" 20
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v1/monitor" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jarrResp [new_CkJsonArray]
CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0
puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# [
# {
# "type": "query alert",
# "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
# "created": "1977-10-10T13:08:01.527Z",
# "creator": {
# "email": "eiusmod aliquip pariatur dolore",
# "handle": "fugiat id sint",
# "name": "elit in"
# },
# "deleted": "2015-07-16T18:46:50.390Z",
# "id": 83649643,
# "matching_downtimes": [
# {
# "id": 1625,
# "end": 1412792983,
# "scope": [
# "env:staging"
# ],
# "start": 1412792983
# },
# {
# "id": 1625,
# "end": 1412792983,
# "scope": [
# "env:staging"
# ],
# "start": 1412792983
# }
# ],
# "message": "adi",
# "modified": "1973-08-05T09:10:13.718Z",
# "multi": false,
# "name": "My monitor",
# "options": {
# "aggregation": {
# "group_by": "host",
# "metric": "metrics.name",
# "type": "count"
# },
# "device_ids": [
# "firefox.tablet",
# "mobile_small"
# ],
# "enable_logs_sample": true,
# "enable_samples": true,
# "escalation_message": "none",
# "evaluation_delay": 27121357,
# "group_retention_duration": "esse aliquip ullamco irure",
# "groupby_simple_monitor": true,
# "include_tags": true,
# "locked": false,
# "min_failure_duration": 0,
# "min_location_failed": 1,
# "new_group_delay": -9275927,
# "new_host_delay": 300,
# "no_data_timeframe": 58492166,
# "notification_preset_name": "show_all",
# "notify_audit": false,
# "notify_by": [
# "ut quis e",
# "dolore elit"
# ],
# "notify_no_data": false,
# "on_missing_data": "show_no_data",
# "renotify_interval": null,
# "renotify_occurrences": -27638100,
# "renotify_statuses": [
# "alert",
# "warn"
# ],
# "require_full_window": true,
# "scheduling_options": {
# "evaluation_window": {
# "day_starts": "04:00",
# "hour_starts": 0,
# "month_starts": 1
# }
# },
# "silenced": {
# "Ut_d_e": 94650378
# },
# "synthetics_check_id": "enim et tempor",
# "threshold_windows": {
# "recovery_window": "ipsum eiusmod",
# "trigger_window": "ullamco"
# },
# "thresholds": {
# "critical": -74585739.55469063,
# "critical_recovery": -14449679.792215124,
# "ok": 69468073.65422091,
# "unknown": -35840527.53565459,
# "warning": -78191860.79094723,
# "warning_recovery": 30967604.742167816
# },
# "timeout_h": null,
# "variables": [
# {
# "data_source": "rum",
# "compute": {
# "aggregation": "avg",
# "interval": 60000,
# "metric": "@duration"
# },
# "name": "query_errors",
# "group_by": [
# {
# "facet": "status",
# "limit": 10,
# "sort": {
# "aggregation": "avg",
# "metric": "qui Ut cupidatat proid",
# "order": "desc"
# }
# },
# {
# "facet": "status",
# "limit": 10,
# "sort": {
# "aggregation": "avg",
# "metric": "nostrud mollit",
# "order": "desc"
# }
# }
# ],
# "indexes": [
# "days-3",
# "days-7"
# ],
# "search": {
# "query": "service:query"
# }
# },
# {
# "data_source": "rum",
# "compute": {
# "aggregation": "avg",
# "interval": 60000,
# "metric": "@duration"
# },
# "name": "query_errors",
# "group_by": [
# {
# "facet": "status",
# "limit": 10,
# "sort": {
# "aggregation": "avg",
# "metric": "ut non",
# "order": "desc"
# }
# },
# {
# "facet": "status",
# "limit": 10,
# "sort": {
# "aggregation": "avg",
# "metric": "reprehenderit sint eu proident",
# "order": "desc"
# }
# }
# ],
# "indexes": [
# "days-3",
# "days-7"
# ],
# "search": {
# "query": "service:query"
# }
# }
# ]
# },
# "overall_state": "Unknown",
# "priority": 4,
# "restricted_roles": [
# "Ut",
# "dolor ad Duis proident"
# ],
# "state": {
# "groups": {
# "ullamco2": {
# "last_nodata_ts": -30657062,
# "last_notified_ts": -69789968,
# "last_resolved_ts": -40935564,
# "last_triggered_ts": 63742261,
# "name": "id",
# "status": "Alert"
# },
# "voluptate_0c": {
# "last_nodata_ts": 13097104,
# "last_notified_ts": 53104444,
# "last_resolved_ts": -69320667,
# "last_triggered_ts": 27152807,
# "name": "quis amet",
# "status": "Alert"
# }
# }
# },
# "tags": [
# "fugiat culpa aliqua consectetur",
# "minim in"
# ]
# },
# {
# "type": "query alert",
# "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
# "created": "1952-04-01T14:02:58.093Z",
# "creator": {
# "email": "esse ad veniam qui",
# "handle": "nulla enim non",
# "name": "ut reprehend"
# },
# "deleted": "2005-07-24T20:18:36.078Z",
# "id": 14961847,
# "matching_downtimes": [
# {
# "id": 1625,
# "end": 1412792983,
# "scope": [
# "env:staging"
# ],
# "start": 1412792983
# },
# {
# "id": 1625,
# "end": 1412792983,
# "scope": [
# "env:staging"
# ],
# "start": 1412792983
# }
# ],
# "message": "labore nulla",
# "modified": "2013-05-28T22:30:26.014Z",
# "multi": true,
# "name": "My monitor",
# "options": {
# "aggregation": {
# "group_by": "host",
# "metric": "metrics.name",
# "type": "count"
# },
# "device_ids": [
# "chrome.tablet",
# "firefox.laptop_large"
# ],
# "enable_logs_sample": false,
# "enable_samples": true,
# "escalation_message": "none",
# "evaluation_delay": 48023490,
# "group_retention_duration": "veniam eiusmod anim",
# "groupby_simple_monitor": true,
# "include_tags": true,
# "locked": false,
# "min_failure_duration": 0,
# "min_location_failed": 1,
# "new_group_delay": -78698406,
# "new_host_delay": 300,
# "no_data_timeframe": -29298203,
# "notification_preset_name": "show_all",
# "notify_audit": false,
# "notify_by": [
# "in labore irure reprehenderit",
# "Ut ea"
# ],
# "notify_no_data": false,
# "on_missing_data": "default",
# "renotify_interval": null,
# "renotify_occurrences": 88843653,
# "renotify_statuses": [
# "warn",
# "no data"
# ],
# "require_full_window": false,
# "scheduling_options": {
# "evaluation_window": {
# "day_starts": "04:00",
# "hour_starts": 0,
# "month_starts": 1
# }
# },
# "silenced": {
# "ut_8": -75892703
# },
# "synthetics_check_id": "ut et aute cupidatat",
# "threshold_windows": {
# "recovery_window": "dolor do",
# "trigger_window": "pariatur"
# },
# "thresholds": {
# "critical": -5336230.352944598,
# "critical_recovery": 7945004.71738635,
# "ok": -68115416.21610427,
# "unknown": 89541673.34797806,
# "warning": 66901483.96194494,
# "warning_recovery": -39599171.26178945
# },
# "timeout_h": null,
# "variables": [
# {
# "data_source": "rum",
# "compute": {
# "aggregation": "avg",
# "interval": 60000,
# "metric": "@duration"
# },
# "name": "query_errors",
# "group_by": [
# {
# "facet": "status",
# "limit": 10,
# "sort": {
# "aggregation": "avg",
# "metric": "deserunt nisi mollit",
# "order": "desc"
# }
# },
# {
# "facet": "status",
# "limit": 10,
# "sort": {
# "aggregation": "avg",
# "metric": "dolor pariatur",
# "order": "desc"
# }
# }
# ],
# "indexes": [
# "days-3",
# "days-7"
# ],
# "search": {
# "query": "service:query"
# }
# },
# {
# "data_source": "rum",
# "compute": {
# "aggregation": "avg",
# "interval": 60000,
# "metric": "@duration"
# },
# "name": "query_errors",
# "group_by": [
# {
# "facet": "status",
# "limit": 10,
# "sort": {
# "aggregation": "avg",
# "metric": "l",
# "order": "desc"
# }
# },
# {
# "facet": "status",
# "limit": 10,
# "sort": {
# "aggregation": "avg",
# "metric": "ut non",
# "order": "desc"
# }
# }
# ],
# "indexes": [
# "days-3",
# "days-7"
# ],
# "search": {
# "query": "service:query"
# }
# }
# ]
# },
# "overall_state": "Unknown",
# "priority": 3,
# "restricted_roles": [
# "ipsum laboris laborum incididunt",
# "fugiat non est"
# ],
# "state": {
# "groups": {
# "Ut7": {
# "last_nodata_ts": 21127128,
# "last_notified_ts": 19208840,
# "last_resolved_ts": 29022384,
# "last_triggered_ts": -96682791,
# "name": "ex tempor",
# "status": "OK"
# }
# }
# },
# "tags": [
# "dolor nulla dolore elit",
# "consequat sunt in"
# ]
# }
# ]
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
# json is a CkJsonObject
set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
set json [CkJsonArray_ObjectAt $jarrResp $i]
set v_type [CkJsonObject_stringOf $json "type"]
set query [CkJsonObject_stringOf $json "query"]
set created [CkJsonObject_stringOf $json "created"]
set v_Email [CkJsonObject_stringOf $json "creator.email"]
set Handle [CkJsonObject_stringOf $json "creator.handle"]
set Name [CkJsonObject_stringOf $json "creator.name"]
set deleted [CkJsonObject_stringOf $json "deleted"]
set id [CkJsonObject_IntOf $json "id"]
set message [CkJsonObject_stringOf $json "message"]
set modified [CkJsonObject_stringOf $json "modified"]
set multi [CkJsonObject_BoolOf $json "multi"]
set name [CkJsonObject_stringOf $json "name"]
set Group_by [CkJsonObject_stringOf $json "options.aggregation.group_by"]
set Metric [CkJsonObject_stringOf $json "options.aggregation.metric"]
set v_Type [CkJsonObject_stringOf $json "options.aggregation.type"]
set Enable_logs_sample [CkJsonObject_BoolOf $json "options.enable_logs_sample"]
set Enable_samples [CkJsonObject_BoolOf $json "options.enable_samples"]
set Escalation_message [CkJsonObject_stringOf $json "options.escalation_message"]
set Evaluation_delay [CkJsonObject_IntOf $json "options.evaluation_delay"]
set Group_retention_duration [CkJsonObject_stringOf $json "options.group_retention_duration"]
set Groupby_simple_monitor [CkJsonObject_BoolOf $json "options.groupby_simple_monitor"]
set Include_tags [CkJsonObject_BoolOf $json "options.include_tags"]
set Locked [CkJsonObject_BoolOf $json "options.locked"]
set Min_failure_duration [CkJsonObject_IntOf $json "options.min_failure_duration"]
set Min_location_failed [CkJsonObject_IntOf $json "options.min_location_failed"]
set New_group_delay [CkJsonObject_IntOf $json "options.new_group_delay"]
set New_host_delay [CkJsonObject_IntOf $json "options.new_host_delay"]
set No_data_timeframe [CkJsonObject_IntOf $json "options.no_data_timeframe"]
set Notification_preset_name [CkJsonObject_stringOf $json "options.notification_preset_name"]
set Notify_audit [CkJsonObject_BoolOf $json "options.notify_audit"]
set Notify_no_data [CkJsonObject_BoolOf $json "options.notify_no_data"]
set On_missing_data [CkJsonObject_stringOf $json "options.on_missing_data"]
set Renotify_interval [CkJsonObject_stringOf $json "options.renotify_interval"]
set Renotify_occurrences [CkJsonObject_IntOf $json "options.renotify_occurrences"]
set Require_full_window [CkJsonObject_BoolOf $json "options.require_full_window"]
set Day_starts [CkJsonObject_stringOf $json "options.scheduling_options.evaluation_window.day_starts"]
set Hour_starts [CkJsonObject_IntOf $json "options.scheduling_options.evaluation_window.hour_starts"]
set Month_starts [CkJsonObject_IntOf $json "options.scheduling_options.evaluation_window.month_starts"]
set Ut_d_e [CkJsonObject_IntOf $json "options.silenced.Ut_d_e"]
set Synthetics_check_id [CkJsonObject_stringOf $json "options.synthetics_check_id"]
set Recovery_window [CkJsonObject_stringOf $json "options.threshold_windows.recovery_window"]
set Trigger_window [CkJsonObject_stringOf $json "options.threshold_windows.trigger_window"]
set Critical [CkJsonObject_stringOf $json "options.thresholds.critical"]
set Critical_recovery [CkJsonObject_stringOf $json "options.thresholds.critical_recovery"]
set Ok [CkJsonObject_stringOf $json "options.thresholds.ok"]
set Unknown [CkJsonObject_stringOf $json "options.thresholds.unknown"]
set Warning [CkJsonObject_stringOf $json "options.thresholds.warning"]
set Warning_recovery [CkJsonObject_stringOf $json "options.thresholds.warning_recovery"]
set Timeout_h [CkJsonObject_stringOf $json "options.timeout_h"]
set overall_state [CkJsonObject_stringOf $json "overall_state"]
set priority [CkJsonObject_IntOf $json "priority"]
set Last_nodata_ts [CkJsonObject_IntOf $json "state.groups.ullamco2.last_nodata_ts"]
set Last_notified_ts [CkJsonObject_IntOf $json "state.groups.ullamco2.last_notified_ts"]
set Last_resolved_ts [CkJsonObject_IntOf $json "state.groups.ullamco2.last_resolved_ts"]
set Last_triggered_ts [CkJsonObject_IntOf $json "state.groups.ullamco2.last_triggered_ts"]
set Ullamco2Name [CkJsonObject_stringOf $json "state.groups.ullamco2.name"]
set Status [CkJsonObject_stringOf $json "state.groups.ullamco2.status"]
set Voluptate_0cLast_nodata_ts [CkJsonObject_IntOf $json "state.groups.voluptate_0c.last_nodata_ts"]
set Voluptate_0cLast_notified_ts [CkJsonObject_IntOf $json "state.groups.voluptate_0c.last_notified_ts"]
set Voluptate_0cLast_resolved_ts [CkJsonObject_IntOf $json "state.groups.voluptate_0c.last_resolved_ts"]
set Voluptate_0cLast_triggered_ts [CkJsonObject_IntOf $json "state.groups.voluptate_0c.last_triggered_ts"]
set Voluptate_0cName [CkJsonObject_stringOf $json "state.groups.voluptate_0c.name"]
set Voluptate_0cStatus [CkJsonObject_stringOf $json "state.groups.voluptate_0c.status"]
set Ut_8 [CkJsonObject_IntOf $json "options.silenced.ut_8"]
set Ut7Last_nodata_ts [CkJsonObject_IntOf $json "state.groups.Ut7.last_nodata_ts"]
set Ut7Last_notified_ts [CkJsonObject_IntOf $json "state.groups.Ut7.last_notified_ts"]
set Ut7Last_resolved_ts [CkJsonObject_IntOf $json "state.groups.Ut7.last_resolved_ts"]
set Ut7Last_triggered_ts [CkJsonObject_IntOf $json "state.groups.Ut7.last_triggered_ts"]
set Ut7Name [CkJsonObject_stringOf $json "state.groups.Ut7.name"]
set Ut7Status [CkJsonObject_stringOf $json "state.groups.Ut7.status"]
set j 0
set count_j [CkJsonObject_SizeOfArray $json "matching_downtimes"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set id [CkJsonObject_IntOf $json "matching_downtimes[j].id"]
set v_end [CkJsonObject_IntOf $json "matching_downtimes[j].end"]
set start [CkJsonObject_IntOf $json "matching_downtimes[j].start"]
set k 0
set count_k [CkJsonObject_SizeOfArray $json "matching_downtimes[j].scope"]
while {$k < $count_k} {
CkJsonObject_put_K $json $k
set strVal [CkJsonObject_stringOf $json "matching_downtimes[j].scope[k]"]
set k [expr $k + 1]
}
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $json "options.device_ids"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set strVal [CkJsonObject_stringOf $json "options.device_ids[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $json "options.notify_by"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set strVal [CkJsonObject_stringOf $json "options.notify_by[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $json "options.renotify_statuses"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set strVal [CkJsonObject_stringOf $json "options.renotify_statuses[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $json "options.variables"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set data_source [CkJsonObject_stringOf $json "options.variables[j].data_source"]
set Aggregation [CkJsonObject_stringOf $json "options.variables[j].compute.aggregation"]
set Interval [CkJsonObject_IntOf $json "options.variables[j].compute.interval"]
set computeMetric [CkJsonObject_stringOf $json "options.variables[j].compute.metric"]
set name [CkJsonObject_stringOf $json "options.variables[j].name"]
set Query [CkJsonObject_stringOf $json "options.variables[j].search.query"]
set k 0
set count_k [CkJsonObject_SizeOfArray $json "options.variables[j].group_by"]
while {$k < $count_k} {
CkJsonObject_put_K $json $k
set facet [CkJsonObject_stringOf $json "options.variables[j].group_by[k].facet"]
set limit [CkJsonObject_IntOf $json "options.variables[j].group_by[k].limit"]
set sortAggregation [CkJsonObject_stringOf $json "options.variables[j].group_by[k].sort.aggregation"]
set sortMetric [CkJsonObject_stringOf $json "options.variables[j].group_by[k].sort.metric"]
set Order [CkJsonObject_stringOf $json "options.variables[j].group_by[k].sort.order"]
set k [expr $k + 1]
}
set k 0
set count_k [CkJsonObject_SizeOfArray $json "options.variables[j].indexes"]
while {$k < $count_k} {
CkJsonObject_put_K $json $k
set strVal [CkJsonObject_stringOf $json "options.variables[j].indexes[k]"]
set k [expr $k + 1]
}
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $json "restricted_roles"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set strVal [CkJsonObject_stringOf $json "restricted_roles[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $json "tags"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set strVal [CkJsonObject_stringOf $json "tags[j]"]
set j [expr $j + 1]
}
delete_CkJsonObject $json
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
Curl Command
curl -G -d "group_states=alert"
-d "name=tempor%20Ut%20sed%20velit"
-d "tags=host%3Ahost0"
-d "monitor_tags=service%3Amy-app"
-d "with_downtimes=true"
-d "id_offset=-62147425"
-d "page=0"
-d "page_size=20"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/monitor
Postman Collection Item JSON
{
"name": "Get all monitor details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=tempor Ut sed velit&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=-62147425&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "tempor Ut sed velit",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "-62147425",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
},
"description": "Get details about the specified monitor from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=tempor Ut sed velit&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=-62147425&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "tempor Ut sed velit",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "-62147425",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n {\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"1977-10-10T13:08:01.527Z\",\n \"creator\": {\n \"email\": \"eiusmod aliquip pariatur dolore\",\n \"handle\": \"fugiat id sint\",\n \"name\": \"elit in\"\n },\n \"deleted\": \"2015-07-16T18:46:50.390Z\",\n \"id\": 83649643,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"adi\",\n \"modified\": \"1973-08-05T09:10:13.718Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"device_ids\": [\n \"firefox.tablet\",\n \"mobile_small\"\n ],\n \"enable_logs_sample\": true,\n \"enable_samples\": true,\n \"escalation_message\": \"none\",\n \"evaluation_delay\": 27121357,\n \"group_retention_duration\": \"esse aliquip ullamco irure\",\n \"groupby_simple_monitor\": true,\n \"include_tags\": true,\n \"locked\": false,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": -9275927,\n \"new_host_delay\": 300,\n \"no_data_timeframe\": 58492166,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"ut quis e\",\n \"dolore elit\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -27638100,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1\n }\n },\n \"silenced\": {\n \"Ut_d_e\": 94650378\n },\n \"synthetics_check_id\": \"enim et tempor\",\n \"threshold_windows\": {\n \"recovery_window\": \"ipsum eiusmod\",\n \"trigger_window\": \"ullamco\"\n },\n \"thresholds\": {\n \"critical\": -74585739.55469063,\n \"critical_recovery\": -14449679.792215124,\n \"ok\": 69468073.65422091,\n \"unknown\": -35840527.53565459,\n \"warning\": -78191860.79094723,\n \"warning_recovery\": 30967604.742167816\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"qui Ut cupidatat proid\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"nostrud mollit\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"ut non\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"reprehenderit sint eu proident\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Unknown\",\n \"priority\": 4,\n \"restricted_roles\": [\n \"Ut\",\n \"dolor ad Duis proident\"\n ],\n \"state\": {\n \"groups\": {\n \"ullamco2\": {\n \"last_nodata_ts\": -30657062,\n \"last_notified_ts\": -69789968,\n \"last_resolved_ts\": -40935564,\n \"last_triggered_ts\": 63742261,\n \"name\": \"id\",\n \"status\": \"Alert\"\n },\n \"voluptate_0c\": {\n \"last_nodata_ts\": 13097104,\n \"last_notified_ts\": 53104444,\n \"last_resolved_ts\": -69320667,\n \"last_triggered_ts\": 27152807,\n \"name\": \"quis amet\",\n \"status\": \"Alert\"\n }\n }\n },\n \"tags\": [\n \"fugiat culpa aliqua consectetur\",\n \"minim in\"\n ]\n },\n {\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"1952-04-01T14:02:58.093Z\",\n \"creator\": {\n \"email\": \"esse ad veniam qui\",\n \"handle\": \"nulla enim non\",\n \"name\": \"ut reprehend\"\n },\n \"deleted\": \"2005-07-24T20:18:36.078Z\",\n \"id\": 14961847,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"labore nulla\",\n \"modified\": \"2013-05-28T22:30:26.014Z\",\n \"multi\": true,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"device_ids\": [\n \"chrome.tablet\",\n \"firefox.laptop_large\"\n ],\n \"enable_logs_sample\": false,\n \"enable_samples\": true,\n \"escalation_message\": \"none\",\n \"evaluation_delay\": 48023490,\n \"group_retention_duration\": \"veniam eiusmod anim\",\n \"groupby_simple_monitor\": true,\n \"include_tags\": true,\n \"locked\": false,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": -78698406,\n \"new_host_delay\": 300,\n \"no_data_timeframe\": -29298203,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"in labore irure reprehenderit\",\n \"Ut ea\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"default\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": 88843653,\n \"renotify_statuses\": [\n \"warn\",\n \"no data\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1\n }\n },\n \"silenced\": {\n \"ut_8\": -75892703\n },\n \"synthetics_check_id\": \"ut et aute cupidatat\",\n \"threshold_windows\": {\n \"recovery_window\": \"dolor do\",\n \"trigger_window\": \"pariatur\"\n },\n \"thresholds\": {\n \"critical\": -5336230.352944598,\n \"critical_recovery\": 7945004.71738635,\n \"ok\": -68115416.21610427,\n \"unknown\": 89541673.34797806,\n \"warning\": 66901483.96194494,\n \"warning_recovery\": -39599171.26178945\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"deserunt nisi mollit\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor pariatur\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"l\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"ut non\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Unknown\",\n \"priority\": 3,\n \"restricted_roles\": [\n \"ipsum laboris laborum incididunt\",\n \"fugiat non est\"\n ],\n \"state\": {\n \"groups\": {\n \"Ut7\": {\n \"last_nodata_ts\": 21127128,\n \"last_notified_ts\": 19208840,\n \"last_resolved_ts\": 29022384,\n \"last_triggered_ts\": -96682791,\n \"name\": \"ex tempor\",\n \"status\": \"OK\"\n }\n }\n },\n \"tags\": [\n \"dolor nulla dolore elit\",\n \"consequat sunt in\"\n ]\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=tempor Ut sed velit&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=-62147425&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "tempor Ut sed velit",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "-62147425",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=tempor Ut sed velit&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=-62147425&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "tempor Ut sed velit",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "-62147425",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=tempor Ut sed velit&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=-62147425&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "tempor Ut sed velit",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "-62147425",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
