Service level objectives API - GET all SLOs

Lists all service level objectives and their calculated values.

By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:

Set the timeFrame parameter to GTF.
Provide the timeframe in from and to parameters.

The request produces an application/json payload.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/v2/slo SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/slo Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/slo

Authentication

To execute this request, you need the Read SLO (slo.read) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.	query	optional
pageSize	integer	The amount of SLOs in a single response payload. The maximal allowed page size is 10000. If not set, 10 is used.	query	optional
from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week. You can also specify relative timeframe without an alignment: `now-NU`. Supported time units for the relative timeframe are: `m`: minutes `h`: hours `d`: days `w`: weeks `M`: months `y`: years If not set, the relative timeframe of two weeks is used (`now-2w`).	query	optional
to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week. You can also specify relative timeframe without an alignment: `now-NU`. Supported time units for the relative timeframe are: `m`: minutes `h`: hours `d`: days `w`: weeks `M`: months `y`: years If not set, the current timestamp is used.	query	optional
sloSelector	string	The scope of the query. Only SLOs matching the provided criteria are included in the response. You can add one or several of the criteria listed below. ID: id("id"). Filters for an SLO with the given ID. Name: name("name"). Filters for an SLO with the given name. The filter is case-sensitive. Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state. Text: text("value"). Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive. To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/slo?sloSelector=name("Service Availability"), .../api/v2/slo?sloSelector=id("id"), .../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").	query	optional
sort	string	The sorting of SLO entries: `name`: Names in ascending order. `-name`: Names in descending order. If not set, the ascending order is used.	query	optional
timeFrame	string	The timeframe to calculate the SLO values: `CURRENT`: SLO's own timeframe. `GTF`: timeframe specified by from and to parameters. If not set, the `CURRENT` value is used. The element can hold these values CURRENT GTF	query	optional
pageIdx	integer	Only SLOs on the given page are included in the response. The first page has the index '1'.	query	optional
demo	boolean	Get your SLOs (`false`) or a set of demo SLOs (`true`).	query	optional
evaluate	boolean	Get your SLOs without them being evaluated (`false`) or with evaluations (`true`) with maximum `pageSize` of 25.	query	optional
enabledSlos	boolean	Get your enabled SLOs (`true`) or disabled ones (`false`)	query	optional

Response

Response codes

Code	Description
200	Success. The response contains the parameters and calculated values of the requested SLO.
400	Failed. The input is invalid.

Response body

Response parametersJSON model

The SLOs object

A list of SLOs.

Element	Type	Description
slo	SLO[]	A list of SLOs.
totalCount	integer	The total number of entries in the result.
nextPageKey	string	The cursor for the next page of results. Has the value of `null` on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	integer	The number of entries per page.

The SLO object

Parameters of a service-level objective (SLO).

Element	Type	Description
metricDenominator	string	The total count metric (the denominator in rate calculation). Required when the useRateMetric is set to `false`.
evaluationType	string	The evaluation type of the SLO. The element can hold these values AGGREGATE
numeratorValue	number	The numerator value used to evaluate the SLO when useRateMetric is set to `false`.
denominatorValue	number	The denominator value used to evaluate the SLO when useRateMetric is set to `false`.
relatedOpenProblems	integer	Number of OPEN problems related to the SLO. Has the value of `-1` if there's an error with fetching SLO related problems.
relatedTotalProblems	integer	Total number of problems related to the SLO. Has the value of `-1` if there's an error with fetching SLO related problems.
metricExpression	string	The percentage-based metric expression for the calculation of the SLO.
useRateMetric	boolean	The type of the metric to use for SLO calculation: `true`: An existing percentage-based metric. `false`: A ratio of two metrics. For a list of available metrics, see Built-in metric page or try the GET metrics API call.
metricRate	string	The percentage-based metric for the calculation of the SLO. Required when the useRateMetric is set to `true`.
metricNumerator	string	The metric for the count of successes (the numerator in rate calculation). Required when the useRateMetric is set to `false`.
errorBudget	number	The error budget of the calculated SLO. The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.
evaluatedPercentage	number	The calculated value of the SLO. Has the value of `-1` if there's an error with SLO calculation; in that case check the value of the error parameter.
timeframe	string	The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
name	string	The name of the SLO.
id	string	The ID of the SLO
target	number	The target value of the SLO.
description	string	A short description of the SLO.
filter	string	The entity filter for the SLO evaluation. Use the syntax of entity selector.
enabled	boolean	The SLO is enabled (`true`) or disabled (`false`).
status	string	The status of the calculated SLO. The element can hold these values FAILURE SUCCESS WARNING
warning	number	The warning value of the SLO. At warning state the SLO is still fulfilled but is getting close to failure.
error	string	The error of the SLO calculation. If the value differs from `NONE` there's something wrong with the SLO calculation. The element can hold these values EVALUATION_TIMEFRAME_OUT_OF_BOUNDS FILTER_MATCHES_IN_CONDITION_LIMIT_EXCEEDED INTERNAL_ERROR INVALID_ENTITY_SELECTOR INVALID_METRIC_SELECTOR INVALID_TIMEFRAME MANAGEMENT_ZONE_INVALID METRIC_EXPRESSION_NOT_RESOLVED METRIC_EXPRESSION_NO_DATA METRIC_EXPRESSION_NO_DATA_POINTS METRIC_GENERIC_TSM_FAULT METRIC_TOO_MANY_RESULTS NONE NO_MANAGEMENT_ZONE_SELECTED

    {
  "slo": [
    {
      "metricDenominator": "builtin:service.requestCount.total",
      "evaluationType": "AGGREGATE",
      "numeratorValue": 80,
      "denominatorValue": 90,
      "relatedOpenProblems": 1,
      "relatedTotalProblems": 1,
      "metricExpression": "(100)*(builtin:service.errors.server.successCount)/(builtin:service.errors.server.totalCount)",
      "useRateMetric": true,
      "metricRate": "builtin:service.successes.server.rate",
      "metricNumerator": "builtin:service.errors.server.successCount",
      "errorBudget": 1.25,
      "evaluatedPercentage": 96.25,
      "timeframe": "-1d",
      "name": "Payment service availability",
      "id": "123e4567-e89b-42d3-a456-556642440000",
      "target": 95,
      "description": "Check the SLO for our payment service",
      "filter": "type(\"HOST\")",
      "enabled": true,
      "status": "WARNING",
      "warning": 97.5,
      "error": "NONE"
    }
  ],
  "totalCount": 1,
  "nextPageKey": "AQAAABQBAAAABQ==",
  "pageSize": 1
}