List Problems
Lists problems observed within the specified timeframe.
Basic Parameters
| Parameter | Description |
|---|---|
| From | The start of the requested timeframe.You can use one of the following formats:
now-2h). |
| To | The end of the requested timeframe.You can use one of the following formats:
|
Advanced Parameters
| Parameter | Description |
|---|---|
| Entity Selector | The entity scope of the query. You must set one of these criteria:
EQUALS operator is used unless otherwise specified.
,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response.The maximum string length is 2,000 characters.The maximum number of entities that may be selected is limited to 10000. |
| Fields | 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):
evidenceDetails,impactAnalysis).The field is valid only for the current page of results. You must set it for each page you're requesting. |
| Next Page Key | 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. |
| Page Size | The amount of problems in a single response payload.The maximal allowed page size is 500.If not set, 50 is used. |
| Problem Selector | 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.
,). Only results matching all criteria are included in the response. |
| Sort | Specifies a set of comma-separated (,) fields for sorting in the problem list.You can sort by the following properties with a sign prefix for the sorting order.
+ is used.You can specify several levels of sorting. For example, +status,-startTime sorts problems by status, open problems first. Within the status, problems are sorted by start time, oldest first. |
Example Output
{
"nextPageKey": "AQAAABQBAAAABQ==",
"pageSize": 0,
"problems": [
{
"affectedEntities": [
{
"entityId": {
"id": "The ID of the entity.",
"type": "The type of the entity."
},
"name": "The name of the entity. \n\n Not included in the response in case no entity with the relevant ID was found."
}
],
"displayId": "The display ID of the problem.",
"endTime": 0,
"entityTags": [
{
"context": "The origin of the tag, such as AWS or Cloud Foundry. \n\n Custom tags use the `CONTEXTLESS` value.",
"key": "The key of the tag.",
"stringRepresentation": "The string representation of the tag.",
"value": "The value of the tag."
}
],
"evidenceDetails": {
"details": [
{
"displayName": "The display name of the evidence.",
"entity": {
"entityId": {
"id": "The ID of the entity.",
"type": "The type of the entity."
},
"name": "The name of the entity. \n\n Not included in the response in case no entity with the relevant ID was found."
},
"evidenceType": "Defines the actual set of fields depending on the value. See one of the following objects: \n\n* `EVENT` -\u003e EventEvidence \n* `METRIC` -\u003e MetricEvidence \n* `TRANSACTIONAL` -\u003e TransactionalEvidence \n* `MAINTENANCE_WINDOW` -\u003e MaintenanceWindowEvidence \n* `AVAILABILITY_EVIDENCE` -\u003e AvailabilityEvidence \n",
"groupingEntity": {
"entityId": {
"id": "The ID of the entity.",
"type": "The type of the entity."
},
"name": "The name of the entity. \n\n Not included in the response in case no entity with the relevant ID was found."
},
"rootCauseRelevant": false,
"startTime": 0
}
],
"totalCount": 0
},
"impactAnalysis": {
"impacts": [
{
"estimatedAffectedUsers": 0,
"impactType": "Defines the actual set of fields depending on the value. See one of the following objects: \n\n* `SERVICE` -\u003e ServiceImpact \n* `APPLICATION` -\u003e ApplicationImpact \n* `MOBILE` -\u003e MobileImpact \n* `CUSTOM_APPLICATION` -\u003e CustomApplicationImpact \n",
"impactedEntity": {
"entityId": {
"id": "The ID of the entity.",
"type": "The type of the entity."
},
"name": "The name of the entity. \n\n Not included in the response in case no entity with the relevant ID was found."
}
}
]
},
"impactLevel": "The impact level of the problem. It shows what is affected by the problem.",
"impactedEntities": [
{
"entityId": {
"id": "The ID of the entity.",
"type": "The type of the entity."
},
"name": "The name of the entity. \n\n Not included in the response in case no entity with the relevant ID was found."
}
],
"linkedProblemInfo": {
"displayId": "The display ID of the problem.",
"problemId": "The ID of the problem."
},
"managementZones": [
{
"id": "The ID of the management zone.",
"name": "The name of the management zone."
}
],
"problemFilters": [
{
"id": "The ID of the alerting profile.",
"name": "The name of the alerting profile."
}
],
"problemId": "The ID of the problem.",
"recentComments": {
"comments": [
{
"authorName": "The user who wrote the comment.",
"content": "The text of the comment.",
"context": "The context of the comment.",
"createdAtTimestamp": 0,
"id": "The ID of the comment."
}
],
"nextPageKey": "AQAAABQBAAAABQ==",
"pageSize": 0,
"totalCount": 0
},
"rootCauseEntity": {
"entityId": {
"id": "The ID of the entity.",
"type": "The type of the entity."
},
"name": "The name of the entity. \n\n Not included in the response in case no entity with the relevant ID was found."
},
"severityLevel": "The severity of the problem.",
"startTime": 0,
"status": "The status of the problem.",
"title": "The name of the problem, displayed in the UI."
}
],
"totalCount": 0,
"warnings": [
"string"
]
}
Workflow Library Example
List Problems with Dynatrace and Send Results Via Email
Preview this Workflow on desktop