Problems API v2 - GET problems list
Lists the problems (and their details) observed by Dynatrace during a relative period of time.
A problem is included in the response if either the start or end timestamp of the problem is within the defined timeframe.
You can narrow down the output by specifying filtering criteria—see the Parameters section.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/problems |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/problems |
Authentication
To execute this request, you need an access token with problems.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
fields | string | A list of additional problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response):
To add properties, specify them as a comma-separated list (for example, The field is valid only for the current page of results. You must set it for each page you're requesting. | query | optional |
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 except the optional fields parameter. | query | optional |
pageSize | integer | The amount of problems in a single response payload. The maximal allowed page size is 500. If not set, 50 is used. | query | optional |
from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two hours is used ( | query | optional |
to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. | query | optional |
problemSelector | string | Defines the scope of the query. Only problems matching the specified criteria are included into response. You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies. All values must be quoted.
To set several criteria, separate them with a comma ( | query | optional |
entitySelector | string | The entity scope of the query. You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. The maximum number of entities that may be selected is limited to 10000. | query | optional |
sort | string | Specifies a set of comma-separated ( You can sort by the following properties with a sign prefix for the sorting order.
If no prefix is set, You can specify several levels of sorting. For example, | query | optional |
Response
Some JSON models vary depending on the type of the model. To find all the possible variations, refer to JSON models.
Response codes
Code | Type | Description |
---|---|---|
200 | Problems | Success |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
Response body objects
The Problems
object
A list of problems.
Element | Type | Description |
---|---|---|
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | integer | The number of entries per page. |
problems | Problem[] | The result entries. |
totalCount | integer | The total number of entries in the result. |
warnings | string[] | A list of warnings |
The Problem
object
The properties of a problem.
Element | Type | Description |
---|---|---|
affectedEntities | Entity | A list of all entities that are affected by the problem. |
displayId | string | The display ID of the problem. |
endTime | integer | The end timestamp of the problem, in UTC milliseconds. Has |
entityTags | M | A list of all entity tags of the problem. |
evidenceDetails | Evidence | The evidence details of a problem. |
impactAnalysis | Impact | A list of all impacts of the problem. |
impactLevel | string | The impact level of the problem. It shows what is affected by the problem.
|
impactedEntities | Entity | A list of all entities that are impacted by the problem. |
k8s.cluster.name | string[] | The related Kubernetes cluster names. |
k8s.cluster.uid | string[] | The related Kubernetes cluster UIDs. |
k8s.namespace.name | string[] | The related Kubernetes namespace names. |
linkedProblemInfo | Linked | The properties of the linked problem. |
managementZones | Management | A list of all management zones that the problem belongs to. |
problemFilters | Alerting | A list of alerting profiles that match the problem. |
problemId | string | The ID of the problem. |
recentComments | Comments | A list of comments. |
rootCauseEntity | Entity | A short representation of a monitored entity. |
severityLevel | string | The severity of the problem.
|
startTime | integer | The start timestamp of the problem, in UTC milliseconds. |
status | string | The status of the problem.
|
title | string | The name of the problem, displayed in the UI. |
The EntityStub
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
entityId | Entity | A short representation of a monitored entity. |
name | string | The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
The EntityId
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the entity. |
type | string | The type of the entity. |
The METag
object
The tag of a monitored entity.
Element | Type | Description |
---|---|---|
context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
key | string | The key of the tag. |
stringRepresentation | string | The string representation of the tag. |
value | string | The value of the tag. |
The EvidenceDetails
object
The evidence details of a problem.
Element | Type | Description |
---|---|---|
details | Evidence[] | A list of all evidence. |
totalCount | integer | The total number of evidence of a problem. |
The Evidence
object
An evidence of a root cause.
The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
displayName | string | The display name of the evidence. |
entity | Entity | A short representation of a monitored entity. |
evidenceType | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
groupingEntity | Entity | A short representation of a monitored entity. |
rootCauseRelevant | boolean | The evidence is ( |
startTime | integer | The start time of the evidence, in UTC milliseconds. |
The ImpactAnalysis
object
A list of all impacts of the problem.
Element | Type | Description |
---|---|---|
impacts | Impact[] | A list of all impacts of the problem. |
The Impact
object
The impact analysis of the problem on other entities/users.
The actual set of fields depends on the type of the impact. Find the list of actual objects in the description of the impactType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
estimatedAffectedUsers | integer | The estimated number of affected users. |
impactType | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
impactedEntity | Entity | A short representation of a monitored entity. |
The LinkedProblem
object
The properties of the linked problem.
Element | Type | Description |
---|---|---|
displayId | string | The display ID of the problem. |
problemId | string | The ID of the problem. |
The ManagementZone
object
A short representation of a management zone.
Element | Type | Description |
---|---|---|
id | string | The ID of the management zone. |
name | string | The name of the management zone. |
The AlertingProfileStub
object
Short representation of the alerting profile.
Element | Type | Description |
---|---|---|
id | string | The ID of the alerting profile. |
name | string | The name of the alerting profile. |
The CommentsList
object
A list of comments.
Element | Type | Description |
---|---|---|
comments | Comment[] | The result entries. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | integer | The number of entries per page. |
totalCount | integer | The total number of entries in the result. |
The Comment
object
The comment to a problem.
Element | Type | Description |
---|---|---|
authorName | string | The user who wrote the comment. |
content | string | The text of the comment. |
context | string | The context of the comment. |
createdAtTimestamp | integer | The timestamp of comment creation, in UTC milliseconds. |
id | string | The ID of the comment. |
Response body JSON model
{"nextPageKey": "AQAAABQBAAAABQ==","pageSize": 1,"problems": [{"affectedEntities": [{"entityId": {"id": "string","type": "string"},"name": "string"}],"displayId": "string","endTime": 1,"entityTags": [{"context": "string","key": "string","stringRepresentation": "string","value": "string"}],"evidenceDetails": {"details": [{"displayName": "string","entity": {},"evidenceType": "AVAILABILITY_EVIDENCE","groupingEntity": {},"rootCauseRelevant": true,"startTime": 1}],"totalCount": 1},"impactAnalysis": {"impacts": [{"estimatedAffectedUsers": 1,"impactType": "APPLICATION","impactedEntity": {}}]},"impactLevel": "APPLICATION","impactedEntities": [{}],"k8s.cluster.name": ["string"],"k8s.cluster.uid": ["string"],"k8s.namespace.name": ["string"],"linkedProblemInfo": {"displayId": "string","problemId": "string"},"managementZones": [{"id": "string","name": "string"}],"problemFilters": [{"id": "string","name": "string"}],"problemId": "string","recentComments": {"comments": [{"authorName": "string","content": "string","context": "string","createdAtTimestamp": 1,"id": "string"}],"nextPageKey": "AQAAABQBAAAABQ==","pageSize": 1,"totalCount": 1},"rootCauseEntity": {},"severityLevel": "AVAILABILITY","startTime": 1,"status": "CLOSED","title": "string"}],"totalCount": 1,"warnings": ["string"]}