From 1f855c2d92066743223e076732b2257db89c0bf3 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Tue, 25 Feb 2025 16:22:28 +0000 Subject: [PATCH] Regenerate client from commit b5659b74 of spec repo --- .apigentools-info | 8 +- content/en/api/v1/monitors/examples.json | 55 ++++++----- data/api/v1/full_spec.yaml | 7 +- data/api/v1/full_spec_deref.json | 112 +++++++++++++++++++---- static/resources/json/full_spec_v1.json | 112 +++++++++++++++++++---- 5 files changed, 235 insertions(+), 59 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index e70c4424eec1a..73776c1e09864 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-02-24 14:20:55.086148", - "spec_repo_commit": "b34a35ef" + "regenerated": "2025-02-25 16:22:09.062919", + "spec_repo_commit": "b5659b74" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-02-24 14:21:03.395994", - "spec_repo_commit": "b34a35ef" + "regenerated": "2025-02-25 16:22:17.405996", + "spec_repo_commit": "b5659b74" } } } \ No newline at end of file diff --git a/content/en/api/v1/monitors/examples.json b/content/en/api/v1/monitors/examples.json index 1b7b07979bea5..93840951ffb7d 100644 --- a/content/en/api/v1/monitors/examples.json +++ b/content/en/api/v1/monitors/examples.json @@ -67,7 +67,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -136,7 +137,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" }, "400": { "json": { @@ -237,7 +238,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -306,7 +308,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" }, "400": { "json": { @@ -406,7 +408,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -462,7 +465,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" } }, "CheckCanDeleteMonitor": { @@ -792,7 +795,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -848,7 +852,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" } }, "DeleteMonitor": { @@ -974,7 +978,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -1043,7 +1048,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" }, "400": { "json": { @@ -1152,7 +1157,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -1221,7 +1227,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" }, "400": { "json": { @@ -1326,7 +1332,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -1382,7 +1389,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" } }, "MuteMonitor": { @@ -1453,7 +1460,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -1522,7 +1530,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" }, "400": { "json": { @@ -1631,7 +1639,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -1700,7 +1709,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" }, "400": { "json": { @@ -1845,7 +1854,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -1901,7 +1911,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" } }, "MuteAllMonitors": { @@ -1972,7 +1982,8 @@ "evaluation_window": { "day_starts": "04:00", "hour_starts": 0, - "month_starts": 1 + "month_starts": 1, + "timezone": "Europe/Paris" } }, "silenced": { @@ -2041,7 +2052,7 @@ "tags": [], "type": "query alert" }, - "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of the monitor creation.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

Object describing the creator of the shared element.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the creator.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the creator.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the creator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Whether or not the monitor is deleted. (Always null)

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of this monitor.

\n
\n \n
\n
\n
\n
\n
\n

matching_downtimes

\n
\n

[object]

\n

A list of active v1 downtimes that match this monitor.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

POSIX timestamp to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

int64

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[string]

\n

The scope(s) to which the downtime applies. Must be in key:value format. For example, host:app2.\nProvide multiple scopes as a comma-separated list like env:dev,env:prod.\nThe resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

POSIX timestamp to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this monitor.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Last timestamp when the monitor was edited.

\n
\n \n
\n
\n
\n
\n
\n

multi

\n
\n

boolean

\n

Whether or not the monitor is broken down on different groups.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The monitor name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

List of options associated with your monitor.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

object

\n

Type of aggregation performed in the monitor query.

\n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

Group to break down the monitor on.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric name used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Metric type used in the monitor.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

DEPRECATED: IDs of the device the Synthetics monitor is running on.

\n
\n \n
\n
\n
\n
\n
\n

enable_logs_sample

\n
\n

boolean

\n

Whether or not to send a log sample when the log monitor triggers.

\n
\n \n
\n
\n
\n
\n
\n

enable_samples

\n
\n

boolean

\n

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

\n
\n \n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

We recommend using the is_renotify,\nblock in the original message instead.\nA message to include with a re-notification. Supports the @username notification we allow elsewhere.\nNot applicable if renotify_interval is None.

\n
\n \n
\n
\n
\n
\n
\n

evaluation_delay

\n
\n

int64

\n

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min),\nthe timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55.\nThis is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

