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 Access problem and event feed, metrics, and topology (DataExport) 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

Defines the list of problem properties to be added to the current page. Must be defined separately for each page.

The following additional properties may be included in the response, all other problem properties are included by default and cannot be removed from the response:

  • evidences: The findings of the root cause.
  • impactAnalysis: The impact analysis of the problem on other entities/users.
  • recentComments: A list of the most recent comments on this problem.

To add properties, prefix them with a + (example: +evidences). For brevity, you may also omit the + and just specify the plain property (example: evidences).

You can add multiple additional properties at once by joining them with a comma: +evidences,+recentComments or evidences,recentComments.

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 desired 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 2019-12-21T05: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 2019-12-21T05: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 several of the following criteria:

  • Status: status(open) or status(closed). You can only specify a single status.
  • Severity Level: severityLevel(performance). You can specify several severity levels.
  • Impact Level: impactLevel(infrastructure,application). You can specify several impact levels.
  • Root cause Entity: rootCauseEntity(meId_1, ..., meId_n). You can specify several rootCause entity IDs.
  • Management Zone by ID: managementZoneIds(mzId1, ..., mzId_n). You can specify several management zone IDs.
  • Management Zone by name: managementZones(text1, ..., text_n). You can specify several management zone names.
  • Impacted Entities: impactedEntities(meId_1, ..., meId_n). You can specify several impacted entity IDs.
  • Affected Entities: affectedEntities(meId_1, ..., meId_n). You can specify several affected entity IDs.
  • Affected Entity Types: affectedEntityTypes(type1, ..., type_n). You can specify several affected entity types.
  • Problem ID: problemId(pid1, ..., pid_n). You can specify several problem IDs.
  • Problem Filter ID: problemFilterIds(id_1, ..., id_n). You can specify several problem filter IDs.
  • Problem Filter Name: problemFilterNames(text_1, ..., text_n). You can specify several problem filter names.
  • Entity tags: entityTags(tagKey_1:tagValue_1, ..., tagKey_n:tagValue_n). 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: displayId(did1, ..., did_n). You can specify several display IDs.

To set several filters, separate them with a comma (,). Only results, matching all filters, are included in the response.

query optional
entitySelector string

You need to set one of these criteria:

  • Entity type: type("value").
  • 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:

  • 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("ID")
  • Management zone name: mzName("value"). Management zone names are case-sensitive.
  • Dynatrace entity name: entityName("value"). Entity names are case-sensitive.
  • Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY")

Further information can be found here. 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.

Specify a query which results less than 10000 entities !

query optional
sort string

Specifies a set of comma , separated fields that represents multiple sorting levels for the problem list.

Each field has a sign prefix (+/-) which corresponds to the sorting order ( + for ascending and - for descending) If no sign prefix is set, then default ascending sorting oder will be applied You can sort by the following properties:

  • status: sorting by problem status
  • startTime: sorting by problem start time Example: -status,+starttime
query optional

Response format

Some JSON models vary depending on the type of the model. To find all the possible variations, refer to JSON models.

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
impactedEntities EntityStub[]

The set of all entities that are impacted by this problem.

displayId string

The display ID of the problem.

entityTags METag[]

The set of all entity tags of the problem.

impactLevel string

The impact level of the problem. It shows what is affected by the problem: infrastructure, service, or application.

The impactLevel element can hold these values.
problemFilters ProblemFilterStubDto[]

The set of all problem filters (also known as 'alerting profiles') that the problem matches.

evidenceDetails EvidenceDetails
recentComments CommentsList
impactAnalysis ImpactAnalysis
affectedEntities EntityStub[]

The set of all entities that are affected by this problem.

rootCauseEntity EntityStub
managementZones ManagementZone[]

The set of all management zones that the problem belongs to.

problemId string

The ID of the problem.

severityLevel string

The severity of the problem.

The severityLevel element can hold these values.
status string

The status of the problem.

The status element can hold these values.
startTime integer

The start timestamp of the problem, in UTC milliseconds.

endTime integer

The start 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 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 ImpactAnalysis object

The user impact analysis.

Element Type Description
impacts ImpactDto[]

The list of all impacts.

The ImpactDto object

The list of all impacts.

Element Type Description
impactedEntity EntityStub
estimatedAffectedUsers integer

The estimated number of users affected by the impacted entity.

The CommentsList object

A list of comments.

Element Type Description
comments CommentDto[]
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.

pageSize integer

The number of entries per page.

totalCount integer

The total number of entries in the result.

The CommentDto object

Element Type Description
createdAtTimestamp integer
authorName string
context string
id string
content string

The EvidenceDetails object

The evidence details of a problem.

Element Type Description
totalCount integer
details Evidence[]

The list of all evidences.

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 -> EventEvidenceMetadata
  • METRIC -> MetricEvidenceMetadata
  • TRANSACTIONAL -> TransactionalEvidenceMetadata
  • MAINTENANCE_WINDOW -> MaintenanceWindowEvidenceMetadata
  • AVAILABILITY_EVIDENCE -> AvailabilityEvidenceMetadata
The evidenceType element can hold these values.
displayName string

The evidence friendly display name.

entity EntityStub
groupingEntity EntityStub
rootCauseRelevant boolean

Marks if the evidence is part of the root cause (true) or not (false).

startTime integer

The start time of the evidence, in UTC milliseconds.

The ProblemFilterStubDto object

Element Type Description
name string

The name of the profile filter.

id string

The ID of the profile filter.

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

A stub representation of a monitored entity, containing its name.

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.

Possible values

Possible values for the status element in the Problem object:

  • CLOSED
  • OPEN

Possible values for the severityLevel element in the Problem object:

  • AVAILABILITY
  • CUSTOM_ALERT
  • ERROR
  • MONITORING_UNAVAILABLE
  • PERFORMANCE
  • RESOURCE_CONTENTION

Possible values for the evidenceType element in the Evidence object:

  • AVAILABILITY_EVIDENCE
  • EVENT
  • MAINTENANCE_WINDOW
  • METRIC
  • TRANSACTIONAL

Possible values for the impactLevel element in the Problem object:

  • APPLICATION
  • ENVIRONMENT
  • INFRASTRUCTURE
  • SERVICES