diff --git a/content/en/api/v1/service-level-objectives/examples.json b/content/en/api/v1/service-level-objectives/examples.json index 07e72ccb7e0b1..454f927ea84fc 100644 --- a/content/en/api/v1/service-level-objectives/examples.json +++ b/content/en/api/v1/service-level-objectives/examples.json @@ -69,7 +69,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of service level objective objects.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. Required if type is metric. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

errors

\n
\n

[string]

\n

An array of error messages. Each endpoint documents how/whether this field is\nused.

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

metadata

\n
\n

object

\n

The metadata object containing additional information about the list of SLOs.

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

page

\n
\n

object

\n

The object containing information about the pages of the list of SLOs.

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

total_count

\n
\n

int64

\n

The total number of resources that could be retrieved ignoring the parameters and filters in the request.

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

total_filtered_count

\n
\n

int64

\n

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.

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

data

\n
\n

[object]

\n

An array of service level objective objects.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice and count-based SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

Option 2

\n
\n

object

\n

A count-based SLI specification.

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

count [required]

\n
\n

object

\n

A count-based SLI specification, composed of three parts: the good events formula, the total events formula,\nand the involved queries.

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

good_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

total_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

errors

\n
\n

[string]

\n

An array of error messages. Each endpoint documents how/whether this field is\nused.

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

metadata

\n
\n

object

\n

The metadata object containing additional information about the list of SLOs.

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

page

\n
\n

object

\n

The object containing information about the pages of the list of SLOs.

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

total_count

\n
\n

int64

\n

The total number of resources that could be retrieved ignoring the parameters and filters in the request.

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

total_filtered_count

\n
\n

int64

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -180,7 +180,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of service level objective objects.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. Required if type is metric. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

errors

\n
\n

[string]

\n

An array of error messages. Each endpoint documents how/whether this field is\nused.

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

metadata

\n
\n

object

\n

The metadata object containing additional information about the list of SLOs.

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

page

\n
\n

object

\n

The object containing information about the pages of the list of SLOs.

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

total_count

\n
\n

int64

\n

The total number of resources that could be retrieved ignoring the parameters and filters in the request.

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

total_filtered_count

\n
\n

int64

\n

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.

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

data

\n
\n

[object]

\n

An array of service level objective objects.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice and count-based SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

Option 2

\n
\n

object

\n

A count-based SLI specification.

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

count [required]

\n
\n

object

\n

A count-based SLI specification, composed of three parts: the good events formula, the total events formula,\nand the involved queries.

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

good_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

total_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

errors

\n
\n

[string]

\n

An array of error messages. Each endpoint documents how/whether this field is\nused.

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

metadata

\n
\n

object

\n

The metadata object containing additional information about the list of SLOs.

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

page

\n
\n

object

\n

The object containing information about the pages of the list of SLOs.

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

total_count

\n
\n

int64

\n

The total number of resources that could be retrieved ignoring the parameters and filters in the request.

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

total_filtered_count

\n
\n

int64

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -285,7 +285,7 @@ "type": "metric", "warning_threshold": 99.95 }, - "html": "
\n
\n
\n
\n

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor IDs that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. Required if type is metric. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor IDs that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice and count-based SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

Option 2

\n
\n

object

\n

A count-based SLI specification.

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

count [required]

\n
\n

object

\n

A count-based SLI specification, composed of three parts: the good events formula, the total events formula,\nand the involved queries.

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

good_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

total_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

\n
\n \n
\n
" } }, "DeleteSLOTimeframeInBulk": { @@ -712,12 +712,11 @@ } ], "timeframe": "30d", - "type": "metric", "warning_threshold": 99.95 }, "errors": [] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A service level objective object includes a service level indicator, thresholds\nfor one or more timeframes, and metadata (name, description, tags, etc.).

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

configured_alert_ids

\n
\n

[integer]

\n

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.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. Required if type is metric. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

errors

\n
\n

[string]

\n

An array of error messages. Each endpoint documents how/whether this field is\nused.

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

data

\n
\n

object

\n

A service level objective object includes a service level indicator, thresholds\nfor one or more timeframes, and metadata (name, description, tags, etc.).

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

configured_alert_ids

\n
\n

[integer]

\n

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.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice and count-based SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

Option 2

\n
\n

object

\n

A count-based SLI specification.

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

count [required]

\n
\n

object

\n

A count-based SLI specification, composed of three parts: the good events formula, the total events formula,\nand the involved queries.

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

good_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

total_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

warning_threshold

\n
\n

double

\n

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.

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

errors

\n
\n

[string]

\n

An array of error messages. Each endpoint documents how/whether this field is\nused.

\n
\n \n
\n
" }, "403": { "json": { @@ -820,7 +819,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of service level objective objects.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. Required if type is metric. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

errors

\n
\n

[string]

\n