\n
\n \n
\n
\n
\n
\n
\n

group_retention_duration

\n
\n

string

\n

The time span after which groups with missing data are dropped from the monitor state.\nThe minimum value is one hour, and the maximum value is 72 hours.\nExample values are: "60m", "1h", and "2d".\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

\n
\n \n
\n
\n
\n
\n
\n

groupby_simple_monitor

\n
\n

boolean

\n

DEPRECATED: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use notify_by instead.

\n
\n \n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

\n

Examples

\n
    \n
  • If True, [Triggered on {host:h1}] Monitor Title
    • \n
  • If False, [Triggered] Monitor Title
    • \n

default: true

\n
\n \n
\n
\n
\n
\n
\n

locked

\n
\n

boolean

\n

DEPRECATED: Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

The minimum number of locations in failure at the same time during\nat least one moment in the min_failure_duration period (min_location_failed and min_failure_duration\nare part of the advanced alerting rules - integer, >= 1).

default: 1

\n
\n \n
\n
\n
\n
\n
\n

new_group_delay

\n
\n

int64

\n

Time (in seconds) to skip evaluations for new groups.

\n

For example, this option can be used to skip evaluations for new hosts while they initialize.

\n

Must be a non negative integer.

\n
\n \n
\n
\n
\n
\n
\n

new_host_delay

\n
\n

int64

\n

DEPRECATED: Time (in seconds) to allow a host to boot and applications\nto fully start before starting the evaluation of monitor results.\nShould be a non negative integer.

\n

Use new_group_delay instead.

default: 300

\n
\n \n
\n
\n
\n
\n
\n

no_data_timeframe

\n
\n

int64

\n

The number of minutes before a monitor notifies after data stops reporting.\nDatadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks.\nIf omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

Toggles the display of additional content sent in the monitor notification. \nAllowed enum values: show_all,hide_query,hide_handles,hide_all

default: show_all

\n
\n \n
\n
\n
\n
\n
\n

notify_audit

\n
\n

boolean

\n

A Boolean indicating whether tagged users is notified on changes to this monitor.

\n
\n \n
\n
\n
\n
\n
\n

notify_by

\n
\n

[string]

\n

Controls what granularity a monitor alerts on. Only available for monitors with groupings.\nFor instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each\nnew cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned\nin notify_by must be a subset of the grouping tags in the query.\nFor example, a query grouped by cluster and namespace cannot notify on region.\nSetting notify_by to [*] configures the monitor to notify as a simple-alert.

\n
\n \n
\n
\n
\n
\n
\n

notify_no_data

\n
\n

boolean

\n

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

on_missing_data

\n
\n

enum

\n

Controls how groups or monitors are treated if an evaluation does not return any data points.\nThe default option results in different behavior depending on the monitor query type.\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. \nAllowed enum values: default,show_no_data,show_and_notify_no_data,resolve

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

The number of minutes after the last notification before a monitor re-notifies on the current status.\nIt only re-notifies if it’s not resolved.

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

\n
\n \n
\n
\n
\n
\n
\n

renotify_statuses

\n
\n

[string]

\n

The types of monitor statuses for which re-notification messages are sent.\nDefault: null if renotify_interval is null.\nIf renotify_interval is set, defaults to renotify on Alert and No Data.

\n
\n \n
\n
\n
\n
\n
\n

require_full_window

\n
\n

boolean

\n

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.\nWe highly recommend you set this to false for sparse metrics,\notherwise some evaluations are skipped. Default is false. This setting only applies to\nmetric monitors.

\n
\n \n
\n
\n
\n
\n
\n

scheduling_options

\n
\n

object

\n

Configuration options for scheduling.

\n
\n
\n
\n
\n
\n

custom_schedule

\n
\n

object

\n

Configuration options for the custom schedule. This feature is in private beta.

\n
\n
\n
\n
\n
\n

recurrences

\n
\n

[object]

\n

