Problems API - 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.
This request is an Early Adopter release and may be changed in non-compatible way.
GET |
|
Authentication
To execute this request, you need the Read problems (problems.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 |
---|---|---|---|---|
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 need to set one of these criteria:
And you can add one or several of the following criteria. Values are case-sensitive and the
To set several criteria, separate them with a comma ( For more information, see the Entity selector help page. The length of the string is limited to 10,000 characters. The scope is limited to 10000 entities ! |
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 | Description |
---|---|
200 | Success |
Response body
The ProblemsDto object
Element | Type | Description |
---|---|---|
totalCount | integer | The total number of entries in the result. |
pageSize | integer | The number of entries per page. |
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. |
problems | Problem[] |
The Problem object
The properties of a problem.
Element | Type | Description |
---|---|---|
impactedEntities | EntityStub[] | A list of all entities that are impacted by the problem. |
impactLevel | string | The impact level of the problem. It shows what is affected by the problem. |
displayId | string | The display ID of the problem. |
entityTags | METag[] | A list of all entity tags of the problem. |
rootCauseEntity | EntityStub | |
linkedProblemInfo | LinkedProblem | |
problemFilters | AlertingProfileStub[] | A list of alerting profiles that match the problem. |
evidenceDetails | EvidenceDetails | |
impactAnalysis | ImpactAnalysis | |
recentComments | CommentsList | |
affectedEntities | EntityStub[] | A list of all entities that are affected by the problem. |
severityLevel | string | The severity of the problem. |
managementZones | ManagementZone[] | A list of all management zones that the problem belongs to. |
problemId | string | The ID of the problem. |
status | string | The status of the problem. |
startTime | integer | The start timestamp of the problem, in UTC milliseconds. |
endTime | integer | The end timestamp of the problem, in UTC milliseconds. Has |
title | string | The name of the problem, displayed in the UI. |
The ManagementZone object
A short representation of a management zone.
Element | Type | Description |
---|---|---|
name | string | The name of the management zone. |
id | string | The ID of the management zone. |
The CommentsList object
A list of comments.
Element | Type | Description |
---|---|---|
comments | Comment[] | |
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 |
---|---|---|
createdAtTimestamp | integer | The timestamp of comment creation, in UTC milliseconds. |
authorName | string | The user who wrote the comment. |
context | string | The context of the comment. |
id | string | The ID of the comment. |
content | string | The text of the comment. |
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.
Element | Type | Description |
---|---|---|
impactType | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
impactedEntity | EntityStub | |
estimatedAffectedUsers | integer | The estimated number of affected users. |
The EvidenceDetails object
The evidence details of a problem.
Element | Type | Description |
---|---|---|
totalCount | integer | The total number of evidence of a problem. |
details | Evidence[] | A list of all evidence. |
The Evidence object
An evidence of a root cause.
Element | Type | Description |
---|---|---|
evidenceType | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
displayName | string | The display name of the evidence. |
entity | EntityStub | |
groupingEntity | EntityStub | |
rootCauseRelevant | boolean | The evidence is ( |
startTime | integer | The start time of the evidence, in UTC milliseconds. |
The AlertingProfileStub object
Short representation of the alerting profile.
Element | Type | Description |
---|---|---|
name | string | The name of the alerting profile. |
id | string | The ID of the alerting profile. |
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 METag object
The tag of a monitored entity.
Element | Type | Description |
---|---|---|
stringRepresentation | string | The string representation of the tag. |
value | string | The value of the tag. |
key | string | The key of the tag. |
context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
The EntityStub object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
entityId | EntityId | |
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. |
{
"totalCount": 0,
"pageSize": 0,
"nextPageKey": "AQAAABQBAAAABQ==",
"problems": [
{
"impactedEntities": [
{
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
}
],
"impactLevel": "APPLICATION",
"displayId": "string",
"entityTags": [
{
"stringRepresentation": "string",
"value": "string",
"key": "string",
"context": "string"
}
],
"rootCauseEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"linkedProblemInfo": {
"displayId": "string",
"problemId": "string"
},
"problemFilters": [
{
"name": "string",
"id": "string"
}
],
"evidenceDetails": {
"totalCount": 0,
"details": [
{
"evidenceType": "AVAILABILITY_EVIDENCE",
"displayName": "string",
"entity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"groupingEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"rootCauseRelevant": true,
"startTime": 0
}
]
},
"impactAnalysis": {
"impacts": [
{
"impactType": "APPLICATION",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 0
}
]
},
"recentComments": {
"comments": [
{
"createdAtTimestamp": 0,
"authorName": "string",
"context": "string",
"id": "string",
"content": "string"
}
],
"nextPageKey": "AQAAABQBAAAABQ==",
"pageSize": 0,
"totalCount": 0
},
"affectedEntities": [
{
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
}
],
"severityLevel": "AVAILABILITY",
"managementZones": [
{
"name": "string",
"id": "string"
}
],
"problemId": "string",
"status": "CLOSED",
"startTime": 0,
"endTime": 0,
"title": "string"
}
]
}