An array of error messages. Each endpoint documents how/whether this field is\nused.

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

metadata

\n
\n

object

\n

The metadata object containing additional information about the list of SLOs.

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

page

\n
\n

object

\n

The object containing information about the pages of the list of SLOs.

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

total_count

\n
\n

int64

\n

The total number of resources that could be retrieved ignoring the parameters and filters in the request.

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

total_filtered_count

\n
\n

int64

\n

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.

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

data

\n
\n

[object]

\n

An array of service level objective objects.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice and count-based SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

Option 2

\n
\n

object

\n

A count-based SLI specification.

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

count [required]

\n
\n

object

\n

A count-based SLI specification, composed of three parts: the good events formula, the total events formula,\nand the involved queries.

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

good_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

total_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

errors

\n
\n

[string]

\n

An array of error messages. Each endpoint documents how/whether this field is\nused.

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

metadata

\n
\n

object

\n

The metadata object containing additional information about the list of SLOs.

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

page

\n
\n

object

\n

The object containing information about the pages of the list of SLOs.

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

total_count

\n
\n

int64

\n

The total number of resources that could be retrieved ignoring the parameters and filters in the request.

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

total_filtered_count

\n
\n

int64

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -934,7 +933,7 @@ "type": "metric", "warning_threshold": 99.95 }, - "html": "
\n
\n
\n
\n

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. Required if type is metric. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

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

created_at

\n
\n

int64

\n

Creation timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

description

\n
\n

string

\n

A user-defined description of the service level objective.

\n

Always included in service level objective responses (but may be null).\nOptional in create/update requests.

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

groups

\n
\n

[string]

\n

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

\n

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.

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

id

\n
\n

string

\n

A unique identifier for the service level objective object.

\n

Always included in service level objective responses.

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

modified_at

\n
\n

int64

\n

Modification timestamp (UNIX time in seconds)

\n

Always included in service level objective responses.

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

monitor_ids

\n
\n

[integer]

\n

A list of monitor ids that defines the scope of a monitor service level\nobjective. Required if type is monitor.

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

monitor_tags

\n
\n

[string]

\n

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).

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

name [required]

\n
\n

string

\n

The name of the service level objective object.

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

query

\n
\n

object

\n

A metric-based SLO. 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.

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

denominator [required]

\n
\n

string

\n

A Datadog metric query for total (valid) events.

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

numerator [required]

\n
\n

string

\n

A Datadog metric query for good events.

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

sli_specification

\n
\n

 <oneOf>

\n

A generic SLI specification. This is currently used for time-slice and count-based SLOs only.

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

Option 1

\n
\n

object

\n

A time-slice SLI specification.

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

time_slice [required]

\n
\n

object

\n

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.

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

comparator [required]

\n
\n

enum

\n

The comparator used to compare the SLI value to the threshold. \nAllowed enum values: >,>=,<,<=

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

query [required]

\n
\n

object

\n

The queries and formula used to calculate the SLI value.

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

formulas [required]

\n
\n

[object]

\n

A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

\n

A list of queries that are used to calculate the SLI value.

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

query_interval_seconds

\n
\n

enum

\n

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

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

threshold [required]

\n
\n

double

\n

The threshold value to which each SLI value will be compared.

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

Option 2

\n
\n

object

\n

A count-based SLI specification.

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

count [required]

\n
\n

object

\n

A count-based SLI specification, composed of three parts: the good events formula, the total events formula,\nand the involved queries.

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

good_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

queries [required]

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

A formula and functions metrics query.

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

aggregator

\n
\n

enum

\n

The aggregation methods available for metrics queries. \nAllowed enum values: avg,min,max,sum,last,area,l2norm,percentile

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

cross_org_uuids

\n
\n

[string]

\n

The source organization UUID for cross organization queries. Feature in Private Beta.

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

data_source [required]

\n
\n

enum

\n

Data source for metrics queries. \nAllowed enum values: metrics

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

name [required]

\n
\n

string

\n

Name of the query for use in formulas.

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

query [required]

\n
\n

string

\n

Metrics query definition.

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

total_events_formula [required]

\n
\n

object

\n

A formula that specifies how to combine the results of multiple queries.

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

formula [required]

\n
\n

string

\n

The formula string, which is an expression involving named queries.

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

tags

\n
\n

[string]

\n

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.

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

target_threshold

\n
\n

double

\n

The target threshold such that when the service level indicator is above this\nthreshold over the given timeframe, the objective is being met.

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

thresholds [required]

\n
\n

[object]

\n

The thresholds (timeframes and associated targets) for this service level\nobjective object.

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

target [required]

\n
\n

double

\n

The target value for the service level indicator within the corresponding\ntimeframe.

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

target_display

\n
\n

string

\n

A string representation of the target that indicates its precision.\nIt uses trailing zeros to show significant decimal places (for example 98.00).

