Start an SLO evaluation in Dynatrace with the SLO API by sending the evaluation request, including timeframe, segments, and timeout settings.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/slo/v1/slos/evaluation:start |
You send id, filterSegments, customTimeframe, and requestTimeoutMilliseconds in the request body to start the evaluation. The response returns an SLO evaluation result.
To execute this request, you need a platform token or OAuth access token with slo:slos:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Slo | - | body | Required |
SloEvaluationRequest object| Element | Type | Description | Required |
|---|---|---|---|
| id | string | - | Required |
| filterSegments | Filter | Filter segments to apply during this evaluation. The effective filter for each segment is the intersection of the segment defined on the SLO and the segment provided here. If only one side defines a segment, that segment is used as-is. | Optional |
| customTimeframe | Timeframe | - | Optional |
| requestTimeoutMilliseconds | integer | How long to wait for the evaluation result before returning in milliseconds. If the evaluation finishes within this time, the result is returned directly ( | Optional |
FilterSegment objectA filter segment is identified by an ID.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The identifier of the filter segment. | Required |
| variables | Filter | - | Optional |
FilterSegmentVariable objectDefines a variable with a name and a list of values.
| Element | Type | Description | Required |
|---|---|---|---|
| name | string | The name of the variable. | Required |
| values | string[] | The list of values for this variable. | Required |
Timeframe object| Element | Type | Description | Required |
|---|---|---|---|
| timeframeFrom | string | The start of the timeframe. Supports relative time expressions (e.g. | Required |
| timeframeTo | string | The end of the timeframe. Supports relative time expressions (e.g. | Optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"id": "A5LTU5YTVjNTcxODI5OL7vVN4V2t6t","filterSegments": [{"id": "Frbo6TNENSC","variables": [{"name": "environment","values": ["production"]},{"name": "region","values": ["us-east-1","eu-west-1"]}]}],"customTimeframe": {"timeframeFrom": "now-7d","timeframeTo": "now"},"requestTimeoutMilliseconds": 1000}
| Code | Type | Description |
|---|---|---|
| 200 | Metadata | SLO evaluation result |
| 202 | Metadata | SLO evaluation started |
| 400 | - | - |
| 401 | - | - |
| 403 | - | - |
| 429 | - | - |
| 5XX | - | - |
MetadataResponse object| Element | Type | Description |
|---|---|---|
| evaluationToken | string | Token to pass to |
| ttlSeconds | integer | - |
{"evaluationToken": "FQ5aVZERXZNMjR1SzVnPT0ifQ==","ttlSeconds": 300}