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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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

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): `evidenceDetails`: The details of the root cause. `impactAnalysis`: The impact analysis of the problem on other entities/users. `recentComments`: A list of the most recent comments to the problem. To add properties, specify them as a comma-separated list (for example, `evidenceDetails,impactAnalysis`). 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: 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 hours is used (`now-2h`).	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
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. Status: `status("open")` or `status("closed")`. You can specify only one status. Severity level: `severityLevel("level-1","level-2")`. Find the possible values in the description of the severityLevel field of the response. Impact level: `impactLevel("level-11","level-2")` Find the possible values in the description of the impactLevel field of the response. Root cause entity: `rootCauseEntity("id-1", "id-2")`. Management zone ID: `managementZoneIds("mZId-1", "mzId-2")`. Management zone name: `managementZones("value-1","value-2")`. Impacted entities: `impactedEntities("id-1", "id-2")`. Affected entities: `affectedEntities("id-1", "id-2")`. Type of affected entities: `affectedEntityTypes("value-1","value-2")`. Problem ID: `problemId("id-1", "id-2")`. Alerting profile ID: `problemFilterIds("id-1", "id-2")`. Alerting profile name: `problemFilterNames("value-1","value-2")`. Entity tags: `entityTags("[context]key:value","key:value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. If a value-only tag has a colon (`:`) in it, you must escape the colon with a backslash(`\`). Otherwise, the tag will be parsed as a `key:value tag`. All tag values are case-sensitive. Display ID of the problem: `displayId("id-1", "id-2")`. Under maintenance: `underMaintenance(true\|false)`. Shows (true) or hides (false) all problems created during maintenance mode. Text search: `text("value")`. Text search on the following fields: problem title, event titles, displayId and the id of affected and impacted entities. The text search is case insensitive, partial matching and based on a relevance score. Therefore the `relevance` sort option should be used to get the most relevant problems first. The special characters `~` and `"` need to be escaped using a `~` (e.g. double quote search `text("~"")`). To set several criteria, separate them with a comma (`,`). Only results matching all criteria are included in the response.	query	optional
entitySelector	string	The entity scope of the query.You need to set one of these criteria: Entity type: `type("TYPE")` Dynatrace entity ID: `entityId("id")`. You can specify several IDs, separated by a comma (`entityId("id-1","id-2")`). And you can add one or several of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified. Tag: `tag("value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. If a value-only tag has a colon (`:`) in it, you must escape the colon with a backslash(`\`). Otherwise, the tag will be parsed as a `key:value` tag. All tag values are case-sensitive. Management zone ID: `mzId(123)` Management zone name: `mzName("value")` Entity name: `entityName("value")`. The `CONTAINS` operator is used and the value is not case-sensitive. Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")` Entity attribute: `<attribute>("value1","value2")`. For the list of available attributes, see the Entity selector help page. To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching all criteria are included in response. 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 (`,`) fields for sorting in the problem list. You can sort by the following properties with a sign prefix for the sorting order. `status`: problem status (`+` open problems first or `-` closed problems first) `startTime`: problem start time (`+` old problems first or `-` new problems first) `relevance`: problem relevance (`+` least relevant problems first or `-` most relevant problems first) - can be used only in combination with text search If no prefix is set, `+` 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.	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

Response parametersJSON model

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 `null` on the last page. 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
affectedEntities	EntityStub[]	A list of all entities that are affected by the problem.
recentComments	CommentsList
rootCauseEntity	EntityStub
problemFilters	AlertingProfileStub[]	A list of alerting profiles that match the problem.
evidenceDetails	EvidenceDetails
impactAnalysis	ImpactAnalysis
linkedProblemInfo	LinkedProblem
impactLevel	string	The impact level of the problem. It shows what is affected by the problem. The element can hold these values APPLICATION ENVIRONMENT INFRASTRUCTURE SERVICES
impactedEntities	EntityStub[]	A list of all entities that are impacted by the problem.
displayId	string	The display ID of the problem.
managementZones	ManagementZone[]	A list of all management zones that the problem belongs to.
severityLevel	string	The severity of the problem. The element can hold these values AVAILABILITY CUSTOM_ALERT ERROR MONITORING_UNAVAILABLE PERFORMANCE RESOURCE_CONTENTION
problemId	string	The ID of the problem.
entityTags	METag[]	A list of all entity tags of the problem.
status	string	The status of the problem. The element can hold these values CLOSED OPEN
startTime	integer	The start timestamp of the problem, in UTC milliseconds.
endTime	integer	The end timestamp of the problem, in UTC milliseconds. Has `-1` value, if the problem is still open.
title	string	The name of the problem, displayed in the UI.

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 `CONTEXTLESS` value.

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 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 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

Element	Type	Description
impactType	string	Defines the actual set of fields depending on the value. See one of the following objects: `SERVICE` -> ServiceImpact `APPLICATION` -> ApplicationImpact `MOBILE` -> MobileImpact `CUSTOM_APPLICATION` -> CustomApplicationImpact The element can hold these values APPLICATION CUSTOM_APPLICATION MOBILE SERVICE
impactedEntity	EntityStub
estimatedAffectedUsers	integer	The estimated number of affected users.

Defines the actual set of fields depending on the value. See one of the following objects:

SERVICE -> ServiceImpact
APPLICATION -> ApplicationImpact
MOBILE -> MobileImpact
CUSTOM_APPLICATION -> CustomApplicationImpact

The element can hold these values

APPLICATION
CUSTOM_APPLICATION
MOBILE
SERVICE

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: `EVENT` -> EventEvidence `METRIC` -> MetricEvidence `TRANSACTIONAL` -> TransactionalEvidence `MAINTENANCE_WINDOW` -> MaintenanceWindowEvidence `AVAILABILITY_EVIDENCE` -> AvailabilityEvidence The element can hold these values AVAILABILITY_EVIDENCE EVENT MAINTENANCE_WINDOW METRIC TRANSACTIONAL
displayName	string	The display name of the evidence.
entity	EntityStub
groupingEntity	EntityStub
rootCauseRelevant	boolean	The evidence is (`true`) or is not (`false`) a part of the root cause.
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 CommentsList object

A list of comments.

Element	Type	Description
comments	Comment[]
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 `null` on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.

The Comment object

The comment to a problem.

Element	Type	Description
authorName	string	The user who wrote the comment.
createdAtTimestamp	integer	The timestamp of comment creation, in UTC milliseconds.
context	string	The context of the comment.
id	string	The ID of the comment.
content	string	The text of the comment.

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.

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": [
    {
      "affectedEntities": [
        {
          "entityId": {
            "id": "string",
            "type": "string"
          },
          "name": "string"
        }
      ],
      "recentComments": {
        "comments": [
          {
            "authorName": "string",
            "createdAtTimestamp": 0,
            "context": "string",
            "id": "string",
            "content": "string"
          }
        ],
        "totalCount": 0,
        "pageSize": 0,
        "nextPageKey": "AQAAABQBAAAABQ=="
      },
      "rootCauseEntity": {
        "entityId": {
          "id": "string",
          "type": "string"
        },
        "name": "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
          }
        ]
      },
      "linkedProblemInfo": {
        "displayId": "string",
        "problemId": "string"
      },
      "impactLevel": "APPLICATION",
      "impactedEntities": [
        {
          "entityId": {
            "id": "string",
            "type": "string"
          },
          "name": "string"
        }
      ],
      "displayId": "string",
      "managementZones": [
        {
          "name": "string",
          "id": "string"
        }
      ],
      "severityLevel": "AVAILABILITY",
      "problemId": "string",
      "entityTags": [
        {
          "stringRepresentation": "string",
          "value": "string",
          "key": "string",
          "context": "string"
        }
      ],
      "status": "CLOSED",
      "startTime": 0,
      "endTime": 0,
      "title": "string"
    }
  ]
}