Problems API - GET problems details

Lists all details of the specified problem.

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/{problemId}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}

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

The ID of the problem you're inquiring.

path required
fields string

Defines the list of problem properties to be present in the response.

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

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

To remove properties, prefix them with a - (example: -evidences).

To explicitly request certain properties, just specify the plain property (example: evidences). This will return the selected property (e.g. evidences) along with all other problem properties not listed here.

You can remove or explicitly request multiple properties at once by joining them with a comma: -evidences,-recentComments or evidences,recentComments.

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