• Home
  • Dynatrace API
  • Environment
  • Problems v2
  • Problems
  • GET details

Problems API v2 - GET problems details

Lists all details of the specified problem.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}

Authentication

To execute this request, you need an access token with problems.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
problemIdstring

The ID of the required problem.

pathrequired
fieldsstring

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

queryoptional

Response

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

Response codes

CodeTypeDescription
200Problem

Success

Response body objects

The Problem object

The properties of a problem.

ElementTypeDescription
impactLevelstring

The impact level of the problem. It shows what is affected by the problem.

The element can hold these values
  • APPLICATION
  • ENVIRONMENT
  • INFRASTRUCTURE
  • SERVICES
displayIdstring

The display ID of the problem.

affectedEntitiesEntityStub[]

A list of all entities that are affected by the problem.

evidenceDetailsEvidenceDetails

The evidence details of a problem.

recentCommentsCommentsList

A list of comments.

rootCauseEntityEntityStub

A short representation of a monitored entity.

impactedEntitiesEntityStub[]

A list of all entities that are impacted by the problem.

linkedProblemInfoLinkedProblem

The properties of the linked problem.

problemFiltersAlertingProfileStub[]

A list of alerting profiles that match the problem.

impactAnalysisImpactAnalysis

A list of all impacts of the problem.

problemIdstring

The ID of the problem.

managementZonesManagementZone[]

A list of all management zones that the problem belongs to.

severityLevelstring

The severity of the problem.

The element can hold these values
  • AVAILABILITY
  • CUSTOM_ALERT
  • ERROR
  • INFO
  • MONITORING_UNAVAILABLE
  • PERFORMANCE
  • RESOURCE_CONTENTION
entityTagsMETag[]

A list of all entity tags of the problem.

statusstring

The status of the problem.

The element can hold these values
  • CLOSED
  • OPEN
startTimeinteger

The start timestamp of the problem, in UTC milliseconds.

endTimeinteger

The end timestamp of the problem, in UTC milliseconds.

Has -1 value, if the problem is still open.

titlestring

The name of the problem, displayed in the UI.

The EntityStub object

A short representation of a monitored entity.

ElementTypeDescription
entityIdEntityId

A short representation of a monitored entity.

namestring

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.

ElementTypeDescription
idstring

The ID of the entity.

typestring

The type of the entity.

The EvidenceDetails object

The evidence details of a problem.

ElementTypeDescription
totalCountinteger

The total number of evidence of a problem.

detailsEvidence[]

A list of all evidence.

The Evidence object

An evidence of a root cause.

The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.

ElementTypeDescription
evidenceTypestring

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
displayNamestring

The display name of the evidence.

entityEntityStub

A short representation of a monitored entity.

groupingEntityEntityStub

A short representation of a monitored entity.

rootCauseRelevantboolean

The evidence is (true) or is not (false) a part of the root cause.

startTimeinteger

The start time of the evidence, in UTC milliseconds.

The CommentsList object

A list of comments.

ElementTypeDescription
commentsComment[]

The result entries.

totalCountinteger

The total number of entries in the result.

nextPageKeystring

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.

pageSizeinteger

The number of entries per page.

The Comment object

The comment to a problem.

ElementTypeDescription
authorNamestring

The user who wrote the comment.

createdAtTimestampinteger

The timestamp of comment creation, in UTC milliseconds.

contextstring

The context of the comment.

idstring

The ID of the comment.

contentstring

The text of the comment.

The LinkedProblem object

The properties of the linked problem.

ElementTypeDescription
displayIdstring

The display ID of the problem.

problemIdstring

The ID of the problem.

The AlertingProfileStub object

Short representation of the alerting profile.

ElementTypeDescription
namestring

The name of the alerting profile.

idstring

The ID of the alerting profile.

The ImpactAnalysis object

A list of all impacts of the problem.

ElementTypeDescription
impactsImpact[]

A list of all impacts of the problem.

The Impact object

The impact analysis of the problem on other entities/users.

The actual set of fields depends on the type of the impact. Find the list of actual objects in the description of the impactType field or see Problems API v2 - JSON models.

ElementTypeDescription
impactTypestring

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
impactedEntityEntityStub

A short representation of a monitored entity.

estimatedAffectedUsersinteger

The estimated number of affected users.

The ManagementZone object

A short representation of a management zone.

ElementTypeDescription
namestring

The name of the management zone.

idstring

The ID of the management zone.

The METag object

The tag of a monitored entity.

ElementTypeDescription
stringRepresentationstring

The string representation of the tag.

valuestring

The value of the tag.

keystring

The key of the tag.

contextstring

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

Response body JSON model

json
{ "impactLevel": "APPLICATION", "displayId": "string", "affectedEntities": [ { "entityId": { "id": "string", "type": "string" }, "name": "string" } ], "evidenceDetails": { "totalCount": 1, "details": [ { "evidenceType": "AVAILABILITY_EVIDENCE", "displayName": "string", "entity": {}, "groupingEntity": {}, "rootCauseRelevant": true, "startTime": 1 } ] }, "recentComments": { "comments": [ { "authorName": "string", "createdAtTimestamp": 1, "context": "string", "id": "string", "content": "string" } ], "totalCount": 1, "nextPageKey": "AQAAABQBAAAABQ==", "pageSize": 1 }, "rootCauseEntity": {}, "impactedEntities": [ {} ], "linkedProblemInfo": { "displayId": "string", "problemId": "string" }, "problemFilters": [ { "name": "string", "id": "string" } ], "impactAnalysis": { "impacts": [ { "impactType": "APPLICATION", "impactedEntity": {}, "estimatedAffectedUsers": 1 } ] }, "problemId": "string", "managementZones": [ { "name": "string", "id": "string" } ], "severityLevel": "AVAILABILITY", "entityTags": [ { "stringRepresentation": "string", "value": "string", "key": "string", "context": "string" } ], "status": "CLOSED", "startTime": 1, "endTime": 1, "title": "string" }
Related topics
  • Davis® AI

    Get familiar with the capabilities of Davis AI.