Problems API - GET details

Lists all details of the specified problem.

The request produces an application/json payload.

GET	Managed 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}

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

Parameters

Parameter	Type	Description	In	Required
problemId	string	The ID of the problem you're inquiring.	path	required

Response format

Response parameters JSON model

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 start timestamp of the problem, in UTC milliseconds. Has `-1` value, if the problem is still open.
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. The impactLevel element can hold these values.
status	string	The status of the problem. The status element can hold these values.
severityLevel	string	The severity of the problem. The severityLevel element can hold these values.
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 `rankedEvents`.
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. The severityLevel element can hold these values.
impactLevel	string	The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application. The impactLevel element can hold these values.
eventType	string	The type of the event. The eventType element can hold these values.
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 `-1` value if the event is still open.
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. The severityLevel element can hold these values.
impactLevel	string	The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application. The impactLevel element can hold these values.
eventType	string	The type of the event. The eventType element can hold these values.
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. The status element can hold these values.
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 `MONITORING_UNAVAILABLE`, it may be that the event is occurring on the entire Dynatrace cluster. If this is true, it could be that there are problems on the Dynatrace side.
source	string
effectiveEntity	string
operatingSystem	string
artifact	string
cpuLoad	number
affectedRequestsPerMinute	number
annotationDescription	string
browser	string	The browser element can hold these values.
affectedSyntheticLocations	string[]
deploymentName	string
deploymentParamRemoved	string
correlationId	string
userDefined50thPercentileThreshold	number
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	The percentile element can hold these values.
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. The context element can hold these values.
value	number	The value of the severity.
unit	string	The unit of the severity value. The unit element can hold these values.

The TagInfo object

Tag of a Dynatrace entity.

Element Type Description

context

string

Element	Type	Description
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. The context element can hold these values.
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.

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

Custom tags use the CONTEXTLESS value.

The context element can hold these values.

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",
        "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
  }
}

Possible values

Possible values for the percentile element in the Event object:

50th
90th

Possible values for the browser element in the Event object:

APPLICATION
ENVIRONMENT
INFRASTRUCTURE
SERVICES

Possible values for the unit element in the EventSeverity object:

Bit (bit)
BitPerHour (bit/h)
BitPerMinute (bit/min)
BitPerSecond (bit/s)
Byte (B)
BytePerHour (B/h)
BytePerMinute (B/min)
BytePerSecond (B/s)
Cores
Count (count)
Day (ds)
G
GibiByte (GiB)
GigaByte (GB)
Hour (hs)
KibiByte (KiB)
KibiBytePerHour (KiB/h)
KibiBytePerMinute (KiB/min)
KibiBytePerSecond (KiB/s)
KiloByte (kB)
KiloBytePerHour (kB/h)
KiloBytePerMinute (kB/min)
KiloBytePerSecond (kB/s)
M
MebiByte (MiB)
MebiBytePerHour (MiB/h)
MebiBytePerMinute (MiB/min)
MebiBytePerSecond (MiB/s)
MegaByte (MB)
MegaBytePerHour (MB/h)
MegaBytePerMinute (MB/min)
MegaBytePerSecond (MB/s)
MicroSecond (µs)
MilliSecond (ms)
MilliSecondPerMinute (ms/min)
Minute (mins)
Month (mos)
N/A
NanoSecond (ns)
NanoSecondPerMinute (ns/min)
PerHour (count/h)
PerMinute (count/min)
PerSecond (count/s)
Percent (%)
Pixel (px)
Promille (‰)
Ratio
Second (s)
State
Unspecified
Week (ws)
Year (ys)
k
mCores

Possible values for the context element in the EventSeverity object:

COMMAND_ABORT
CPU_READY_TIME
CPU_USAGE
CRASH_RATE
FAILURE_RATE
HYPERVISOR_PACKETS_RECEIVED_DROPPED
HYPERVISOR_PACKETS_TRANSMITTED_DROPPED
MEMORY_COMPRESSION_RATE
MEMORY_DECOMPRESSION_RATE
MEMORY_SWAP_IN_RATE
MEMORY_SWAP_OUT_RATE
MEMORY_USAGE
NETWORK_HIGH_RECEIVED_UTILIZATION_RATE
NETWORK_HIGH_TRANSMITTED_UTILIZATION_RATE
NETWORK_PACKETS_RECEIVED_DROPPED
NETWORK_PACKETS_TRANSMITTED_DROPPED
NETWORK_RECEIVED_ERROR_RATE
NETWORK_TRANSMITTED_ERROR_RATE
PAGE_FAULTS
PG_AVAILABLE
RESPONSE_TIME_50TH_PERCENTILE
RESPONSE_TIME_90TH_PERCENTILE

Possible values for the eventType element in the Event object:

