Problems API - GET details
This API is deprecated. Use the Problems API v2 instead.
Lists all details of the specified problem.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v1/problem/details/{problemId} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/problem/details/{problemId} | |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/problem/details/{problemId} |
Authentication
To execute this request, you need an access token with DataExport
scope.
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 |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | ProblemDetailsResultWrapper | Success |
4XX | ErrorEnvelope | Client side error. |
5XX | ErrorEnvelope | Server side error. |
Response body objects
The ProblemDetailsResultWrapper
object
Element | Type | Description |
---|---|---|
result | Problem | The properties of a problem. |
The Problem
object
The properties of a problem.
Element | Type | Description |
---|---|---|
affectedCounts | object | The number of affected entities per impact level. |
commentCount | integer | The number of comments to the problem. |
displayName | string | The name of the problem, displayed in the UI. |
endTime | integer | The end timestamp of the problem, in UTC milliseconds. Has the value |
hasRootCause | boolean | Indicates whether Dynatrace has found at least one possible root cause for the problem. |
id | string | The ID of the problem. |
impactLevel | string | The impact level of the problem. It shows what is affected by the problem: infrastructure, service, or application.
|
rankedEvents | Event[] | The list of events related to the problem. |
rankedImpacts | EventRestImpact[] | Provides impact information of the events in an aggregated form. For a more detailed impact analysis, see |
recoveredCounts | object | The number of entities that were affected, but recovered, per impact level. |
severityLevel | string | The severity of the problem.
|
startTime | integer | The start timestamp of the problem, in UTC milliseconds. |
status | string | The status of the problem.
|
tagsOfAffectedEntities | TagInfo[] | Tags of entities affected by the problem. |
The Event
object
The properties of an event.
Element | Type | Description |
---|---|---|
activeMaintenanceWindows | EntityShortRepresentation[] | - |
affectedPrivateSyntheticLocations | string[] | - |
affectedRequestsPerMinute | number | - |
affectedSyntheticActions | string[] | If the event type is one of the synthetic event types then we may have information on which synthetic actions are affected by the event. The names of those are returned in this field. |
affectedSyntheticLocations | string[] | - |
affectedUserActionsPerMinute | number | - |
annotationDescription | string | - |
annotationType | string | - |
artifact | string | - |
browser | string | -
|
changed | string | - |
ciBackLink | string | - |
correlationId | string | - |
cpuLimitInMHz | integer | - |
cpuLoad | number | - |
customProperties | object | - |
deploymentName | string | - |
deploymentParamAdded | string | - |
deploymentParamRemoved | string | - |
deploymentProject | string | - |
deploymentVersion | string | - |
effectiveEntity | string | - |
endTime | integer | The timestamp of the event closure, in UTC milliseconds. Has the |
entityId | string | The ID of the affected Dynatrace entity. |
entityName | string | The name of the affected Dynatrace entity. |
eventType | string | The type of the event.
|
geolocation | string | - |
impactLevel | string | The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application.
|
isClusterWide | boolean | For events with event type |
isRootCause | boolean | Indicates if the event is the root cause of a problem. |
minimumProcessGroupInstanceCountThreshold | integer | - |
mobileAppVersion | string | - |
operatingSystem | string | - |
original | string | - |
percentile | string | -
|
referenceResponseTime50thPercentile | number | - |
referenceResponseTime90thPercentile | number | - |
remediationAction | string | - |
resourceId | string | The id of the resource the event occurred on. |
resourceName | string | The name of the resource the event occurred on. |
service | string | - |
serviceMethod | string | - |
serviceMethodGroup | string | - |
severities | EventSeverity[] | Additional data on the event severity. |
severityLevel | string | The severity of the event.
|
source | string | - |
startTime | integer | The timestamp of the event detection, in UTC milliseconds. |
status | string | The status of the event.
|
syntheticErrorType | string[] | If the event type is one of the synthetic event types then we may have information about the error type. The names of those are returned in this field. |
userAction | string | - |
userDefined50thPercentileThreshold | number | - |
userDefined90thPercentileThreshold | number | - |
userDefinedFailureRateThreshold | number | - |
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
description | string | A short description of the Dynatrace entity. |
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. |
The EventSeverity
object
Additional data on the event severity.
Element | Type | Description |
---|---|---|
context | string | The metric used in the event severity calculation.
|
unit | string | The unit of the severity value.
|
value | number | The value of the severity. |
The EventRestImpact
object
The information about the event's impact.
Element | Type | Description |
---|---|---|
entityId | string | The ID of the affected Dynatrace entity. |
entityName | string | The name of the affected Dynatrace entity. |
eventType | string | The type of the event.
|
impactLevel | string | The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application.
|
resourceId | string | The id of the resource the event occurred on. |
resourceName | string | The name of the resource the event occurred on. |
severityLevel | string | The severity of the event.
|
The TagInfo
object
Tag of a Dynatrace entity.
Element | Type | Description |
---|---|---|
context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the
|
key | string | The key of the tag. Custom tags have the tag value here. |
value | string | The value of the tag. Not applicable to custom tags. |
Response body JSON model
{"result": {"affectedCounts": {"APPLICATION": 1,"ENVIRONMENT": 1,"INFRASTRUCTURE": 1,"SERVICE": 1},"commentCount": 1,"displayName": "string","endTime": 1,"hasRootCause": true,"id": "string","impactLevel": "APPLICATION","rankedEvents": [{"activeMaintenanceWindows": [{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}],"affectedPrivateSyntheticLocations": ["string"],"affectedRequestsPerMinute": 1,"affectedSyntheticActions": ["string"],"affectedSyntheticLocations": ["string"],"affectedUserActionsPerMinute": 1,"annotationDescription": "string","annotationType": "string","artifact": "string","browser": "APPLICATION","changed": "string","ciBackLink": "string","correlationId": "string","cpuLimitInMHz": 1,"cpuLoad": 1,"customProperties": {},"deploymentName": "string","deploymentParamAdded": "string","deploymentParamRemoved": "string","deploymentProject": "string","deploymentVersion": "string","effectiveEntity": "string","endTime": 1,"entityId": "string","entityName": "string","eventType": "APPLICATION_JS_FRAMEWORK_DETECTED","geolocation": "string","impactLevel": "APPLICATION","isClusterWide": true,"isRootCause": true,"minimumProcessGroupInstanceCountThreshold": 1,"mobileAppVersion": "string","operatingSystem": "string","original": "string","percentile": "50th","referenceResponseTime50thPercentile": 1,"referenceResponseTime90thPercentile": 1,"remediationAction": "string","resourceId": "string","resourceName": "string","service": "string","serviceMethod": "string","serviceMethodGroup": "string","severities": [{"context": "COMMAND_ABORT","unit": "Ampere (A)","value": 1}],"severityLevel": "AVAILABILITY","source": "string","startTime": 1,"status": "CLOSED","syntheticErrorType": ["string"],"userAction": "string","userDefined50thPercentileThreshold": 1,"userDefined90thPercentileThreshold": 1,"userDefinedFailureRateThreshold": 1}],"rankedImpacts": [{"entityId": "string","entityName": "string","eventType": "APPLICATION_JS_FRAMEWORK_DETECTED","impactLevel": "APPLICATION","resourceId": "string","resourceName": "string","severityLevel": "AVAILABILITY"}],"recoveredCounts": {"APPLICATION": 1,"ENVIRONMENT": 1,"INFRASTRUCTURE": 1,"SERVICE": 1},"severityLevel": "AVAILABILITY","startTime": 1,"status": "CLOSED","tagsOfAffectedEntities": [{"context": "AWS","key": "string","value": "string"}]}}
Example
In this example, the request gets the details on the problem with ID 2307087411653364173_1538400720000V2.
The API token is passed in the Authorization header.
Curl
curl -X GET \https://mySampleEnv.live.dynatrace.com/api/v1/problem/details/2307087411653364173_1538400720000V2 \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/problem/details/2307087411653364173_1538400720000V2
Response body
{"result": {"id": "2307087411653364173_1538400720000V2","startTime": 1538400720000,"endTime": -1,"displayName": "173","impactLevel": "INFRASTRUCTURE","details": "OPEN","severityLevel": "AVAILABILITY","commentCount": 0,"tagsOfAffectedEntities": [{"context": "CONTEXTLESS","key": "loadtest"},{"context": "CONTEXTLESS","key": "ServiceNow"},{"context": "CONTEXTLESS","key": "host tag"}],"rankedEvents": [{"startTime": 1538400720000,"endTime": -1,"entityId": "PROCESS_GROUP-09875E82E2FB98FD","entityName": "Windows System","severityLevel": "AVAILABILITY","impactLevel": "INFRASTRUCTURE","eventType": "PROCESS_GROUP_LOW_INSTANCE_COUNT","details": "OPEN","severities": [{"context": "PG_AVAILABLE","value": 2,"unit": "Count (count)"}],"isRootCause": true,"minimumProcessGroupInstanceCountThreshold": 3},{"startTime": 1538400731799,"endTime": 1538443959640,"entityId": "HOST-ED6BC51DEBA8093A","entityName": "ZID","severityLevel": "AVAILABILITY","impactLevel": "INFRASTRUCTURE","eventType": "CONNECTION_LOST","details": "CLOSED","severities": [],"isRootCause": true}],"rankedImpacts": [{"entityId": "PROCESS_GROUP-09875E82E2FB98FD","entityName": "Windows System","severityLevel": "AVAILABILITY","impactLevel": "INFRASTRUCTURE","eventType": "PROCESS_GROUP_LOW_INSTANCE_COUNT"},{"entityId": "HOST-ED6BC51DEBA8093A","entityName": "ZID","severityLevel": "AVAILABILITY","impactLevel": "INFRASTRUCTURE","eventType": "CONNECTION_LOST"}],"affectedCounts": {"INFRASTRUCTURE": 1,"SERVICE": 0,"APPLICATION": 0,"ENVIRONMENT": 0},"recoveredCounts": {"INFRASTRUCTURE": 1,"SERVICE": 0,"APPLICATION": 0,"ENVIRONMENT": 0},"hasRootCause": true}}
Response code
200