Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnV_end
LOCAL lnStart
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL lcData_source
LOCAL lcAggregation
LOCAL lnInterval
LOCAL lcComputeMetric
LOCAL lcQuery
LOCAL lcFacet
LOCAL lnLimit
LOCAL lcSortAggregation
LOCAL lcSortMetric
LOCAL lcOrder
LOCAL lcV_type
LOCAL lcQuery
LOCAL lcCreated
LOCAL lcV_Email
LOCAL lcHandle
LOCAL lcName
LOCAL lcDeleted
LOCAL lnId
LOCAL lcMessage
LOCAL lcModified
LOCAL lnMulti
LOCAL lcName
LOCAL lcGroup_by
LOCAL lcMetric
LOCAL lcV_Type
LOCAL lnEnable_logs_sample
LOCAL lnEnable_samples
LOCAL lcEscalation_message
LOCAL lnEvaluation_delay
LOCAL lcGroup_retention_duration
LOCAL lnGroupby_simple_monitor
LOCAL lnInclude_tags
LOCAL lnLocked
LOCAL lnMin_failure_duration
LOCAL lnMin_location_failed
LOCAL lnNew_group_delay
LOCAL lnNew_host_delay
LOCAL lnNo_data_timeframe
LOCAL lcNotification_preset_name
LOCAL lnNotify_audit
LOCAL lnNotify_no_data
LOCAL lcOn_missing_data
LOCAL lcRenotify_interval
LOCAL lnRenotify_occurrences
LOCAL lnRequire_full_window
LOCAL lcDay_starts
LOCAL lnHour_starts
LOCAL lnMonth_starts
LOCAL lnNon_6f_
LOCAL lcSynthetics_check_id
LOCAL lcRecovery_window
LOCAL lcTrigger_window
LOCAL lcCritical
LOCAL lcCritical_recovery
LOCAL lcOk
LOCAL lcUnknown
LOCAL lcWarning
LOCAL lcWarning_recovery
LOCAL lcTimeout_h
LOCAL lcOverall_state
LOCAL lnPriority
LOCAL lnLast_nodata_ts
LOCAL lnLast_notified_ts
LOCAL lnLast_resolved_ts
LOCAL lnLast_triggered_ts
LOCAL lcLorem_1Name
LOCAL lcStatus
LOCAL lnNisi_c43Last_nodata_ts
LOCAL lnNisi_c43Last_notified_ts
LOCAL lnNisi_c43Last_resolved_ts
LOCAL lnNisi_c43Last_triggered_ts
LOCAL lcNisi_c43Name
LOCAL lcNisi_c43Status
LOCAL lnMinim_cLast_nodata_ts
LOCAL lnMinim_cLast_notified_ts
LOCAL lnMinim_cLast_resolved_ts
LOCAL lnMinim_cLast_triggered_ts
LOCAL lcMinim_cName
LOCAL lcMinim_cStatus
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Use this online tool to generate code from sample JSON: Generate Code to Create JSON
* The following JSON is sent in the request body.
* {
* "message": "You may need to add web hosts if this is consistently high.",
* "name": "Bytes received on host0",
* "options": {
* "no_data_timeframe": 20,
* "notify_no_data": true
* },
* "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
* "tags": [
* "app:webserver",
* "frontend"
* ],
* "type": "query alert"
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("message","You may need to add web hosts if this is consistently high.")
loJson.UpdateString("name","Bytes received on host0")
loJson.UpdateInt("options.no_data_timeframe",20)
loJson.UpdateBool("options.notify_no_data",1)
loJson.UpdateString("query","avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100")
loJson.UpdateString("tags[0]","app:webserver")
loJson.UpdateString("tags[1]","frontend")
loJson.UpdateString("type","query alert")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://api.app.ddog-gov.com/api/v1/monitor","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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": "1989-12-01T14:28:43.831Z",
* "creator": {
* "email": "officia sunt",
* "handle": "pariatur",
* "name": "aute do"
* },
* "deleted": "2020-10-30T20:46:24.520Z",
* "id": -50675854,
* "matching_downtimes": [
* {
* "id": 1625,
* "end": 1412792983,
* "scope": [
* "env:staging"
* ],
* "start": 1412792983
* },
* {
* "id": 1625,
* "end": 1412792983,
* "scope": [
* "env:staging"
* ],
* "start": 1412792983
* }
* ],
* "message": "ullamco incididunt cupidatat",
* "modified": "1981-03-27T05:04:03.098Z",
* "multi": false,
* "name": "My monitor",
* "options": {
* "aggregation": {
* "group_by": "host",
* "metric": "metrics.name",
* "type": "count"
* },
* "device_ids": [
* "mobile_small",
* "chrome.tablet"
* ],
* "enable_logs_sample": false,
* "enable_samples": false,
* "escalation_message": "none",
* "evaluation_delay": -52819274,
* "group_retention_duration": "dolor Lorem qui",
* "groupby_simple_monitor": false,
* "include_tags": true,
* "locked": false,
* "min_failure_duration": 0,
* "min_location_failed": 1,
* "new_group_delay": -94315945,
* "new_host_delay": 300,
* "no_data_timeframe": -86360342,
* "notification_preset_name": "show_all",
* "notify_audit": false,
* "notify_by": [
* "labore dolore",
* "deserunt commodo consectetur"
* ],
* "notify_no_data": false,
* "on_missing_data": "resolve",
* "renotify_interval": null,
* "renotify_occurrences": 56355858,
* "renotify_statuses": [
* "warn",
* "no data"
* ],
* "require_full_window": false,
* "scheduling_options": {
* "evaluation_window": {
* "day_starts": "04:00",
* "hour_starts": 0,
* "month_starts": 1
* }
* },
* "silenced": {
* "non_6f_": 77287100
* },
* "synthetics_check_id": "culpa in laborum irure",
* "threshold_windows": {
* "recovery_window": "culpa cupidatat Lorem ut",
* "trigger_window": "fugiat officia mollit esse quis"
* },
* "thresholds": {
* "critical": -44507487.0891542,
* "critical_recovery": 94365870.17342958,
* "ok": 26645340.31156695,
* "unknown": -32772943.396166816,
* "warning": 75330874.10211122,
* "warning_recovery": 30665996.226613894
* },
* "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": "minim tempor i",
* "order": "desc"
* }
* },
* {
* "facet": "status",
* "limit": 10,
* "sort": {
* "aggregation": "avg",
* "metric": "Ut fugiat officia",
* "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": "do velit",
* "order": "desc"
* }
* },
* {
* "facet": "status",
* "limit": 10,
* "sort": {
* "aggregation": "avg",
* "metric": "amet proident anim in",
* "order": "desc"
* }
* }
* ],
* "indexes": [
* "days-3",
* "days-7"
* ],
* "search": {
* "query": "service:query"
* }
* }
* ]
* },
* "overall_state": "Warn",
* "priority": 1,
* "restricted_roles": [
* "enim qui cillum est",
* "quis ut"
* ],
* "state": {
* "groups": {
* "Lorem_1": {
* "last_nodata_ts": -12653992,
* "last_notified_ts": -66141067,
* "last_resolved_ts": 5643925,
* "last_triggered_ts": -6121593,
* "name": "dolore nulla i",
* "status": "OK"
* },
* "nisi_c43": {
* "last_nodata_ts": -66061060,
* "last_notified_ts": -86988012,
* "last_resolved_ts": -39919633,
* "last_triggered_ts": 13467862,
* "name": "Ut fugiat eiusmod anim",
* "status": "Ignored"
* },
* "minim_c": {
* "last_nodata_ts": 6509669,
* "last_notified_ts": 39348490,
* "last_resolved_ts": 13221088,
* "last_triggered_ts": 21889420,
* "name": "in velit Duis",
* "status": "Alert"
* }
* }
* },
* "tags": [
* "ex tempor",
* "enim veniam dolore"
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcV_type = loJResp.StringOf("type")
lcQuery = loJResp.StringOf("query")
lcCreated = loJResp.StringOf("created")
lcV_Email = loJResp.StringOf("creator.email")
lcHandle = loJResp.StringOf("creator.handle")
lcName = loJResp.StringOf("creator.name")
lcDeleted = loJResp.StringOf("deleted")
lnId = loJResp.IntOf("id")
lcMessage = loJResp.StringOf("message")
lcModified = loJResp.StringOf("modified")
lnMulti = loJResp.BoolOf("multi")
lcName = loJResp.StringOf("name")
lcGroup_by = loJResp.StringOf("options.aggregation.group_by")
lcMetric = loJResp.StringOf("options.aggregation.metric")
lcV_Type = loJResp.StringOf("options.aggregation.type")
lnEnable_logs_sample = loJResp.BoolOf("options.enable_logs_sample")
lnEnable_samples = loJResp.BoolOf("options.enable_samples")
lcEscalation_message = loJResp.StringOf("options.escalation_message")
lnEvaluation_delay = loJResp.IntOf("options.evaluation_delay")
lcGroup_retention_duration = loJResp.StringOf("options.group_retention_duration")
lnGroupby_simple_monitor = loJResp.BoolOf("options.groupby_simple_monitor")
lnInclude_tags = loJResp.BoolOf("options.include_tags")
lnLocked = loJResp.BoolOf("options.locked")
lnMin_failure_duration = loJResp.IntOf("options.min_failure_duration")
lnMin_location_failed = loJResp.IntOf("options.min_location_failed")
lnNew_group_delay = loJResp.IntOf("options.new_group_delay")
lnNew_host_delay = loJResp.IntOf("options.new_host_delay")
lnNo_data_timeframe = loJResp.IntOf("options.no_data_timeframe")
lcNotification_preset_name = loJResp.StringOf("options.notification_preset_name")
lnNotify_audit = loJResp.BoolOf("options.notify_audit")
lnNotify_no_data = loJResp.BoolOf("options.notify_no_data")
lcOn_missing_data = loJResp.StringOf("options.on_missing_data")
lcRenotify_interval = loJResp.StringOf("options.renotify_interval")
lnRenotify_occurrences = loJResp.IntOf("options.renotify_occurrences")
lnRequire_full_window = loJResp.BoolOf("options.require_full_window")
lcDay_starts = loJResp.StringOf("options.scheduling_options.evaluation_window.day_starts")
lnHour_starts = loJResp.IntOf("options.scheduling_options.evaluation_window.hour_starts")
lnMonth_starts = loJResp.IntOf("options.scheduling_options.evaluation_window.month_starts")
lnNon_6f_ = loJResp.IntOf("options.silenced.non_6f_")
lcSynthetics_check_id = loJResp.StringOf("options.synthetics_check_id")
lcRecovery_window = loJResp.StringOf("options.threshold_windows.recovery_window")
lcTrigger_window = loJResp.StringOf("options.threshold_windows.trigger_window")
lcCritical = loJResp.StringOf("options.thresholds.critical")
lcCritical_recovery = loJResp.StringOf("options.thresholds.critical_recovery")
lcOk = loJResp.StringOf("options.thresholds.ok")
lcUnknown = loJResp.StringOf("options.thresholds.unknown")
lcWarning = loJResp.StringOf("options.thresholds.warning")
lcWarning_recovery = loJResp.StringOf("options.thresholds.warning_recovery")
lcTimeout_h = loJResp.StringOf("options.timeout_h")
lcOverall_state = loJResp.StringOf("overall_state")
lnPriority = loJResp.IntOf("priority")
lnLast_nodata_ts = loJResp.IntOf("state.groups.Lorem_1.last_nodata_ts")
lnLast_notified_ts = loJResp.IntOf("state.groups.Lorem_1.last_notified_ts")
lnLast_resolved_ts = loJResp.IntOf("state.groups.Lorem_1.last_resolved_ts")
lnLast_triggered_ts = loJResp.IntOf("state.groups.Lorem_1.last_triggered_ts")
lcLorem_1Name = loJResp.StringOf("state.groups.Lorem_1.name")
lcStatus = loJResp.StringOf("state.groups.Lorem_1.status")
lnNisi_c43Last_nodata_ts = loJResp.IntOf("state.groups.nisi_c43.last_nodata_ts")
lnNisi_c43Last_notified_ts = loJResp.IntOf("state.groups.nisi_c43.last_notified_ts")
lnNisi_c43Last_resolved_ts = loJResp.IntOf("state.groups.nisi_c43.last_resolved_ts")
lnNisi_c43Last_triggered_ts = loJResp.IntOf("state.groups.nisi_c43.last_triggered_ts")
lcNisi_c43Name = loJResp.StringOf("state.groups.nisi_c43.name")
lcNisi_c43Status = loJResp.StringOf("state.groups.nisi_c43.status")
lnMinim_cLast_nodata_ts = loJResp.IntOf("state.groups.minim_c.last_nodata_ts")
lnMinim_cLast_notified_ts = loJResp.IntOf("state.groups.minim_c.last_notified_ts")
lnMinim_cLast_resolved_ts = loJResp.IntOf("state.groups.minim_c.last_resolved_ts")
lnMinim_cLast_triggered_ts = loJResp.IntOf("state.groups.minim_c.last_triggered_ts")
lcMinim_cName = loJResp.StringOf("state.groups.minim_c.name")
lcMinim_cStatus = loJResp.StringOf("state.groups.minim_c.status")
i = 0
lnCount_i = loJResp.SizeOfArray("matching_downtimes")
DO WHILE i < lnCount_i
loJResp.I = i
lnId = loJResp.IntOf("matching_downtimes[i].id")
lnV_end = loJResp.IntOf("matching_downtimes[i].end")
lnStart = loJResp.IntOf("matching_downtimes[i].start")
j = 0
lnCount_j = loJResp.SizeOfArray("matching_downtimes[i].scope")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("matching_downtimes[i].scope[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("options.device_ids")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("options.device_ids[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("options.notify_by")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("options.notify_by[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("options.renotify_statuses")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("options.renotify_statuses[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("options.variables")
DO WHILE i < lnCount_i
loJResp.I = i
lcData_source = loJResp.StringOf("options.variables[i].data_source")
lcAggregation = loJResp.StringOf("options.variables[i].compute.aggregation")
lnInterval = loJResp.IntOf("options.variables[i].compute.interval")
lcComputeMetric = loJResp.StringOf("options.variables[i].compute.metric")
lcName = loJResp.StringOf("options.variables[i].name")
lcQuery = loJResp.StringOf("options.variables[i].search.query")
j = 0
lnCount_j = loJResp.SizeOfArray("options.variables[i].group_by")
DO WHILE j < lnCount_j
loJResp.J = j
lcFacet = loJResp.StringOf("options.variables[i].group_by[j].facet")
lnLimit = loJResp.IntOf("options.variables[i].group_by[j].limit")
lcSortAggregation = loJResp.StringOf("options.variables[i].group_by[j].sort.aggregation")
lcSortMetric = loJResp.StringOf("options.variables[i].group_by[j].sort.metric")
lcOrder = loJResp.StringOf("options.variables[i].group_by[j].sort.order")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("options.variables[i].indexes")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("options.variables[i].indexes[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("restricted_roles")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("restricted_roles[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("tags")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("tags[i]")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"message": "You may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"options": {
"no_data_timeframe": 20,
"notify_no_data": true
},
"query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
"tags": [
"app:webserver",
"frontend"
],
"type": "query alert"
}'
https://api.app.ddog-gov.com/api/v1/monitor
Postman Collection Item JSON
{
"name": "Create a monitor",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
},
"description": "Create a monitor using the specified options.\n\n#### Monitor Types\n\nThe type of monitor chosen from:\n\n- anomaly: `query alert`\n- APM: `query alert` or `trace-analytics alert`\n- composite: `composite`\n- custom: `service check`\n- event: `event alert`\n- forecast: `query alert`\n- host: `service check`\n- integration: `query alert` or `service check`\n- live process: `process alert`\n- logs: `log alert`\n- metric: `query alert`\n- network: `service check`\n- outlier: `query alert`\n- process: `service check`\n- rum: `rum alert`\n- SLO: `slo alert`\n- watchdog: `event alert`\n- event-v2: `event-v2 alert`\n- audit: `audit alert`\n- error-tracking: `error-tracking alert`\n- database-monitoring: `database-monitoring alert`\n\n**Note**: Synthetic monitors are created through the Synthetics API. See the [Synthetics API] (https://docs.datadoghq.com/api/latest/synthetics/) documentation for more information.\n\n#### Query Types\n\n##### Metric Alert Query\n\nExample: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #`\n\n- `time_aggr`: avg, sum, max, min, change, or pct_change\n- `time_window`: `last_#m` (with `#` between 1 and 10080 depending on the monitor type) or `last_#h`(with `#` between 1 and 168 depending on the monitor type) or `last_1d`, or `last_1w`\n- `space_aggr`: avg, sum, min, or max\n- `tags`: one or more tags (comma-separated), or *\n- `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert)\n- `operator`: <, <=, >, >=, ==, or !=\n- `#`: an integer or decimal number used to set the threshold\n\nIf you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window),\ntimeshift):space_aggr:metric{tags} [by {key}] operator #` with:\n\n- `change_aggr` change, pct_change\n- `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions)\n- `time_window` last\\_#m (between 1 and 2880 depending on the monitor type), last\\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2)\n- `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago\n\nUse this to create an outlier monitor using the following query:\n`avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0`\n\n##### Service Check Query\n\nExample: `\"check\".over(tags).last(count).by(group).count_by_status()`\n\n- `check` name of the check, for example `datadog.agent.up`\n- `tags` one or more quoted tags (comma-separated), or \"*\". for example: `.over(\"env:prod\", \"role:db\")`; `over` cannot be blank.\n- `count` must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100.\nFor example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be at least 3.\n- `group` must be specified for check monitors. Per-check grouping is already explicitly known for some service checks.\nFor example, Postgres integration monitors are tagged by `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation for more information.\n\n##### Event Alert Query\n\nExample: `events('sources:nagios status:error,warning priority:normal tags: \"string query\"').rollup(\"count\").last(\"1h\")\"`\n\n- `event`, the event query string:\n- `string_query` free text query to match against event title and text.\n- `sources` event sources (comma-separated).\n- `status` event statuses (comma-separated). Valid options: error, warn, and info.\n- `priority` event priorities (comma-separated). Valid options: low, normal, all.\n- `host` event reporting host (comma-separated).\n- `tags` event tags (comma-separated).\n- `excluded_tags` excluded event tags (comma-separated).\n- `rollup` the stats roll-up method. `count` is the only supported method now.\n- `last` the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours.\n\n**NOTE** The Event Alert Query is being deprecated and replaced by the Event V2 Alert Query. For more information, see the [Event Migration guide](https://docs.datadoghq.com/events/guides/migrating_to_new_events_features/).\n\n##### Event V2 Alert Query\n\nExample: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n##### Process Alert Query\n\nExample: `processes(search).over(tags).rollup('count').last(timeframe) operator #`\n\n- `search` free text search string for querying processes.\nMatching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page.\n- `tags` one or more tags (comma-separated)\n- `timeframe` the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d\n- `operator` <, <=, >, >=, ==, or !=\n- `#` an integer or decimal number used to set the threshold\n\n##### Logs Alert Query\n\nExample: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `index_name` For multi-index organizations, the log index in which the request is performed.\n- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n##### Composite Query\n\nExample: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors\n\n* `name` [*required*, *default* = **dynamic, based on query**]: The name of the alert.\n* `message` [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor.\nEmail notifications can be sent to specific users by using the same '@username' notation as events.\n* `tags` [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor.\nWhen getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags.\nIt is only available via the API and isn't visible or editable in the Datadog UI.\n\n##### SLO Alert Query\n\nExample: `error_budget(\"slo_id\").over(\"time_window\") operator #`\n\n- `slo_id`: The alphanumeric SLO ID of the SLO you are configuring the alert for.\n- `time_window`: The time window of the SLO target you wish to alert on. Valid options: `7d`, `30d`, `90d`.\n- `operator`: `>=` or `>`\n\n##### Audit Alert Query\n\nExample: `audits(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**NOTE** Only available on US1-FED and in closed beta on US1, EU, AP1, US3, and US5.\n\n##### CI Pipelines Alert Query\n\nExample: `ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**NOTE** CI Pipeline monitors are in alpha on US1, EU, AP1, US3, and US5.\n\n##### CI Tests Alert Query\n\nExample: `ci-tests(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**NOTE** CI Test monitors are available only in closed beta on US1, EU, AP1, US3, and US5.\n\n##### Error Tracking Alert Query\n\nExample(RUM): `error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window) operator #`\nExample(APM Traces): `error-tracking-traces(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**Database Monitoring Alert Query**\n\nExample: `database-monitoring(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**NOTE** Database Monitoring monitors are in alpha on US1."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"1989-12-01T14:28:43.831Z\",\n \"creator\": {\n \"email\": \"officia sunt\",\n \"handle\": \"pariatur\",\n \"name\": \"aute do\"\n },\n \"deleted\": \"2020-10-30T20:46:24.520Z\",\n \"id\": -50675854,\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\": \"ullamco incididunt cupidatat\",\n \"modified\": \"1981-03-27T05:04:03.098Z\",\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 \"mobile_small\",\n \"chrome.tablet\"\n ],\n \"enable_logs_sample\": false,\n \"enable_samples\": false,\n \"escalation_message\": \"none\",\n \"evaluation_delay\": -52819274,\n \"group_retention_duration\": \"dolor Lorem qui\",\n \"groupby_simple_monitor\": false,\n \"include_tags\": true,\n \"locked\": false,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": -94315945,\n \"new_host_delay\": 300,\n \"no_data_timeframe\": -86360342,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"labore dolore\",\n \"deserunt commodo consectetur\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"resolve\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": 56355858,\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 \"non_6f_\": 77287100\n },\n \"synthetics_check_id\": \"culpa in laborum irure\",\n \"threshold_windows\": {\n \"recovery_window\": \"culpa cupidatat Lorem ut\",\n \"trigger_window\": \"fugiat officia mollit esse quis\"\n },\n \"thresholds\": {\n \"critical\": -44507487.0891542,\n \"critical_recovery\": 94365870.17342958,\n \"ok\": 26645340.31156695,\n \"unknown\": -32772943.396166816,\n \"warning\": 75330874.10211122,\n \"warning_recovery\": 30665996.226613894\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\": \"minim tempor i\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"Ut fugiat officia\",\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\": \"do velit\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"amet proident anim in\",\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\": \"Warn\",\n \"priority\": 1,\n \"restricted_roles\": [\n \"enim qui cillum est\",\n \"quis ut\"\n ],\n \"state\": {\n \"groups\": {\n \"Lorem_1\": {\n \"last_nodata_ts\": -12653992,\n \"last_notified_ts\": -66141067,\n \"last_resolved_ts\": 5643925,\n \"last_triggered_ts\": -6121593,\n \"name\": \"dolore nulla i\",\n \"status\": \"OK\"\n },\n \"nisi_c43\": {\n \"last_nodata_ts\": -66061060,\n \"last_notified_ts\": -86988012,\n \"last_resolved_ts\": -39919633,\n \"last_triggered_ts\": 13467862,\n \"name\": \"Ut fugiat eiusmod anim\",\n \"status\": \"Ignored\"\n },\n \"minim_c\": {\n \"last_nodata_ts\": 6509669,\n \"last_notified_ts\": 39348490,\n \"last_resolved_ts\": 13221088,\n \"last_triggered_ts\": 21889420,\n \"name\": \"in velit Duis\",\n \"status\": \"Alert\"\n }\n }\n },\n \"tags\": [\n \"ex tempor\",\n \"enim veniam dolore\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
}
},
"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
}
},
"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
}
},
"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}"
}
]
}
