Problems API - GET details
We have a new version of this API—Problems API v2. Check it out!
Lists all details of the specified problem.
The request produces an application/json
payload.
GET |
|
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 |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
The ProblemDetailsResultWrapper object
Element | Type | Description |
---|---|---|
result | Problem |
The Problem object
The properties of a problem.
Element | Type | Description |
---|---|---|
id | string | The ID of the problem. |
startTime | integer | The start timestamp of the problem, in UTC milliseconds. |
endTime | integer | The end timestamp of the problem, in UTC milliseconds. Has the value |
displayName | string | The name of the problem, displayed in the UI. |
impactLevel | string | The impact level of the problem. It shows what is affected by the problem: infrastructure, service, or application. |
status | string | The status of the problem. |
severityLevel | string | The severity of the problem. |
commentCount | integer | The number of comments to the problem. |
tagsOfAffectedEntities | TagInfo[] | Tags of entities affected by the problem. |
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 |
affectedCounts | object | The number of affected entities per impact level. |
recoveredCounts | object | The number of entities that were affected, but recovered, per impact level. |
hasRootCause | boolean | Indicates whether Dynatrace has found at least one possible root cause for the problem. |
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. |
severityLevel | string | The severity of the event. |
impactLevel | string | The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application. |
eventType | string | The type of the event. |
resourceId | string | The id of the resource the event occurred on. |
resourceName | string | The name of the resource the event occurred on. |
The Event object
The properties of an event.
Element | Type | Description |
---|---|---|
startTime | integer | The timestamp of the event detection, in UTC milliseconds. |
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. |
severityLevel | string | The severity of the event. |
impactLevel | string | The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application. |
eventType | string | The type of the event. |
resourceId | string | The id of the resource the event occurred on. |
resourceName | string | The name of the resource the event occurred on. |
status | string | The status of the event. |
severities | EventSeverity[] | Additional data on the event severity. |
isRootCause | boolean | Indicates if the event is the root cause of a problem. |
deploymentProject | string | |
cpuLimitInMHz | integer | |
deploymentParamAdded | string | |
affectedPrivateSyntheticLocations | string[] | |
isClusterWide | boolean | For events with event type |
source | string | |
effectiveEntity | string | |
operatingSystem | string | |
artifact | string | |
cpuLoad | number | |
affectedRequestsPerMinute | number | |
annotationDescription | string | |
browser | string | |
affectedSyntheticLocations | string[] | |
deploymentName | string | |
deploymentParamRemoved | string | |
correlationId | string | |
userDefined50thPercentileThreshold | number | |
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. |
serviceMethodGroup | string | |
referenceResponseTime90thPercentile | number | |
userAction | string | |
minimumProcessGroupInstanceCountThreshold | integer | |
referenceResponseTime50thPercentile | number | |
original | string | |
userDefined90thPercentileThreshold | number | |
deploymentVersion | string | |
annotationType | string | |
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. |
affectedUserActionsPerMinute | number | |
activeMaintenanceWindows | EntityShortRepresentation[] | |
mobileAppVersion | string | |
userDefinedFailureRateThreshold | number | |
percentile | string | |
customProperties | object | |
remediationAction | string | |
service | string | |
ciBackLink | string | |
geolocation | string | |
serviceMethod | string | |
changed | string |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. |
description | string | A short description 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. |
value | number | The value of the severity. |
unit | string | The unit of the severity value. |
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. |
{
"result": {
"id": "string",
"startTime": 0,
"endTime": 0,
"displayName": "string",
"impactLevel": "APPLICATION",
"status": "CLOSED",
"severityLevel": "AVAILABILITY",
"commentCount": 0,
"tagsOfAffectedEntities": [
{
"context": "AWS",
"key": "string",
"value": "string"
}
],
"rankedEvents": [
{
"startTime": 0,
"endTime": 0,
"entityId": "string",
"entityName": "string",
"severityLevel": "AVAILABILITY",
"impactLevel": "APPLICATION",
"eventType": "APPLICATION_JS_FRAMEWORK_DETECTED",
"resourceId": "string",
"resourceName": "string",
"status": "CLOSED",
"severities": [
{
"context": "COMMAND_ABORT",
"value": "number",
"unit": "Bit (bit)"
}
],
"isRootCause": true,
"deploymentProject": "string",
"cpuLimitInMHz": 0,
"deploymentParamAdded": "string",
"affectedPrivateSyntheticLocations": [
"string"
],
"isClusterWide": true,
"source": "string",
"effectiveEntity": "string",
"operatingSystem": "string",
"artifact": "string",
"cpuLoad": "number",
"affectedRequestsPerMinute": "number",
"annotationDescription": "string",
"browser": "APPLICATION",
"affectedSyntheticLocations": [
"string"
],
"deploymentName": "string",
"deploymentParamRemoved": "string",
"correlationId": "string",
"userDefined50thPercentileThreshold": "number",
"syntheticErrorType": [
"string"
],
"serviceMethodGroup": "string",
"referenceResponseTime90thPercentile": "number",
"userAction": "string",
"minimumProcessGroupInstanceCountThreshold": 0,
"referenceResponseTime50thPercentile": "number",
"original": "string",
"userDefined90thPercentileThreshold": "number",
"deploymentVersion": "string",
"annotationType": "string",
"affectedSyntheticActions": [
"string"
],
"affectedUserActionsPerMinute": "number",
"activeMaintenanceWindows": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example\n"
}
],
"mobileAppVersion": "string",
"userDefinedFailureRateThreshold": "number",
"percentile": "50th",
"customProperties": "object",
"remediationAction": "string",
"service": "string",
"ciBackLink": "string",
"geolocation": "string",
"serviceMethod": "string",
"changed": "string"
}
],
"rankedImpacts": [
{
"entityId": "string",
"entityName": "string",
"severityLevel": "AVAILABILITY",
"impactLevel": "APPLICATION",
"eventType": "APPLICATION_JS_FRAMEWORK_DETECTED",
"resourceId": "string",
"resourceName": "string"
}
],
"affectedCounts": "object",
"recoveredCounts": "object",
"hasRootCause": true
}
}
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 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