Service Level Objectives
(or SLOs) are a key part of the site reliability engineering toolkit.
SLOs provide a framework for defining clear targets around application performance,
which ultimately help teams provide a consistent customer experience,
balance feature development with platform stability,
and improve communication with internal and external users.
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).
Optional in create/update requests.
groups
[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in
create/update requests for monitor service level objectives, but may only be
used when then length of the monitor_ids field is one.
monitor_ids
[integer]
A list of monitor IDs that defines the scope of a monitor service level
objective. Required if type is monitor.
name [required]
string
The name of the service level objective object.
query
object
A metric-based SLO. Required if type is metric. 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
min of all of those requests.
denominator [required]
string
A Datadog metric query for total (valid) events.
numerator [required]
string
A Datadog metric query for good events.
sli_specification
<oneOf>
A generic SLI specification. This is currently used for time-slice SLOs only.
Option 1
object
A time-slice SLI specification.
time_slice [required]
object
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,
and 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
enum
The comparator used to compare the SLI value to the threshold.
Allowed enum values: >,>=,<,<=
query [required]
object
The queries and formula used to calculate the SLI value.
formulas [required]
[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
string
The formula string, which is an expression involving named queries.
queries [required]
[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries.
Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
enum
Data source for metrics queries.
Allowed enum values: metrics
name [required]
string
Name of the query for use in formulas.
query [required]
string
Metrics query definition.
query_interval_seconds
enum
The interval used when querying data, which defines the size of a time slice.
Two values are allowed: 60 (1 minute) and 300 (5 minutes).
If not provided, the value defaults to 300 (5 minutes).
Allowed enum values: 60,300
threshold [required]
double
The threshold value to which each SLI value will be compared.
tags
[string]
A list of tags associated with this service level objective.
Always included in service level objective responses (but may be empty).
Optional in create/update requests.
target_threshold
double
The target threshold such that when the service level indicator is above this
threshold over the given timeframe, the objective is being met.
thresholds [required]
[object]
The thresholds (timeframes and associated targets) for this service level
objective object.
target [required]
double
The target value for the service level indicator within the corresponding
timeframe.
target_display
string
A string representation of the target that indicates its precision.
It uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in
create/update requests.
timeframe [required]
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
warning
double
The warning value for the service level objective.
warning_display
string
A string representation of the warning target (see the description of
the target_display field for details).
Included in service level objective responses if a warning target exists.
Ignored in create/update requests.
timeframe
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
type [required]
enum
The type of the service level objective.
Allowed enum values: metric,monitor,time_slice
warning_threshold
double
The optional warning threshold such that when the service level indicator is
below this value for the given threshold, but above the target threshold, the
objective appears in a "warning" state. This value must be greater than the target
threshold.
A response with one or more service level objective.
Expand All
Field
Type
Description
data
[object]
An array of service level objective objects.
created_at
int64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
object
Object describing the creator of the shared element.
email
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
description
string
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).
Optional in create/update requests.
groups
[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in
create/update requests for monitor service level objectives, but may only be
used when then length of the monitor_ids field is one.
id
string
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
int64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
[integer]
A list of monitor ids that defines the scope of a monitor service level
objective. Required if type is monitor.
monitor_tags
[string]
The union of monitor tags for all monitors referenced by the monitor_ids
field.
Always included in service level objective responses for monitor-based service level
objectives (but may be empty). Ignored in create/update requests. Does not
affect which monitors are included in the service level objective (that is
determined entirely by the monitor_ids field).
name [required]
string
The name of the service level objective object.
query
object
A metric-based SLO. Required if type is metric. 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
min of all of those requests.
denominator [required]
string
A Datadog metric query for total (valid) events.
numerator [required]
string
A Datadog metric query for good events.
sli_specification
<oneOf>
A generic SLI specification. This is currently used for time-slice SLOs only.
Option 1
object
A time-slice SLI specification.
time_slice [required]
object
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,
and 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
enum
The comparator used to compare the SLI value to the threshold.
Allowed enum values: >,>=,<,<=
query [required]
object
The queries and formula used to calculate the SLI value.
formulas [required]
[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
string
The formula string, which is an expression involving named queries.
queries [required]
[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries.
Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
enum
Data source for metrics queries.
Allowed enum values: metrics
name [required]
string
Name of the query for use in formulas.
query [required]
string
Metrics query definition.
query_interval_seconds
enum
The interval used when querying data, which defines the size of a time slice.
Two values are allowed: 60 (1 minute) and 300 (5 minutes).
If not provided, the value defaults to 300 (5 minutes).
Allowed enum values: 60,300
threshold [required]
double
The threshold value to which each SLI value will be compared.
tags
[string]
A list of tags associated with this service level objective.
Always included in service level objective responses (but may be empty).
Optional in create/update requests.
target_threshold
double
The target threshold such that when the service level indicator is above this
threshold over the given timeframe, the objective is being met.
thresholds [required]
[object]
The thresholds (timeframes and associated targets) for this service level
objective object.
target [required]
double
The target value for the service level indicator within the corresponding
timeframe.
target_display
string
A string representation of the target that indicates its precision.
It uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in
create/update requests.
timeframe [required]
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
warning
double
The warning value for the service level objective.
warning_display
string
A string representation of the warning target (see the description of
the target_display field for details).
Included in service level objective responses if a warning target exists.
Ignored in create/update requests.
timeframe
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
type [required]
enum
The type of the service level objective.
Allowed enum values: metric,monitor,time_slice
warning_threshold
double
The optional warning threshold such that when the service level indicator is
below this value for the given threshold, but above the target threshold, the
objective appears in a "warning" state. This value must be greater than the target
threshold.
errors
[string]
An array of error messages. Each endpoint documents how/whether this field is
used.
metadata
object
The metadata object containing additional information about the list of SLOs.
page
object
The object containing information about the pages of the list of SLOs.
total_count
int64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
int64
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.
fromdatadogimportinitialize,apioptions={'api_key':'<DATADOG_API_KEY>','app_key':'<DATADOG_APPLICATION_KEY>'}initialize(**options)# Create a new SLOthresholds=[{"timeframe":"7d","target":95},{"timeframe":"30d","target":95,"warning":97},]tags=["app:webserver","frontend"]api.ServiceLevelObjective.create(type="metric",name="Custom Metric SLO",description="SLO tracking custom service SLO",query={"numerator":"sum:my.custom.metric{type:good}.as_count()","denominator":"sum:my.custom.metric{*}.as_count()"},tags=tags,thresholds=thresholds)
require'dogapi'api_key='<DATADOG_API_KEY>'app_key='<DATADOG_APPLICATION_KEY>'dog=Dogapi::Client.new(api_key,app_key)# Create a new SLOthresholds=[{timeframe:'7d',target:95},{timeframe:'30d',target:95,warning:97}]tags=['app:webserver','frontend']dog.create_service_level_objective(type:'metric',name:'Custom Metric SLO',description:'SLO tracking custom service SLO',numerator:'sum:my.custom.metric{type:good}.as_count()',denominator:'sum:my.custom.metric{*}.as_count()',tags:tags,thresholds:thresholds)
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Create a time-slice SLO object returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);constparams: v1.ServiceLevelObjectivesApiCreateSLORequest={body:{type:"time_slice",description:"string",name:"Example-Service-Level-Objective",sliSpecification:{timeSlice:{query:{formulas:[{formula:"query1",},],queries:[{dataSource:"metrics",name:"query1",query:"trace.servlet.request{env:prod}",},],},comparator:">",threshold: 5,},},tags:["env:prod"],thresholds:[{target: 97.0,targetDisplay:"97.0",timeframe:"7d",warning: 98,warningDisplay:"98.0",},],timeframe:"7d",targetThreshold: 97.0,warningThreshold: 98,},};apiInstance.createSLO(params).then((data: v1.SLOListResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
/**
* Create an SLO object returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);constparams: v1.ServiceLevelObjectivesApiCreateSLORequest={body:{type:"metric",description:"string",groups:["env:test","role:mysql"],monitorIds:[],name:"Example-Service-Level-Objective",query:{denominator:"sum:httpservice.hits{!code:3xx}.as_count()",numerator:"sum:httpservice.hits{code:2xx}.as_count()",},tags:["env:prod","app:core"],thresholds:[{target: 97.0,targetDisplay:"97.0",timeframe:"7d",warning: 98,warningDisplay:"98.0",},],timeframe:"7d",targetThreshold: 97.0,warningThreshold: 98,},};apiInstance.createSLO(params).then((data: v1.SLOListResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
A search SLO response containing results from the search query.
Expand All
Field
Type
Description
data
object
Data from search SLO response.
attributes
object
Attributes
facets
object
Facets
all_tags
[object]
All tags associated with an SLO.
count
int64
Count
name
string
Facet
creator_name
[object]
Creator of an SLO.
count
int64
Count
name
string
Facet
env_tags
[object]
Tags with the env tag key.
count
int64
Count
name
string
Facet
service_tags
[object]
Tags with the service tag key.
count
int64
Count
name
string
Facet
slo_type
[object]
Type of SLO.
count
int64
Count
name
double
Facet
target
[object]
SLO Target
count
int64
Count
name
double
Facet
team_tags
[object]
Tags with the team tag key.
count
int64
Count
name
string
Facet
timeframe
[object]
Timeframes of SLOs.
count
int64
Count
name
string
Facet
slos
[object]
SLOs
data
object
A service level objective ID and attributes.
attributes
object
A service level objective object includes a service level indicator, thresholds
for one or more timeframes, and metadata (name, description, and tags).
all_tags
[string]
A list of tags associated with this service level objective.
Always included in service level objective responses (but may be empty).
created_at
int64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
object
The creator of the SLO
email
string
Email of the creator.
id
int64
User ID of the creator.
name
string
Name of the creator.
description
string
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).
Optional in create/update requests.
env_tags
[string]
Tags with the env tag key.
groups
[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty.
modified_at
int64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
[integer]
A list of monitor ids that defines the scope of a monitor service level
objective.
name
string
The name of the service level objective object.
overall_status
[object]
calculated status and error budget remaining.
error
string
Error message if SLO status or error budget could not be calculated.
error_budget_remaining
double
Remaining error budget of the SLO in percentage.
indexed_at
int64
timestamp (UNIX time in seconds) of when the SLO status and error budget
were calculated.
raw_error_budget_remaining
object
Error budget remaining for an SLO.
unit
string
Error budget remaining unit.
value
double
Error budget remaining value.
span_precision
int64
The amount of decimal places the SLI value is accurate to.
state
enum
State of the SLO.
Allowed enum values: breached,warning,ok,no_data
status
double
The status of the SLO.
target
double
The target of the SLO.
timeframe
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
query
object
A metric-based SLO. Required if type is metric. 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
min of all of those requests.
denominator
string
A Datadog metric query for total (valid) events.
metrics
[string]
Metric names used in the query's numerator and denominator.
This field will return null and will be implemented in the next version of this endpoint.
numerator
string
A Datadog metric query for good events.
service_tags
[string]
Tags with the service tag key.
slo_type
enum
The type of the service level objective.
Allowed enum values: metric,monitor,time_slice
status
object
Status of the SLO's primary timeframe.
calculation_error
string
Error message if SLO status or error budget could not be calculated.
error_budget_remaining
double
Remaining error budget of the SLO in percentage.
indexed_at
int64
timestamp (UNIX time in seconds) of when the SLO status and error budget
were calculated.
raw_error_budget_remaining
object
Error budget remaining for an SLO.
unit
string
Error budget remaining unit.
value
double
Error budget remaining value.
sli
double
The current service level indicator (SLI) of the SLO, also known as 'status'. This is a percentage value from 0-100 (inclusive).
span_precision
int64
The number of decimal places the SLI value is accurate to.
state
enum
State of the SLO.
Allowed enum values: breached,warning,ok,no_data
team_tags
[string]
Tags with the team tag key.
thresholds
[object]
The thresholds (timeframes and associated targets) for this service level
objective object.
target [required]
double
The target value for the service level indicator within the corresponding
timeframe.
target_display
string
A string representation of the target that indicates its precision.
It uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in
create/update requests.
timeframe [required]
enum
The SLO time window options.
Allowed enum values: 7d,30d,90d
warning
double
The warning value for the service level objective.
warning_display
string
A string representation of the warning target (see the description of
the target_display field for details).
Included in service level objective responses if a warning target exists.
Ignored in create/update requests.
id
string
A unique identifier for the service level objective object.
Always included in service level objective responses.
"""
Search for SLOs returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.service_level_objectives_apiimportServiceLevelObjectivesApi# there is a valid "slo" in the systemSLO_DATA_0_NAME=environ["SLO_DATA_0_NAME"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.search_slo(query=SLO_DATA_0_NAME,page_size=20,page_number=0,)print(response)
# Search for SLOs returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::ServiceLevelObjectivesAPI.new# there is a valid "slo" in the systemSLO_DATA_0_NAME=ENV["SLO_DATA_0_NAME"]opts={query:SLO_DATA_0_NAME,page_size:20,page_number:0,}papi_instance.search_slo(opts)
// Search for SLOs returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "slo" in the system
SloData0Name:=os.Getenv("SLO_DATA_0_NAME")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.SearchSLO(ctx,*datadogV1.NewSearchSLOOptionalParameters().WithQuery(SloData0Name).WithPageSize(20).WithPageNumber(0))iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.SearchSLO`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.SearchSLO`:\n%s\n",responseContent)}
// Search for SLOs returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi.SearchSLOOptionalParameters;importcom.datadog.api.client.v1.model.SearchSLOResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);// there is a valid "slo" in the systemStringSLO_DATA_0_NAME=System.getenv("SLO_DATA_0_NAME");try{SearchSLOResponseresult=apiInstance.searchSLO(newSearchSLOOptionalParameters().query(SLO_DATA_0_NAME).pageSize(20L).pageNumber(0L));System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#searchSLO");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Search for SLOs returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_service_level_objectives::SearchSLOOptionalParams;usedatadog_api_client::datadogV1::api_service_level_objectives::ServiceLevelObjectivesAPI;#[tokio::main]asyncfnmain(){// there is a valid "slo" in the system
letslo_data_0_name=std::env::var("SLO_DATA_0_NAME").unwrap();letconfiguration=datadog::Configuration::new();letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.search_slo(SearchSLOOptionalParams::default().query(slo_data_0_name.clone()).page_size(20).page_number(0),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Search for SLOs returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);// there is a valid "slo" in the system
constSLO_DATA_0_NAME=process.env.SLO_DATA_0_NAMEasstring;constparams: v1.ServiceLevelObjectivesApiSearchSLORequest={query: SLO_DATA_0_NAME,pageSize: 20,pageNumber: 0,};apiInstance.searchSLO(params).then((data: v1.SearchSLOResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
A response with one or more service level objective.
Expand All
Field
Type
Description
data
[object]
An array of service level objective objects.
created_at
int64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
object
Object describing the creator of the shared element.
email
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
description
string
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).
Optional in create/update requests.
groups
[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in
create/update requests for monitor service level objectives, but may only be
used when then length of the monitor_ids field is one.
id
string
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
int64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
[integer]
A list of monitor ids that defines the scope of a monitor service level
objective. Required if type is monitor.
monitor_tags
[string]
The union of monitor tags for all monitors referenced by the monitor_ids
field.
Always included in service level objective responses for monitor-based service level
objectives (but may be empty). Ignored in create/update requests. Does not
affect which monitors are included in the service level objective (that is
determined entirely by the monitor_ids field).
name [required]
string
The name of the service level objective object.
query
object
A metric-based SLO. Required if type is metric. 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
min of all of those requests.
denominator [required]
string
A Datadog metric query for total (valid) events.
numerator [required]
string
A Datadog metric query for good events.
sli_specification
<oneOf>
A generic SLI specification. This is currently used for time-slice SLOs only.
Option 1
object
A time-slice SLI specification.
time_slice [required]
object
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,
and 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
enum
The comparator used to compare the SLI value to the threshold.
Allowed enum values: >,>=,<,<=
query [required]
object
The queries and formula used to calculate the SLI value.
formulas [required]
[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
string
The formula string, which is an expression involving named queries.
queries [required]
[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries.
Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
enum
Data source for metrics queries.
Allowed enum values: metrics
name [required]
string
Name of the query for use in formulas.
query [required]
string
Metrics query definition.
query_interval_seconds
enum
The interval used when querying data, which defines the size of a time slice.
Two values are allowed: 60 (1 minute) and 300 (5 minutes).
If not provided, the value defaults to 300 (5 minutes).
Allowed enum values: 60,300
threshold [required]
double
The threshold value to which each SLI value will be compared.
tags
[string]
A list of tags associated with this service level objective.
Always included in service level objective responses (but may be empty).
Optional in create/update requests.
target_threshold
double
The target threshold such that when the service level indicator is above this
threshold over the given timeframe, the objective is being met.
thresholds [required]
[object]
The thresholds (timeframes and associated targets) for this service level
objective object.
target [required]
double
The target value for the service level indicator within the corresponding
timeframe.
target_display
string
A string representation of the target that indicates its precision.
It uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in
create/update requests.
timeframe [required]
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
warning
double
The warning value for the service level objective.
warning_display
string
A string representation of the warning target (see the description of
the target_display field for details).
Included in service level objective responses if a warning target exists.
Ignored in create/update requests.
timeframe
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
type [required]
enum
The type of the service level objective.
Allowed enum values: metric,monitor,time_slice
warning_threshold
double
The optional warning threshold such that when the service level indicator is
below this value for the given threshold, but above the target threshold, the
objective appears in a "warning" state. This value must be greater than the target
threshold.
errors
[string]
An array of error messages. Each endpoint documents how/whether this field is
used.
metadata
object
The metadata object containing additional information about the list of SLOs.
page
object
The object containing information about the pages of the list of SLOs.
total_count
int64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
int64
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.
"""
Get all SLOs returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.service_level_objectives_apiimportServiceLevelObjectivesApi# there is a valid "slo" in the systemSLO_DATA_0_ID=environ["SLO_DATA_0_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.list_slos(ids=SLO_DATA_0_ID,)print(response)
# Get all SLOs returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::ServiceLevelObjectivesAPI.new# there is a valid "slo" in the systemSLO_DATA_0_ID=ENV["SLO_DATA_0_ID"]opts={ids:SLO_DATA_0_ID,}papi_instance.list_slos(opts)
require'dogapi'api_key='<DATADOG_API_KEY>'app_key='<DATADOG_APPLICATION_KEY>'dog=Dogapi::Client.new(api_key,app_key)# Search with a list of IDsslo_ids=['<YOUR_SLO_ID>']dog.search_service_level_objective(slo_ids:slo_ids,offset:0)# Search with a query on your SLO Name.query='my team'dog.search_service_level_objective(query:query,offset:0)
// Get all SLOs returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "slo" in the system
SloData0ID:=os.Getenv("SLO_DATA_0_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.ListSLOs(ctx,*datadogV1.NewListSLOsOptionalParameters().WithIds(SloData0ID))iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.ListSLOs`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.ListSLOs`:\n%s\n",responseContent)}
// Get all SLOs returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi.ListSLOsOptionalParameters;importcom.datadog.api.client.v1.model.SLOListResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);// there is a valid "slo" in the systemStringSLO_DATA_0_ID=System.getenv("SLO_DATA_0_ID");try{SLOListResponseresult=apiInstance.listSLOs(newListSLOsOptionalParameters().ids(SLO_DATA_0_ID));System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#listSLOs");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
fromdatadogimportinitialize,apioptions={'api_key':'<DATADOG_API_KEY>','app_key':'<DATADOG_APPLICATION_KEY>'}initialize(**options)# Search with a list of IDsslo_ids=["<YOUR_SLO_ID>","<YOUR_SLO_ID>"]api.ServiceLevelObjective.get_all(ids=slo_ids,offset=0)# Search with a query on your SLO Name.query="my team"api.ServiceLevelObjective.get_all(query=query,offset=0)
// Get all SLOs returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_service_level_objectives::ListSLOsOptionalParams;usedatadog_api_client::datadogV1::api_service_level_objectives::ServiceLevelObjectivesAPI;#[tokio::main]asyncfnmain(){// there is a valid "slo" in the system
letslo_data_0_id=std::env::var("SLO_DATA_0_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.list_slos(ListSLOsOptionalParams::default().ids(slo_data_0_id.clone())).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get all SLOs returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);// there is a valid "slo" in the system
constSLO_DATA_0_ID=process.env.SLO_DATA_0_IDasstring;constparams: v1.ServiceLevelObjectivesApiListSLOsRequest={ids: SLO_DATA_0_ID,};apiInstance.listSLOs(params).then((data: v1.SLOListResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Always included in service level objective responses.
creator
object
Object describing the creator of the shared element.
email
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
description
string
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).
Optional in create/update requests.
groups
[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in
create/update requests for monitor service level objectives, but may only be
used when then length of the monitor_ids field is one.
id
string
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
int64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
[integer]
A list of monitor ids that defines the scope of a monitor service level
objective. Required if type is monitor.
monitor_tags
[string]
The union of monitor tags for all monitors referenced by the monitor_ids
field.
Always included in service level objective responses for monitor-based service level
objectives (but may be empty). Ignored in create/update requests. Does not
affect which monitors are included in the service level objective (that is
determined entirely by the monitor_ids field).
name [required]
string
The name of the service level objective object.
query
object
A metric-based SLO. Required if type is metric. 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
min of all of those requests.
denominator [required]
string
A Datadog metric query for total (valid) events.
numerator [required]
string
A Datadog metric query for good events.
sli_specification
<oneOf>
A generic SLI specification. This is currently used for time-slice SLOs only.
Option 1
object
A time-slice SLI specification.
time_slice [required]
object
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,
and 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
enum
The comparator used to compare the SLI value to the threshold.
Allowed enum values: >,>=,<,<=
query [required]
object
The queries and formula used to calculate the SLI value.
formulas [required]
[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
string
The formula string, which is an expression involving named queries.
queries [required]
[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries.
Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
enum
Data source for metrics queries.
Allowed enum values: metrics
name [required]
string
Name of the query for use in formulas.
query [required]
string
Metrics query definition.
query_interval_seconds
enum
The interval used when querying data, which defines the size of a time slice.
Two values are allowed: 60 (1 minute) and 300 (5 minutes).
If not provided, the value defaults to 300 (5 minutes).
Allowed enum values: 60,300
threshold [required]
double
The threshold value to which each SLI value will be compared.
tags
[string]
A list of tags associated with this service level objective.
Always included in service level objective responses (but may be empty).
Optional in create/update requests.
target_threshold
double
The target threshold such that when the service level indicator is above this
threshold over the given timeframe, the objective is being met.
thresholds [required]
[object]
The thresholds (timeframes and associated targets) for this service level
objective object.
target [required]
double
The target value for the service level indicator within the corresponding
timeframe.
target_display
string
A string representation of the target that indicates its precision.
It uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in
create/update requests.
timeframe [required]
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
warning
double
The warning value for the service level objective.
warning_display
string
A string representation of the warning target (see the description of
the target_display field for details).
Included in service level objective responses if a warning target exists.
Ignored in create/update requests.
timeframe
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
type [required]
enum
The type of the service level objective.
Allowed enum values: metric,monitor,time_slice
warning_threshold
double
The optional warning threshold such that when the service level indicator is
below this value for the given threshold, but above the target threshold, the
objective appears in a "warning" state. This value must be greater than the target
threshold.
A response with one or more service level objective.
Expand All
Field
Type
Description
data
[object]
An array of service level objective objects.
created_at
int64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
object
Object describing the creator of the shared element.
email
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
description
string
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).
Optional in create/update requests.
groups
[string]
A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in
create/update requests for monitor service level objectives, but may only be
used when then length of the monitor_ids field is one.
id
string
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
int64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
[integer]
A list of monitor ids that defines the scope of a monitor service level
objective. Required if type is monitor.
monitor_tags
[string]
The union of monitor tags for all monitors referenced by the monitor_ids
field.
Always included in service level objective responses for monitor-based service level
objectives (but may be empty). Ignored in create/update requests. Does not
affect which monitors are included in the service level objective (that is
determined entirely by the monitor_ids field).
name [required]
string
The name of the service level objective object.
query
object
A metric-based SLO. Required if type is metric. 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
min of all of those requests.
denominator [required]
string
A Datadog metric query for total (valid) events.
numerator [required]
string
A Datadog metric query for good events.
sli_specification
<oneOf>
A generic SLI specification. This is currently used for time-slice SLOs only.
Option 1
object
A time-slice SLI specification.
time_slice [required]
object
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,
and 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
enum
The comparator used to compare the SLI value to the threshold.
Allowed enum values: >,>=,<,<=
query [required]
object
The queries and formula used to calculate the SLI value.
formulas [required]
[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
string
The formula string, which is an expression involving named queries.
queries [required]
[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries.
Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
enum
Data source for metrics queries.
Allowed enum values: metrics
name [required]
string
Name of the query for use in formulas.
query [required]
string
Metrics query definition.
query_interval_seconds
enum
The interval used when querying data, which defines the size of a time slice.
Two values are allowed: 60 (1 minute) and 300 (5 minutes).
If not provided, the value defaults to 300 (5 minutes).
Allowed enum values: 60,300
threshold [required]
double
The threshold value to which each SLI value will be compared.
tags
[string]
A list of tags associated with this service level objective.
Always included in service level objective responses (but may be empty).
Optional in create/update requests.
target_threshold
double
The target threshold such that when the service level indicator is above this
threshold over the given timeframe, the objective is being met.
thresholds [required]
[object]
The thresholds (timeframes and associated targets) for this service level
objective object.
target [required]
double
The target value for the service level indicator within the corresponding
timeframe.
target_display
string
A string representation of the target that indicates its precision.
It uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in
create/update requests.
timeframe [required]
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
warning
double
The warning value for the service level objective.
warning_display
string
A string representation of the warning target (see the description of
the target_display field for details).
Included in service level objective responses if a warning target exists.
Ignored in create/update requests.
timeframe
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
type [required]
enum
The type of the service level objective.
Allowed enum values: metric,monitor,time_slice
warning_threshold
double
The optional warning threshold such that when the service level indicator is
below this value for the given threshold, but above the target threshold, the
objective appears in a "warning" state. This value must be greater than the target
threshold.
errors
[string]
An array of error messages. Each endpoint documents how/whether this field is
used.
metadata
object
The metadata object containing additional information about the list of SLOs.
page
object
The object containing information about the pages of the list of SLOs.
total_count
int64
The total number of resources that could be retrieved ignoring the parameters and filters in the request.
total_filtered_count
int64
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.
// Update an SLO returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "slo" in the system
SloData0ID:=os.Getenv("SLO_DATA_0_ID")SloData0Name:=os.Getenv("SLO_DATA_0_NAME")body:=datadogV1.ServiceLevelObjective{Type:datadogV1.SLOTYPE_METRIC,Name:SloData0Name,Thresholds:[]datadogV1.SLOThreshold{{Target:97.0,Timeframe:datadogV1.SLOTIMEFRAME_SEVEN_DAYS,Warning:datadog.PtrFloat64(98.0),},},Timeframe:datadogV1.SLOTIMEFRAME_SEVEN_DAYS.Ptr(),TargetThreshold:datadog.PtrFloat64(97.0),WarningThreshold:datadog.PtrFloat64(98),Query:&datadogV1.ServiceLevelObjectiveQuery{Numerator:"sum:httpservice.hits{code:2xx}.as_count()",Denominator:"sum:httpservice.hits{!code:3xx}.as_count()",},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.UpdateSLO(ctx,SloData0ID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.UpdateSLO`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.UpdateSLO`:\n%s\n",responseContent)}
// Update an SLO returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v1.model.SLOListResponse;importcom.datadog.api.client.v1.model.SLOThreshold;importcom.datadog.api.client.v1.model.SLOTimeframe;importcom.datadog.api.client.v1.model.SLOType;importcom.datadog.api.client.v1.model.ServiceLevelObjective;importcom.datadog.api.client.v1.model.ServiceLevelObjectiveQuery;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);// there is a valid "slo" in the systemStringSLO_DATA_0_ID=System.getenv("SLO_DATA_0_ID");StringSLO_DATA_0_NAME=System.getenv("SLO_DATA_0_NAME");ServiceLevelObjectivebody=newServiceLevelObjective().type(SLOType.METRIC).name(SLO_DATA_0_NAME).thresholds(Collections.singletonList(newSLOThreshold().target(97.0).timeframe(SLOTimeframe.SEVEN_DAYS).warning(98.0))).timeframe(SLOTimeframe.SEVEN_DAYS).targetThreshold(97.0).warningThreshold(98.0).query(newServiceLevelObjectiveQuery().numerator("sum:httpservice.hits{code:2xx}.as_count()").denominator("sum:httpservice.hits{!code:3xx}.as_count()"));try{SLOListResponseresult=apiInstance.updateSLO(SLO_DATA_0_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#updateSLO");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Update an SLO returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.service_level_objectives_apiimportServiceLevelObjectivesApifromdatadog_api_client.v1.model.service_level_objectiveimportServiceLevelObjectivefromdatadog_api_client.v1.model.service_level_objective_queryimportServiceLevelObjectiveQueryfromdatadog_api_client.v1.model.slo_thresholdimportSLOThresholdfromdatadog_api_client.v1.model.slo_timeframeimportSLOTimeframefromdatadog_api_client.v1.model.slo_typeimportSLOType# there is a valid "slo" in the systemSLO_DATA_0_ID=environ["SLO_DATA_0_ID"]SLO_DATA_0_NAME=environ["SLO_DATA_0_NAME"]body=ServiceLevelObjective(type=SLOType.METRIC,name=SLO_DATA_0_NAME,thresholds=[SLOThreshold(target=97.0,timeframe=SLOTimeframe.SEVEN_DAYS,warning=98.0,),],timeframe=SLOTimeframe.SEVEN_DAYS,target_threshold=97.0,warning_threshold=98.0,query=ServiceLevelObjectiveQuery(numerator="sum:httpservice.hits{code:2xx}.as_count()",denominator="sum:httpservice.hits{!code:3xx}.as_count()",),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.update_slo(slo_id=SLO_DATA_0_ID,body=body)print(response)
# Update an SLO returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::ServiceLevelObjectivesAPI.new# there is a valid "slo" in the systemSLO_DATA_0_ID=ENV["SLO_DATA_0_ID"]SLO_DATA_0_NAME=ENV["SLO_DATA_0_NAME"]body=DatadogAPIClient::V1::ServiceLevelObjective.new({type:DatadogAPIClient::V1::SLOType::METRIC,name:SLO_DATA_0_NAME,thresholds:[DatadogAPIClient::V1::SLOThreshold.new({target:97.0,timeframe:DatadogAPIClient::V1::SLOTimeframe::SEVEN_DAYS,warning:98.0,}),],timeframe:DatadogAPIClient::V1::SLOTimeframe::SEVEN_DAYS,target_threshold:97.0,warning_threshold:98,query:DatadogAPIClient::V1::ServiceLevelObjectiveQuery.new({numerator:"sum:httpservice.hits{code:2xx}.as_count()",denominator:"sum:httpservice.hits{!code:3xx}.as_count()",}),})papi_instance.update_slo(SLO_DATA_0_ID,body)
// Update an SLO returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_service_level_objectives::ServiceLevelObjectivesAPI;usedatadog_api_client::datadogV1::model::SLOThreshold;usedatadog_api_client::datadogV1::model::SLOTimeframe;usedatadog_api_client::datadogV1::model::SLOType;usedatadog_api_client::datadogV1::model::ServiceLevelObjective;usedatadog_api_client::datadogV1::model::ServiceLevelObjectiveQuery;#[tokio::main]asyncfnmain(){// there is a valid "slo" in the system
letslo_data_0_id=std::env::var("SLO_DATA_0_ID").unwrap();letslo_data_0_name=std::env::var("SLO_DATA_0_NAME").unwrap();letbody=ServiceLevelObjective::new(slo_data_0_name.clone(),vec![SLOThreshold::new(97.0,SLOTimeframe::SEVEN_DAYS).warning(98.0asf64)],SLOType::METRIC,).query(ServiceLevelObjectiveQuery::new("sum:httpservice.hits{!code:3xx}.as_count()".to_string(),"sum:httpservice.hits{code:2xx}.as_count()".to_string(),)).target_threshold(97.0asf64).timeframe(SLOTimeframe::SEVEN_DAYS).warning_threshold(98.0asf64);letconfiguration=datadog::Configuration::new();letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.update_slo(slo_data_0_id.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Update an SLO returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);// there is a valid "slo" in the system
constSLO_DATA_0_ID=process.env.SLO_DATA_0_IDasstring;constSLO_DATA_0_NAME=process.env.SLO_DATA_0_NAMEasstring;constparams: v1.ServiceLevelObjectivesApiUpdateSLORequest={body:{type:"metric",name: SLO_DATA_0_NAME,thresholds:[{target: 97.0,timeframe:"7d",warning: 98.0,},],timeframe:"7d",targetThreshold: 97.0,warningThreshold: 98,query:{numerator:"sum:httpservice.hits{code:2xx}.as_count()",denominator:"sum:httpservice.hits{!code:3xx}.as_count()",},},sloId: SLO_DATA_0_ID,};apiInstance.updateSLO(params).then((data: v1.SLOListResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
A service level objective response containing a single service level objective.
Expand All
Field
Type
Description
data
object
A service level objective object includes a service level indicator, thresholds
for one or more timeframes, and metadata (name, description, tags, etc.).
configured_alert_ids
[integer]
A list of SLO monitors IDs that reference this SLO. This field is returned only when with_configured_alert_ids parameter is true in query.
created_at
int64
Creation timestamp (UNIX time in seconds)
Always included in service level objective responses.
creator
object
Object describing the creator of the shared element.
email
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
description
string
A user-defined description of the service level objective.
Always included in service level objective responses (but may be null).
Optional in create/update requests.
groups
[string]
A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in
create/update requests for monitor service level objectives, but may only be
used when then length of the monitor_ids field is one.
id
string
A unique identifier for the service level objective object.
Always included in service level objective responses.
modified_at
int64
Modification timestamp (UNIX time in seconds)
Always included in service level objective responses.
monitor_ids
[integer]
A list of monitor ids that defines the scope of a monitor service level
objective. Required if type is monitor.
monitor_tags
[string]
The union of monitor tags for all monitors referenced by the monitor_ids
field.
Always included in service level objective responses for monitor service level
objectives (but may be empty). Ignored in create/update requests. Does not
affect which monitors are included in the service level objective (that is
determined entirely by the monitor_ids field).
name
string
The name of the service level objective object.
query
object
A metric-based SLO. Required if type is metric. 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
min of all of those requests.
denominator [required]
string
A Datadog metric query for total (valid) events.
numerator [required]
string
A Datadog metric query for good events.
sli_specification
<oneOf>
A generic SLI specification. This is currently used for time-slice SLOs only.
Option 1
object
A time-slice SLI specification.
time_slice [required]
object
The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,
and 3. the threshold. Optionally, a fourth part, the query interval, can be provided.
comparator [required]
enum
The comparator used to compare the SLI value to the threshold.
Allowed enum values: >,>=,<,<=
query [required]
object
The queries and formula used to calculate the SLI value.
formulas [required]
[object]
A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
formula [required]
string
The formula string, which is an expression involving named queries.
queries [required]
[ <oneOf>]
A list of queries that are used to calculate the SLI value.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries.
Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
data_source [required]
enum
Data source for metrics queries.
Allowed enum values: metrics
name [required]
string
Name of the query for use in formulas.
query [required]
string
Metrics query definition.
query_interval_seconds
enum
The interval used when querying data, which defines the size of a time slice.
Two values are allowed: 60 (1 minute) and 300 (5 minutes).
If not provided, the value defaults to 300 (5 minutes).
Allowed enum values: 60,300
threshold [required]
double
The threshold value to which each SLI value will be compared.
tags
[string]
A list of tags associated with this service level objective.
Always included in service level objective responses (but may be empty).
Optional in create/update requests.
target_threshold
double
The target threshold such that when the service level indicator is above this
threshold over the given timeframe, the objective is being met.
thresholds
[object]
The thresholds (timeframes and associated targets) for this service level
objective object.
target [required]
double
The target value for the service level indicator within the corresponding
timeframe.
target_display
string
A string representation of the target that indicates its precision.
It uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in
create/update requests.
timeframe [required]
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
warning
double
The warning value for the service level objective.
warning_display
string
A string representation of the warning target (see the description of
the target_display field for details).
Included in service level objective responses if a warning target exists.
Ignored in create/update requests.
timeframe
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
type
enum
The type of the service level objective.
Allowed enum values: metric,monitor,time_slice
warning_threshold
double
The optional warning threshold such that when the service level indicator is
below this value for the given threshold, but above the target threshold, the
objective appears in a "warning" state. This value must be greater than the target
threshold.
errors
[string]
An array of error messages. Each endpoint documents how/whether this field is
used.
"""
Get an SLO's details returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.service_level_objectives_apiimportServiceLevelObjectivesApi# there is a valid "slo" in the systemSLO_DATA_0_ID=environ["SLO_DATA_0_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.get_slo(slo_id=SLO_DATA_0_ID,)print(response)
# Get an SLO's details returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::ServiceLevelObjectivesAPI.new# there is a valid "slo" in the systemSLO_DATA_0_ID=ENV["SLO_DATA_0_ID"]papi_instance.get_slo(SLO_DATA_0_ID)
// Get an SLO's details returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "slo" in the system
SloData0ID:=os.Getenv("SLO_DATA_0_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.GetSLO(ctx,SloData0ID,*datadogV1.NewGetSLOOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.GetSLO`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.GetSLO`:\n%s\n",responseContent)}
// Get an SLO's details returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v1.model.SLOResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);// there is a valid "slo" in the systemStringSLO_DATA_0_ID=System.getenv("SLO_DATA_0_ID");try{SLOResponseresult=apiInstance.getSLO(SLO_DATA_0_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#getSLO");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get an SLO's details returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_service_level_objectives::GetSLOOptionalParams;usedatadog_api_client::datadogV1::api_service_level_objectives::ServiceLevelObjectivesAPI;#[tokio::main]asyncfnmain(){// there is a valid "slo" in the system
letslo_data_0_id=std::env::var("SLO_DATA_0_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.get_slo(slo_data_0_id.clone(),GetSLOOptionalParams::default()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get an SLO's details returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);// there is a valid "slo" in the system
constSLO_DATA_0_ID=process.env.SLO_DATA_0_IDasstring;constparams: v1.ServiceLevelObjectivesApiGetSLORequest={sloId: SLO_DATA_0_ID,};apiInstance.getSLO(params).then((data: v1.SLOResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
"""
Delete an SLO returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.service_level_objectives_apiimportServiceLevelObjectivesApi# there is a valid "slo" in the systemSLO_DATA_0_ID=environ["SLO_DATA_0_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.delete_slo(slo_id=SLO_DATA_0_ID,)print(response)
# Delete an SLO returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::ServiceLevelObjectivesAPI.new# there is a valid "slo" in the systemSLO_DATA_0_ID=ENV["SLO_DATA_0_ID"]papi_instance.delete_slo(SLO_DATA_0_ID)
// Delete an SLO returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "slo" in the system
SloData0ID:=os.Getenv("SLO_DATA_0_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.DeleteSLO(ctx,SloData0ID,*datadogV1.NewDeleteSLOOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.DeleteSLO`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.DeleteSLO`:\n%s\n",responseContent)}
// Delete an SLO returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v1.model.SLODeleteResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);// there is a valid "slo" in the systemStringSLO_DATA_0_ID=System.getenv("SLO_DATA_0_ID");try{SLODeleteResponseresult=apiInstance.deleteSLO(SLO_DATA_0_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#deleteSLO");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Delete an SLO returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_service_level_objectives::DeleteSLOOptionalParams;usedatadog_api_client::datadogV1::api_service_level_objectives::ServiceLevelObjectivesAPI;#[tokio::main]asyncfnmain(){// there is a valid "slo" in the system
letslo_data_0_id=std::env::var("SLO_DATA_0_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.delete_slo(slo_data_0_id.clone(),DeleteSLOOptionalParams::default()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Delete an SLO returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);// there is a valid "slo" in the system
constSLO_DATA_0_ID=process.env.SLO_DATA_0_IDasstring;constparams: v1.ServiceLevelObjectivesApiDeleteSLORequest={sloId: SLO_DATA_0_ID,};apiInstance.deleteSLO(params).then((data: v1.SLODeleteResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Get a specific SLO’s history, regardless of its SLO type.
The detailed history data is structured according to the source data type.
For example, metric data is included for event SLOs that use
the metric source, and monitor SLO types include the monitor transition history.
Note: There are different response formats for event based and time based SLOs.
Examples of both are shown.
This endpoint requires the slos_read permission.
OAuth apps require the slos_read authorization scope to access this endpoint.
Arguments
Path Parameters
Name
Type
Description
slo_id [required]
string
The ID of the service level objective object.
Query Strings
Name
Type
Description
from_ts [required]
integer
The from timestamp for the query window in epoch seconds.
to_ts [required]
integer
The to timestamp for the query window in epoch seconds.
target
number
The SLO target. If target is passed in, the response will include the remaining error budget and a timeframe value of custom.
apply_correction
boolean
Defaults to true. If any SLO corrections are applied and this parameter is set to false,
then the corrections will not be applied and the SLI values will not be affected.
For metric based SLOs where the query includes a group-by clause, this represents the list of grouping parameters.
This is not included in responses for monitor based SLOs.
groups
[object]
For grouped SLOs, this represents SLI data for specific groups.
This is not included in the responses for metric based SLOs.
error_budget_remaining
object
A mapping of threshold timeframe to the remaining error budget.
<any-key>
double
Remaining error budget.
errors
[object]
An array of error objects returned while querying the history data for the service level objective.
error_message [required]
string
A message with more details about the error.
error_type [required]
string
Type of the error.
group
string
For groups in a grouped SLO, this is the group name.
history
[array]
The state transition history for the monitor. It is represented as
an array of pairs. Each pair is an array containing the timestamp of the transition
as an integer in Unix epoch format in the first element, and the state as an integer in the
second element. An integer value of 0 for state means uptime, 1 means downtime, and 2 means no data.
Periods of no data are counted either as uptime or downtime depending on monitor settings.
See SLO documentation
for detailed information.
monitor_modified
int64
For monitor based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
monitor_type
string
For monitor based SLOs, this describes the type of monitor.
name
string
For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.
precision
double
DEPRECATED: The amount of decimal places the SLI value is accurate to for the given from && to timestamp. Use span_precision instead.
preview
boolean
For monitor based SLOs, when true this indicates that a replay is in progress to give an accurate uptime
calculation.
sli_value
double
The current SLI value of the SLO over the history window.
span_precision
double
The amount of decimal places the SLI value is accurate to for the given from && to timestamp.
uptime
double
DEPRECATED: Use sli_value instead.
monitors
[object]
For multi-monitor SLOs, this represents SLI data for specific monitors.
This is not included in the responses for metric based SLOs.
error_budget_remaining
object
A mapping of threshold timeframe to the remaining error budget.
<any-key>
double
Remaining error budget.
errors
[object]
An array of error objects returned while querying the history data for the service level objective.
error_message [required]
string
A message with more details about the error.
error_type [required]
string
Type of the error.
group
string
For groups in a grouped SLO, this is the group name.
history
[array]
The state transition history for the monitor. It is represented as
an array of pairs. Each pair is an array containing the timestamp of the transition
as an integer in Unix epoch format in the first element, and the state as an integer in the
second element. An integer value of 0 for state means uptime, 1 means downtime, and 2 means no data.
Periods of no data are counted either as uptime or downtime depending on monitor settings.
See SLO documentation
for detailed information.
monitor_modified
int64
For monitor based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
monitor_type
string
For monitor based SLOs, this describes the type of monitor.
name
string
For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.
precision
double
DEPRECATED: The amount of decimal places the SLI value is accurate to for the given from && to timestamp. Use span_precision instead.
preview
boolean
For monitor based SLOs, when true this indicates that a replay is in progress to give an accurate uptime
calculation.
sli_value
double
The current SLI value of the SLO over the history window.
span_precision
double
The amount of decimal places the SLI value is accurate to for the given from && to timestamp.
uptime
double
DEPRECATED: Use sli_value instead.
overall
object
An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value.
This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.
error_budget_remaining
object
A mapping of threshold timeframe to the remaining error budget.
<any-key>
double
Remaining error budget.
errors
[object]
An array of error objects returned while querying the history data for the service level objective.
error_message [required]
string
A message with more details about the error.
error_type [required]
string
Type of the error.
group
string
For groups in a grouped SLO, this is the group name.
history
[array]
The state transition history for monitor or time-slice SLOs. It is represented as
an array of pairs. Each pair is an array containing the timestamp of the transition
as an integer in Unix epoch format in the first element, and the state as an integer in the
second element. An integer value of 0 for state means uptime, 1 means downtime, and 2 means no data.
Periods of no data count as uptime in time-slice SLOs, while for monitor SLOs, no data is counted
either as uptime or downtime depending on monitor settings. See
SLO documentation
for detailed information.
monitor_modified
int64
For monitor based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
monitor_type
string
For monitor based SLOs, this describes the type of monitor.
name
string
For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.
precision
object
A mapping of threshold timeframe to number of accurate decimals, regardless of the from && to timestamp.
<any-key>
double
The number of accurate decimals.
preview
boolean
For monitor based SLOs, when true this indicates that a replay is in progress to give an accurate uptime
calculation.
sli_value
double
The current SLI value of the SLO over the history window.
span_precision
double
The amount of decimal places the SLI value is accurate to for the given from && to timestamp.
uptime
double
DEPRECATED: Use sli_value instead.
series
object
A metric based SLO history response.
This is not included in responses for monitor based SLOs.
denominator [required]
object
A representation of metric based SLO timeseries for the provided queries.
This is the same response type from batch_query endpoint.
count [required]
int64
Count of submitted metrics.
metadata
object
Query metadata.
aggr
string
Query aggregator function.
expression
string
Query expression.
metric
string
Query metric used.
query_index
int64
Query index from original combined query.
scope
string
Query scope.
unit
[object]
An array of metric units that contains up to two unit objects.
For example, bytes represents one unit object and bytes per second represents two unit objects.
If a metric query only has one unit object, the second array element is null.
family
string
The family of metric unit, for example bytes is the family for kibibyte, byte, and bit units.
id
int64
The ID of the metric unit.
name
string
The unit of the metric, for instance byte.
plural
string
The plural Unit of metric, for instance bytes.
scale_factor
double
The scale factor of metric unit, for instance 1.0.
short_name
string
A shorter and abbreviated version of the metric unit, for instance B.
sum [required]
double
Total sum of the query.
values [required]
[number]
The query values for each metric.
interval [required]
int64
The aggregated query interval for the series data. It's implicit based on the query time window.
message
string
Optional message if there are specific query issues/warnings.
numerator [required]
object
A representation of metric based SLO timeseries for the provided queries.
This is the same response type from batch_query endpoint.
count [required]
int64
Count of submitted metrics.
metadata
object
Query metadata.
aggr
string
Query aggregator function.
expression
string
Query expression.
metric
string
Query metric used.
query_index
int64
Query index from original combined query.
scope
string
Query scope.
unit
[object]
An array of metric units that contains up to two unit objects.
For example, bytes represents one unit object and bytes per second represents two unit objects.
If a metric query only has one unit object, the second array element is null.
family
string
The family of metric unit, for example bytes is the family for kibibyte, byte, and bit units.
id
int64
The ID of the metric unit.
name
string
The unit of the metric, for instance byte.
plural
string
The plural Unit of metric, for instance bytes.
scale_factor
double
The scale factor of metric unit, for instance 1.0.
short_name
string
A shorter and abbreviated version of the metric unit, for instance B.
sum [required]
double
Total sum of the query.
values [required]
[number]
The query values for each metric.
query [required]
string
The combined numerator and denominator query CSV.
res_type [required]
string
The series result type. This mimics batch_query response type.
resp_version [required]
int64
The series response version type. This mimics batch_query response type.
times [required]
[number]
An array of query timestamps in EPOCH milliseconds.
thresholds
object
mapping of string timeframe to the SLO threshold.
<any-key>
object
SLO thresholds (target and optionally warning) for a single time window.
target [required]
double
The target value for the service level indicator within the corresponding
timeframe.
target_display
string
A string representation of the target that indicates its precision.
It uses trailing zeros to show significant decimal places (for example 98.00).
Always included in service level objective responses. Ignored in
create/update requests.
timeframe [required]
enum
The SLO time window options. Note that "custom" is not a valid option for creating
or updating SLOs. It is only used when querying SLO history over custom timeframes.
Allowed enum values: 7d,30d,90d,custom
warning
double
The warning value for the service level objective.
warning_display
string
A string representation of the warning target (see the description of
the target_display field for details).
Included in service level objective responses if a warning target exists.
Ignored in create/update requests.
to_ts
int64
The to timestamp in epoch seconds.
type
enum
The type of the service level objective.
Allowed enum values: metric,monitor,time_slice
type_id
enum
A numeric representation of the type of the service level objective (0 for
monitor, 1 for metric). Always included in service level objective responses.
Ignored in create/update requests.
Allowed enum values: 0,1,2
errors
[object]
A list of errors while querying the history data for the service level objective.
"""
Get an SLO's history returns "OK" response
"""fromdatetimeimportdatetimefromdateutil.relativedeltaimportrelativedeltafromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.service_level_objectives_apiimportServiceLevelObjectivesApi# there is a valid "slo" in the systemSLO_DATA_0_ID=environ["SLO_DATA_0_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.get_slo_history(slo_id=SLO_DATA_0_ID,from_ts=int((datetime.now()+relativedelta(days=-1)).timestamp()),to_ts=int(datetime.now().timestamp()),)print(response)
# Get an SLO's history returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::ServiceLevelObjectivesAPI.new# there is a valid "slo" in the systemSLO_DATA_0_ID=ENV["SLO_DATA_0_ID"]papi_instance.get_slo_history(SLO_DATA_0_ID,(Time.now+-1*86400).to_i,Time.now.to_i)
// Get an SLO's history returns "OK" response
packagemainimport("context""encoding/json""fmt""os""time""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "slo" in the system
SloData0ID:=os.Getenv("SLO_DATA_0_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.GetSLOHistory(ctx,SloData0ID,time.Now().AddDate(0,0,-1).Unix(),time.Now().Unix(),*datadogV1.NewGetSLOHistoryOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.GetSLOHistory`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.GetSLOHistory`:\n%s\n",responseContent)}
// Get an SLO's history returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v1.model.SLOHistoryResponse;importjava.time.OffsetDateTime;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);// there is a valid "slo" in the systemStringSLO_DATA_0_ID=System.getenv("SLO_DATA_0_ID");try{SLOHistoryResponseresult=apiInstance.getSLOHistory(SLO_DATA_0_ID,OffsetDateTime.now().plusDays(-1).toInstant().getEpochSecond(),OffsetDateTime.now().toInstant().getEpochSecond());System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#getSLOHistory");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get an SLO's history returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_service_level_objectives::GetSLOHistoryOptionalParams;usedatadog_api_client::datadogV1::api_service_level_objectives::ServiceLevelObjectivesAPI;#[tokio::main]asyncfnmain(){// there is a valid "slo" in the system
letslo_data_0_id=std::env::var("SLO_DATA_0_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.get_slo_history(slo_data_0_id.clone(),1636542671,1636629071,GetSLOHistoryOptionalParams::default(),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get an SLO's history returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);// there is a valid "slo" in the system
constSLO_DATA_0_ID=process.env.SLO_DATA_0_IDasstring;constparams: v1.ServiceLevelObjectivesApiGetSLOHistoryRequest={sloId: SLO_DATA_0_ID,fromTs: Math.round(newDate(newDate().getTime()+-1*86400*1000).getTime()/1000),toTs: Math.round(newDate().getTime()/1000),};apiInstance.getSLOHistory(params).then((data: v1.SLOHistoryResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
"""
Get Corrections For an SLO returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.service_level_objectives_apiimportServiceLevelObjectivesApi# there is a valid "slo" in the systemSLO_DATA_0_ID=environ["SLO_DATA_0_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.get_slo_corrections(slo_id=SLO_DATA_0_ID,)print(response)
# Get Corrections For an SLO returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::ServiceLevelObjectivesAPI.new# there is a valid "slo" in the systemSLO_DATA_0_ID=ENV["SLO_DATA_0_ID"]papi_instance.get_slo_corrections(SLO_DATA_0_ID)
// Get Corrections For an SLO returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "slo" in the system
SloData0ID:=os.Getenv("SLO_DATA_0_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.GetSLOCorrections(ctx,SloData0ID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.GetSLOCorrections`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.GetSLOCorrections`:\n%s\n",responseContent)}
// Get Corrections For an SLO returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v1.model.SLOCorrectionListResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);// there is a valid "slo" in the systemStringSLO_DATA_0_ID=System.getenv("SLO_DATA_0_ID");try{SLOCorrectionListResponseresult=apiInstance.getSLOCorrections(SLO_DATA_0_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#getSLOCorrections");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get Corrections For an SLO returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_service_level_objectives::ServiceLevelObjectivesAPI;#[tokio::main]asyncfnmain(){// there is a valid "slo" in the system
letslo_data_0_id=std::env::var("SLO_DATA_0_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.get_slo_corrections(slo_data_0_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get Corrections For an SLO returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);// there is a valid "slo" in the system
constSLO_DATA_0_ID=process.env.SLO_DATA_0_IDasstring;constparams: v1.ServiceLevelObjectivesApiGetSLOCorrectionsRequest={sloId: SLO_DATA_0_ID,};apiInstance.getSLOCorrections(params).then((data: v1.SLOCorrectionListResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Check if an SLO can be safely deleted. For example,
assure an SLO can be deleted without disrupting a dashboard.
This endpoint requires the slos_read permission.
OAuth apps require the slos_read authorization scope to access this endpoint.
Arguments
Query Strings
Name
Type
Description
ids [required]
string
A comma separated list of the IDs of the service level objectives objects.
"""
Check if SLOs can be safely deleted returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.service_level_objectives_apiimportServiceLevelObjectivesApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.check_can_delete_slo(ids="ids",)print(response)
# Check if SLOs can be safely deleted returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::ServiceLevelObjectivesAPI.newpapi_instance.check_can_delete_slo("ids")
// Check if SLOs can be safely deleted returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.CheckCanDeleteSLO(ctx,"ids")iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.CheckCanDeleteSLO`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.CheckCanDeleteSLO`:\n%s\n",responseContent)}
// Check if SLOs can be safely deleted returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v1.model.CheckCanDeleteSLOResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);try{CheckCanDeleteSLOResponseresult=apiInstance.checkCanDeleteSLO("ids");System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#checkCanDeleteSLO");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Check if SLOs can be safely deleted returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_service_level_objectives::ServiceLevelObjectivesAPI;#[tokio::main]asyncfnmain(){letconfiguration=datadog::Configuration::new();letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.check_can_delete_slo("ids".to_string()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Check if SLOs can be safely deleted returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);constparams: v1.ServiceLevelObjectivesApiCheckCanDeleteSLORequest={ids:"ids",};apiInstance.checkCanDeleteSLO(params).then((data: v1.CheckCanDeleteSLOResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Delete (or partially delete) multiple service level objective objects.
This endpoint facilitates deletion of one or more thresholds for one or more
service level objective objects. If all thresholds are deleted, the service level
objective object is deleted as well.
This endpoint requires the slos_write permission.
OAuth apps require the slos_write authorization scope to access this endpoint.
Request
Body Data (required)
Delete multiple service level objective objects request body.
The bulk partial delete service level objective object endpoint
response.
This endpoint operates on multiple service level objective objects, so
it may be partially successful. In such cases, the “data” and “error”
fields in this response indicate which deletions succeeded and failed.
Expand All
Field
Type
Description
data
object
An array of service level objective objects.
deleted
[string]
An array of service level objective object IDs that indicates
which objects that were completely deleted.
updated
[string]
An array of service level objective object IDs that indicates
which objects that were modified (objects for which at least one
threshold was deleted, but that were not completely deleted).
errors
[object]
Array of errors object returned.
id [required]
string
The ID of the service level objective object associated with
this error.
message [required]
string
The error message.
timeframe [required]
enum
The timeframe of the threshold associated with this error
or "all" if all thresholds are affected.
Allowed enum values: 7d,30d,90d,all
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Bulk Delete SLO Timeframes returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.ServiceLevelObjectivesApi(configuration);constparams: v1.ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest={body:{id1:["7d","30d"],id2:["7d","30d"],},};apiInstance.deleteSLOTimeframeInBulk(params).then((data: v1.SLOBulkDeleteResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Create a job to generate an SLO report. The report job is processed asynchronously and eventually results in a CSV report being available for download.
Check the status of the job and download the CSV report using the returned report_id.
This endpoint requires the slos_read permission.
OAuth apps require the slos_read authorization scope to access this endpoint.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Create a new SLO report returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.createSLOReportJob"]=true;constapiInstance=newv2.ServiceLevelObjectivesApi(configuration);constparams: v2.ServiceLevelObjectivesApiCreateSLOReportJobRequest={body:{data:{attributes:{fromTs: Math.round(newDate(newDate().getTime()+-40*86400*1000).getTime()/1000),toTs: Math.round(newDate().getTime()/1000),query:`slo_type:metric "SLO Reporting Test"`,interval:"monthly",timezone:"America/New_York",},},},};apiInstance.createSLOReportJob(params).then((data: v2.SLOReportPostResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
"""
Get SLO report status returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.service_level_objectives_apiimportServiceLevelObjectivesApi# there is a valid "report" in the systemREPORT_DATA_ID=environ["REPORT_DATA_ID"]configuration=Configuration()configuration.unstable_operations["get_slo_report_job_status"]=TruewithApiClient(configuration)asapi_client:api_instance=ServiceLevelObjectivesApi(api_client)response=api_instance.get_slo_report_job_status(report_id=REPORT_DATA_ID,)print(response)
# Get SLO report status returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.get_slo_report_job_status".to_sym]=trueendapi_instance=DatadogAPIClient::V2::ServiceLevelObjectivesAPI.new# there is a valid "report" in the systemREPORT_DATA_ID=ENV["REPORT_DATA_ID"]papi_instance.get_slo_report_job_status(REPORT_DATA_ID)
// Get SLO report status returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){// there is a valid "report" in the system
ReportDataID:=os.Getenv("REPORT_DATA_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.GetSLOReportJobStatus",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewServiceLevelObjectivesApi(apiClient)resp,r,err:=api.GetSLOReportJobStatus(ctx,ReportDataID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceLevelObjectivesApi.GetSLOReportJobStatus`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceLevelObjectivesApi.GetSLOReportJobStatus`:\n%s\n",responseContent)}
// Get SLO report status returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ServiceLevelObjectivesApi;importcom.datadog.api.client.v2.model.SLOReportStatusGetResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.getSLOReportJobStatus",true);ServiceLevelObjectivesApiapiInstance=newServiceLevelObjectivesApi(defaultClient);// there is a valid "report" in the systemStringREPORT_DATA_ID=System.getenv("REPORT_DATA_ID");try{SLOReportStatusGetResponseresult=apiInstance.getSLOReportJobStatus(REPORT_DATA_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceLevelObjectivesApi#getSLOReportJobStatus");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get SLO report status returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_service_level_objectives::ServiceLevelObjectivesAPI;#[tokio::main]asyncfnmain(){// there is a valid "report" in the system
letreport_data_id=std::env::var("REPORT_DATA_ID").unwrap();letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetSLOReportJobStatus",true);letapi=ServiceLevelObjectivesAPI::with_config(configuration);letresp=api.get_slo_report_job_status(report_data_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get SLO report status returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.getSLOReportJobStatus"]=true;constapiInstance=newv2.ServiceLevelObjectivesApi(configuration);// there is a valid "report" in the system
constREPORT_DATA_ID=process.env.REPORT_DATA_IDasstring;constparams: v2.ServiceLevelObjectivesApiGetSLOReportJobStatusRequest={reportId: REPORT_DATA_ID,};apiInstance.getSLOReportJobStatus(params).then((data: v2.SLOReportStatusGetResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get SLO report returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.getSLOReport"]=true;constapiInstance=newv2.ServiceLevelObjectivesApi(configuration);constparams: v2.ServiceLevelObjectivesApiGetSLOReportRequest={reportId:"9fb2dc2a-ead0-11ee-a174-9fe3a9d7627f",};apiInstance.getSLOReport(params).then((data: string)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