\n

Always included in service level objective responses. Ignored in\ncreate/update requests.

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

timeframe [required]

\n
\n

enum

\n

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

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

warning

\n
\n

double

\n

The warning value for the service level objective.

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

warning_display

\n
\n

string

\n

A string representation of the warning target (see the description of\nthe target_display field for details).

\n

Included in service level objective responses if a warning target exists.\nIgnored in create/update requests.

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

timeframe

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

The type of the service level objective. \nAllowed enum values: metric,monitor,time_slice

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

warning_threshold

\n
\n

double

\n

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.

\n
\n \n
\n
" } }, "GetSLOCorrections": { diff --git a/content/en/api/v1/service-level-objectives/request.CreateSLO_512760759.json b/content/en/api/v1/service-level-objectives/request.CreateSLO_512760759.json new file mode 100644 index 0000000000000..82fe0571eec7b --- /dev/null +++ b/content/en/api/v1/service-level-objectives/request.CreateSLO_512760759.json @@ -0,0 +1,43 @@ +{ + "type": "metric", + "description": "Metric SLO using sli_specification", + "name": "Example-Service-Level-Objective", + "sli_specification": { + "count": { + "good_events_formula": { + "formula": "query1" + }, + "total_events_formula": { + "formula": "query2" + }, + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "sum:httpservice.success{*}.as_count()" + }, + { + "data_source": "metrics", + "name": "query2", + "query": "sum:httpservice.hits{*}.as_count()" + } + ] + } + }, + "tags": [ + "env:prod", + "type:count" + ], + "thresholds": [ + { + "target": 99.0, + "target_display": "99.0", + "timeframe": "7d", + "warning": 98, + "warning_display": "98.0" + } + ], + "timeframe": "7d", + "target_threshold": 99.0, + "warning_threshold": 98 +} \ No newline at end of file diff --git a/data/api/v1/CodeExamples.json b/data/api/v1/CodeExamples.json index ba4cc8a64b4bd..c54c03be2eda2 100644 --- a/data/api/v1/CodeExamples.json +++ b/data/api/v1/CodeExamples.json @@ -833,6 +833,11 @@ } ], "CreateSLO": [ + { + "group": "service_level_objectives", + "suffix": "_512760759", + "description": "Create a new metric SLO object using sli_specification returns \"OK\" response" + }, { "group": "service_level_objectives", "suffix": "_3765703239", diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index 7142ee379c9d7..102a8e0d33f70 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -11516,6 +11516,60 @@ components: example: UTC type: string type: object + SLOCountCondition: + description: 'A count-based SLI specification, composed of three parts: the + good events formula, the total events formula, + + and the involved queries.' + example: + good_events_formula: query1 - query2 + queries: + - data_source: metrics + name: query1 + query: sum:trace.servlet.request.success{*} by {env}.as_count() + - data_source: metrics + name: query2 + query: sum:trace.servlet.request.hits{*} by {env}.as_count() + total_events_formula: query2 + properties: + good_events_formula: + $ref: '#/components/schemas/SLOFormula' + queries: + example: + - data_source: metrics + name: query1 + query: sum:trace.servlet.request.hits{*} by {env}.as_count() + items: + $ref: '#/components/schemas/SLODataSourceQueryDefinition' + minItems: 1 + type: array + total_events_formula: + $ref: '#/components/schemas/SLOFormula' + required: + - good_events_formula + - total_events_formula + - queries + type: object + SLOCountSpec: + additionalProperties: false + description: A count-based SLI specification. + example: + count: + good_events_formula: query1 - query2 + queries: + - data_source: metrics + name: query1 + query: sum:trace.servlet.request.success{*} by {env}.as_count() + - data_source: metrics + name: query2 + query: sum:trace.servlet.request.hits{*} by {env}.as_count() + total_events_formula: query2 + properties: + count: + $ref: '#/components/schemas/SLOCountCondition' + required: + - count + type: object SLOCreator: description: The creator of the SLO nullable: true @@ -12402,8 +12456,6 @@ components: type: array timeframe: $ref: '#/components/schemas/SLOTimeframe' - type: - $ref: '#/components/schemas/SLOType' warning_threshold: description: 'The optional warning threshold such that when the service level indicator is @@ -12421,9 +12473,10 @@ components: type: object SLOSliSpec: description: A generic SLI specification. This is currently used for time-slice - SLOs only. + and count-based SLOs only. oneOf: - $ref: '#/components/schemas/SLOTimeSliceSpec' + - $ref: '#/components/schemas/SLOCountSpec' SLOState: description: State of the SLO. enum: @@ -13606,8 +13659,7 @@ components: - type type: object ServiceLevelObjectiveQuery: - description: 'A metric-based SLO. **Required if type is `metric`**. Note that - Datadog only allows the sum by aggregator + description: 'A metric-based SLO. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or