Array of custom schedule recurrences.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Defines the recurrence rule (RRULE) for a given schedule.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Defines the start date and time of the recurring schedule.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Defines the timezone the schedule runs on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

evaluation_window

\n
\n

object

\n

Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

\n
\n
\n
\n
\n
\n

day_starts

\n
\n

string

\n

The time of the day at which a one day cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

hour_starts

\n
\n

int32

\n

The minute of the hour at which a one hour cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

month_starts

\n
\n

int32

\n

The day of the month at which a one month cumulative evaluation window starts.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone of the time of the day of the cumulative evaluation window start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

silenced

\n
\n

object

\n

DEPRECATED: Information about the downtime applied to the monitor. Only shows v1 downtimes.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

int64

\n

UTC epoch timestamp in seconds when the downtime for the group expires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

synthetics_check_id

\n
\n

string

\n

DEPRECATED: ID of the corresponding Synthetic check.

\n
\n \n
\n
\n
\n
\n
\n

threshold_windows

\n
\n

object

\n

Alerting time window options.

\n
\n
\n
\n
\n
\n

recovery_window

\n
\n

string

\n

Describes how long an anomalous metric must be normal before the alert recovers.

\n
\n \n
\n
\n
\n
\n
\n

trigger_window

\n
\n

string

\n

Describes how long a metric must be anomalous before an alert triggers.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

thresholds

\n
\n

object

\n

List of the different monitor threshold available.

\n
\n
\n
\n
\n
\n

critical

\n
\n

double

\n

The monitor CRITICAL threshold.

\n
\n \n
\n
\n
\n
\n
\n

critical_recovery

\n
\n

double

\n

The monitor CRITICAL recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n

ok

\n
\n

double

\n

The monitor OK threshold.

\n
\n \n
\n
\n
\n
\n
\n

unknown

\n
\n

double

\n

The monitor UNKNOWN threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning

\n
\n

double

\n

The monitor WARNING threshold.

\n
\n \n
\n
\n
\n
\n
\n

warning_recovery

\n
\n

double

\n

The monitor WARNING recovery threshold.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_h

\n
\n

int64

\n

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

\n
\n \n
\n
\n
\n
\n
\n

variables

\n
\n

[ <oneOf>]

\n

List of requests that can be used in the monitor query. This feature is currently in beta.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A formula and functions events query.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

Compute options.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

int64

\n

A time interval in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Measurable attribute to compute.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for event platform-based queries. \nAllowed enum values: rum,ci_pipelines,ci_tests,audit,events,logs,spans,database_queries,network

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

[object]

\n

Group by options.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

Event facet.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Number of groups to return.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n

Options for sorting group by results.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

enum

\n

Aggregation methods for event platform queries. \nAllowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

Metric used for sorting group by results.

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

enum

\n

Direction of sort. \nAllowed enum values: asc,desc

default: desc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n

Search options.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Events search string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A formula and functions cost query.

\n
\n
\n
\n
\n
\n

aggregator

\n
\n

enum

\n

Aggregation methods for metric queries. \nAllowed enum values: avg,sum,max,min,last,area,l2norm,percentile,stddev

\n
\n \n
\n
\n
\n
\n
\n

data_source [required]

\n
\n

enum

\n

Data source for cost queries. \nAllowed enum values: metrics,cloud_cost,datadog_usage

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

overall_state

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The monitor query.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

object

\n

Wrapper object with the different monitor states.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

Dictionary where the keys are groups (comma separated lists of tags) and the values are\nthe list of groups your monitor is broken down on.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Monitor state for a single group.

\n
\n
\n
\n
\n
\n

last_nodata_ts

\n
\n

int64

\n

Latest timestamp the monitor was in NO_DATA state.

\n
\n \n
\n
\n
\n
\n
\n

last_notified_ts

\n
\n

int64

\n

Latest timestamp of the notification sent for this monitor group.

\n
\n \n
\n
\n
\n
\n
\n

last_resolved_ts

\n
\n

int64

\n

Latest timestamp the monitor group was resolved.

\n
\n \n
\n
\n
\n
\n
\n

