data
\n[object]
An array of service level objective objects.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor-based service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\nobject
A count-based (metric) SLI specification, composed of three parts: the good events formula, the total events formula,\nand the underlying queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
errors
\n[string]
An array of error messages. Each endpoint documents how/whether this field is\nused.
metadata
\nobject
The metadata object containing additional information about the list of SLOs.
page
\nobject
The object containing information about the pages of the list of SLOs.
total_count
\nint64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
\nint64
The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages.
data
\n[object]
An array of service level objective objects.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor-based service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\n<oneOf>
A count-based (metric) SLI specification, composed of three parts: the good events formula,\nthe bad or total events formula, and the underlying queries.\nExactly one of total_events_formula or bad_events_formula must be provided.
Option 1
\nobject
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
The total events formula. Bad events queries can be defined using the bad_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
Option 2
\nobject
bad_events_formula [required]
\nobject
The bad events formula (recommended). Total events queries can be defined using the total_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
errors
\n[string]
An array of error messages. Each endpoint documents how/whether this field is\nused.
metadata
\nobject
The metadata object containing additional information about the list of SLOs.
page
\nobject
The object containing information about the pages of the list of SLOs.
total_count
\nint64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
\nint64
The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages.
data
\n[object]
An array of service level objective objects.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor-based service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\nobject
A count-based (metric) SLI specification, composed of three parts: the good events formula, the total events formula,\nand the underlying queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
errors
\n[string]
An array of error messages. Each endpoint documents how/whether this field is\nused.
metadata
\nobject
The metadata object containing additional information about the list of SLOs.
page
\nobject
The object containing information about the pages of the list of SLOs.
total_count
\nint64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
\nint64
The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages.
data
\n[object]
An array of service level objective objects.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor-based service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\n<oneOf>
A count-based (metric) SLI specification, composed of three parts: the good events formula,\nthe bad or total events formula, and the underlying queries.\nExactly one of total_events_formula or bad_events_formula must be provided.
Option 1
\nobject
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
The total events formula. Bad events queries can be defined using the bad_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
Option 2
\nobject
bad_events_formula [required]
\nobject
The bad events formula (recommended). Total events queries can be defined using the total_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
errors
\n[string]
An array of error messages. Each endpoint documents how/whether this field is\nused.
metadata
\nobject
The metadata object containing additional information about the list of SLOs.
page
\nobject
The object containing information about the pages of the list of SLOs.
total_count
\nint64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
\nint64
The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
monitor_ids
\n[integer]
A list of monitor IDs that defines the scope of a monitor service level\nobjective. Required if type is monitor.
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\nobject
A count-based (metric) SLI specification, composed of three parts: the good events formula, the total events formula,\nand the underlying queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
monitor_ids
\n[integer]
A list of monitor IDs that defines the scope of a monitor service level\nobjective. Required if type is monitor.
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\n<oneOf>
A count-based (metric) SLI specification, composed of three parts: the good events formula,\nthe bad or total events formula, and the underlying queries.\nExactly one of total_events_formula or bad_events_formula must be provided.
Option 1
\nobject
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
The total events formula. Bad events queries can be defined using the bad_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
Option 2
\nobject
bad_events_formula [required]
\nobject
The bad events formula (recommended). Total events queries can be defined using the total_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
data
\nobject
A service level objective object includes a service level indicator, thresholds\nfor one or more timeframes, and metadata (name, description, tags, etc.).
configured_alert_ids
\n[integer]
A list of SLO monitors IDs that reference this SLO. This field is returned only when with_configured_alert_ids parameter is true in query.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name
\nstring
The name of the service level objective object.
query
\nobject
The metric query used to define a count-based SLO as the ratio of good events to total events.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is currently used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\nobject
A count-based (metric) SLI specification, composed of three parts: the good events formula, the total events formula,\nand the underlying queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
errors
\n[string]
An array of error messages. Each endpoint documents how/whether this field is\nused.
data
\nobject
A service level objective object includes a service level indicator, thresholds\nfor one or more timeframes, and metadata (name, description, tags, etc.).
configured_alert_ids
\n[integer]
A list of SLO monitors IDs that reference this SLO. This field is returned only when with_configured_alert_ids parameter is true in query.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name
\nstring
The name of the service level objective object.
query
\nobject
The metric query used to define a count-based SLO as the ratio of good events to total events.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is currently used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\n<oneOf>
A count-based (metric) SLI specification, composed of three parts: the good events formula,\nthe bad or total events formula, and the underlying queries.\nExactly one of total_events_formula or bad_events_formula must be provided.
Option 1
\nobject
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
The total events formula. Bad events queries can be defined using the bad_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
Option 2
\nobject
bad_events_formula [required]
\nobject
The bad events formula (recommended). Total events queries can be defined using the total_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
errors
\n[string]
An array of error messages. Each endpoint documents how/whether this field is\nused.
data
\n[object]
An array of service level objective objects.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor-based service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\nobject
A count-based (metric) SLI specification, composed of three parts: the good events formula, the total events formula,\nand the underlying queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
errors
\n[string]
An array of error messages. Each endpoint documents how/whether this field is\nused.
metadata
\nobject
The metadata object containing additional information about the list of SLOs.
page
\nobject
The object containing information about the pages of the list of SLOs.
total_count
\nint64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
\nint64
The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages.
data
\n[object]
An array of service level objective objects.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor-based service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\n<oneOf>
A count-based (metric) SLI specification, composed of three parts: the good events formula,\nthe bad or total events formula, and the underlying queries.\nExactly one of total_events_formula or bad_events_formula must be provided.
Option 1
\nobject
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
The total events formula. Bad events queries can be defined using the bad_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
Option 2
\nobject
bad_events_formula [required]
\nobject
The bad events formula (recommended). Total events queries can be defined using the total_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
errors
\n[string]
An array of error messages. Each endpoint documents how/whether this field is\nused.
metadata
\nobject
The metadata object containing additional information about the list of SLOs.
page
\nobject
The object containing information about the pages of the list of SLOs.
total_count
\nint64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
\nint64
The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor-based service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\nobject
A count-based (metric) SLI specification, composed of three parts: the good events formula, the total events formula,\nand the underlying queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.
created_at
\nint64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
description
\nstring
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).\nOptional in create/update requests.
groups
\n[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in\ncreate/update requests for monitor service level objectives, but may only be\nused when then length of the monitor_ids field is one.
id
\nstring
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
\nint64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
\n[integer]
A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.
monitor_tags
\n[string]
The union of monitor tags for all monitors referenced by the monitor_ids\nfield.\nAlways included in service level objective responses for monitor-based service level\nobjectives (but may be empty). Ignored in create/update requests. Does not\naffect which monitors are included in the service level objective (that is\ndetermined entirely by the monitor_ids field).
name [required]
\nstring
The name of the service level objective object.
query
\nobject
A count-based (metric) SLO query. This field is superseded by sli_specification but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator\nto be used because this will sum up all request counts instead of averaging them, or taking the max or\nmin of all of those requests.
denominator [required]
\nstring
A Datadog metric query for total (valid) events.
numerator [required]
\nstring
A Datadog metric query for good events.
sli_specification
\n<oneOf>
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
Option 1
\nobject
A time-slice SLI specification.
time_slice [required]
\nobject
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,\nand 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
\nenum
The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=
query [required]
\nobject
The queries and formula used to calculate the SLI value.
formulas [required]
\n[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
query_interval_seconds
\nenum
The interval used when querying data, which defines the size of a time slice.\nTwo values are allowed: 60 (1 minute) and 300 (5 minutes).\nIf not provided, the value defaults to 300 (5 minutes). \nAllowed enum values: 60,300
threshold [required]
\ndouble
The threshold value to which each SLI value will be compared.
Option 2
\nobject
A metric SLI specification.
count [required]
\n<oneOf>
A count-based (metric) SLI specification, composed of three parts: the good events formula,\nthe bad or total events formula, and the underlying queries.\nExactly one of total_events_formula or bad_events_formula must be provided.
Option 1
\nobject
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
total_events_formula [required]
\nobject
The total events formula. Bad events queries can be defined using the bad_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
Option 2
\nobject
bad_events_formula [required]
\nobject
The bad events formula (recommended). Total events queries can be defined using the total_events_formula field as an alternative. Only one of total_events_formula or bad_events_formula must be provided.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
good_events_formula [required]
\nobject
A formula that specifies how to combine the results of multiple queries.
formula [required]
\nstring
The formula string, which is an expression involving named queries.
queries [required]
\n[ <oneOf>]
Option 1
\nobject
A formula and functions metrics query.
aggregator
\nenum
The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
\n[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
\nenum
Data source for metrics queries. \nAllowed enum values: metrics
name [required]
\nstring
Name of the query for use in formulas.
query [required]
\nstring
Metrics query definition.
semantic_mode
\nenum
Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. \nAllowed enum values: combined,native
tags
\n[string]
A list of tags associated with this service level objective.\nAlways included in service level objective responses (but may be empty).\nOptional in create/update requests.
target_threshold
\ndouble
The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.
thresholds [required]
\n[object]
The thresholds (timeframes and associated targets) for this service level\nobjective object.
target [required]
\ndouble
The target value for the service level indicator within the corresponding\ntimeframe.
target_display
\nstring
A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in\ncreate/update requests.
timeframe [required]
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
warning
\ndouble
The warning value for the service level objective.
warning_display
\nstring
A string representation of the warning target (see the description of\nthe target_display field for details).
Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.
timeframe
\nenum
The SLO time window options. Note that "custom" is not a valid option for creating\nor updating SLOs. It is only used when querying SLO history over custom timeframes. \nAllowed enum values: 7d,30d,90d,custom
type [required]
\nenum
The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice
warning_threshold
\ndouble
The optional warning threshold such that when the service level indicator is\nbelow this value for the given threshold, but above the target threshold, the\nobjective appears in a "warning" state. This value must be greater than the target\nthreshold.