APPLICATION_JS_FRAMEWORK_DETECTED
AVAILABILITY_EVENT
CONNECTION_LOST
CPU_SATURATED
CUSTOM_ALERT
CUSTOM_ANNOTATION
CUSTOM_APP_CRASH_RATE_INCREASED
CUSTOM_CONFIGURATION
CUSTOM_DEPLOYMENT
CUSTOM_INFO
DATABASE_CONNECTION_FAILURE
DEPLOYMENT_CHANGED_CHANGE
DEPLOYMENT_CHANGED_NEW
DEPLOYMENT_CHANGED_REMOVED
DOCKER_MEMORY_SATURATION
EBS_VOLUME_HIGH_LATENCY
ELASTIC_LOAD_BALANCER_HIGH_BACKEND_FAILURE_RATE
ELASTIC_LOAD_BALANCER_HIGH_FAILURE_RATE
ELASTIC_LOAD_BALANCER_HIGH_UNHEALTHY_HOST_RATE
ERROR_EVENT
ESXI_START
FAILURE_RATE_INCREASED
HIGH_CONNECTIVITY_FAILURES
HIGH_DROPPED_PACKETS_RATE
HIGH_GC_ACTIVITY
HIGH_LATENCY
HIGH_NETWORK_ERROR_RATE
HIGH_NETWORK_LOSS_RATE
HIGH_NETWORK_UTILIZATION
HOST_CONNECTION_FAILED
HOST_CONNECTION_LOST
HOST_DATASTORE_LOW_DISK_SPACE
HOST_DISK_LOW_INODES
HOST_GRACEFULLY_SHUTDOWN
HOST_LOG_AVAILABILITY
HOST_LOG_ERROR
HOST_LOG_MATCHED
HOST_LOG_PERFORMANCE
HOST_MAINTENANCE
HOST_NO_CONNECTION
HOST_OF_SERVICE_UNAVAILABLE
HOST_SHUTDOWN
HOST_TIMEOUT
HTTP_CHECK_GLOBAL_OUTAGE
HTTP_CHECK_LOCAL_OUTAGE
HTTP_CHECK_TEST_LOCATION_SLOWDOWN
INSUFFICIENT_DISK_QUEUE_DEPTH
JAVASCRIPT_ERROR_RATE_INCREASED
LAMBDA_FUNCTION_HIGH_ERROR_RATE
LOG_AVAILABILITY
LOG_ERROR
LOG_MATCHED
LOG_PERFORMANCE
LOW_DISK_SPACE
LOW_STORAGE_SPACE
MARKED_FOR_TERMINATION
MEMORY_RESOURCES_EXHAUSTED
MEMORY_SATURATED
MOBILE_APP_CRASH_RATE_INCREASED
MONITORING_UNAVAILABLE
OPENSTACK_KEYSTONE_SLOW
OPENSTACK_KEYSTONE_UNHEALTHY
OSI_DOCKER_DEVICEMAPPER_LOW_DATA_SPACE
OSI_DOCKER_DEVICEMAPPER_LOW_METADATA_SPACE
OVERLOADED_STORAGE
PERFORMANCE_EVENT
PGI_CRASHED_INFO
PGI_HAPROXY_QUEUED_REQUESTS_HIGH
PGI_HAPROXY_SESSION_USAGE_HIGH
PGI_MYSQL_SLOW_QUERIES_RATE_HIGH
PGI_OF_SERVICE_UNAVAILABLE
PGI_RMQ_HIGH_FILE_DESC_USAGE
PGI_RMQ_HIGH_MEM_USAGE
PGI_RMQ_HIGH_PROCESS_USAGE
PGI_RMQ_HIGH_SOCKETS_USAGE
PGI_RMQ_LOW_DISK_SPACE
PROCESS_CRASHED
PROCESS_CUSTOM_AVAILABILITY
PROCESS_CUSTOM_ERROR
PROCESS_CUSTOM_PERFORMANCE
PROCESS_GROUP_LOW_INSTANCE_COUNT
PROCESS_LOG_AVAILABILITY
PROCESS_LOG_ERROR
PROCESS_LOG_PERFORMANCE
PROCESS_RESTART
PROCESS_UNAVAILABLE
RDS_OF_SERVICE_UNAVAILABLE
RDS_RESTART_SEQUENCE
RESOURCE_CONTENTION
SERVICE_RESPONSE_TIME_DEGRADED
SLOW_DISK
SYNTHETIC_AVAILABILITY
SYNTHETIC_SLOWDOWN
THREADS_RESOURCES_EXHAUSTED
UNEXPECTED_HIGH_LOAD
UNEXPECTED_LOW_LOAD
USER_ACTION_DURATION_DEGRADATION
VIRTUAL_MACHINE_SHUTDOWN
WEB_CHECK_GLOBAL_OUTAGE
WEB_CHECK_LOCAL_OUTAGE

Possible values for the context element in the TagInfo object:

AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES

Possible values for the severityLevel element in the Problem object:

AVAILABILITY
CUSTOM_ALERT
ERROR
MONITORING_UNAVAILABLE
PERFORMANCE
RESOURCE_CONTENTION

Possible values for the status element in the Problem object:

CLOSED
OPEN

Possible values for the impactLevel element in the Problem object:

APPLICATION
ENVIRONMENT
INFRASTRUCTURE
SERVICE

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