last_triggered_ts

\n
\n

int64

\n

Latest timestamp the monitor group triggered.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The different states your monitor can be in. \nAllowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags associated to your monitor.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the monitor. For more information about type, see the monitor options docs. \nAllowed enum values: composite,event alert,log alert,metric alert,process alert,query alert,rum alert,service check,synthetics alert,trace-analytics alert,slo alert,event-v2 alert,audit alert,ci-pipelines alert,ci-tests alert,error-tracking alert,database-monitoring alert,network-performance alert,cost alert

\n
\n \n
\n
" }, "400": { "json": { diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index c6c81477bca3f..0b09f5ebd8acc 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -7544,7 +7544,7 @@ components: properties: day_starts: description: The time of the day at which a one day cumulative evaluation - window starts. Must be defined in UTC time in `HH:mm` format. + window starts. example: 04:00 type: string hour_starts: @@ -7563,6 +7563,11 @@ components: maximum: 1 minimum: 1 type: integer + timezone: + description: The timezone of the time of the day of the cumulative evaluation + window start. + example: Europe/Paris + type: string type: object MonitorOverallStates: description: The different states your monitor can be in. diff --git a/data/api/v1/full_spec_deref.json b/data/api/v1/full_spec_deref.json index f6020d5d1565c..a16f19f3f4778 100644 --- a/data/api/v1/full_spec_deref.json +++ b/data/api/v1/full_spec_deref.json @@ -153281,7 +153281,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -153300,6 +153300,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -155282,7 +155287,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -155301,6 +155306,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -155798,7 +155808,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -155817,6 +155827,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -155828,7 +155843,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -155847,6 +155862,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -157334,7 +157354,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -157353,6 +157373,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1004408,7 +1004433,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1004427,6 +1004452,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1005469,7 +1005499,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1005488,6 +1005518,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1006394,7 +1006429,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1006413,6 +1006448,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1008597,7 +1008637,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1008616,6 +1008656,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1009896,7 +1009941,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1009915,6 +1009960,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1010929,7 +1010979,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1010948,6 +1010998,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1011849,7 +1011904,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1011868,6 +1011923,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1013573,7 +1013633,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1013592,6 +1013652,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1014672,7 +1014737,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1014691,6 +1014756,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1015753,7 +1015823,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1015772,6 +1015842,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1172856,7 +1172931,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1172875,6 +1172950,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" diff --git a/static/resources/json/full_spec_v1.json b/static/resources/json/full_spec_v1.json index f6020d5d1565c..a16f19f3f4778 100644 --- a/static/resources/json/full_spec_v1.json +++ b/static/resources/json/full_spec_v1.json @@ -153281,7 +153281,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -153300,6 +153300,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -155282,7 +155287,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -155301,6 +155306,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -155798,7 +155808,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -155817,6 +155827,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -155828,7 +155843,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -155847,6 +155862,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -157334,7 +157354,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -157353,6 +157373,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1004408,7 +1004433,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1004427,6 +1004452,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1005469,7 +1005499,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1005488,6 +1005518,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1006394,7 +1006429,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1006413,6 +1006448,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1008597,7 +1008637,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1008616,6 +1008656,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1009896,7 +1009941,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1009915,6 +1009960,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1010929,7 +1010979,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1010948,6 +1010998,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1011849,7 +1011904,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1011868,6 +1011923,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1013573,7 +1013633,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1013592,6 +1013652,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1014672,7 +1014737,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1014691,6 +1014756,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1015753,7 +1015823,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1015772,6 +1015842,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object" @@ -1172856,7 +1172931,7 @@ "description": "Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.", "properties": { "day_starts": { - "description": "The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.", + "description": "The time of the day at which a one day cumulative evaluation window starts.", "example": "04:00", "type": "string" }, @@ -1172875,6 +1172950,11 @@ "maximum": 1, "minimum": 1, "type": "integer" + }, + "timezone": { + "description": "The timezone of the time of the day of the cumulative evaluation window start.", + "example": "Europe/Paris", + "type": "string" } }, "type": "object"