Dynatrace · Schema

ProblemCollection

A paginated collection of problems.

AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

Properties

Name Type Description
nextPageKey string Cursor for the next page of results. Null if no more pages.
totalCount integer The total number of problems matching the query.
pageSize integer The number of results returned on this page.
problems array The list of problems on this page.
View JSON Schema on GitHub

JSON Schema

dynatrace-problems-v2-problem-collection-schema.json Raw ↑
{
  "type": "object",
  "description": "A paginated collection of problems.",
  "properties": {
    "nextPageKey": {
      "type": "string",
      "description": "Cursor for the next page of results. Null if no more pages.",
      "example": "example-value"
    },
    "totalCount": {
      "type": "integer",
      "description": "The total number of problems matching the query.",
      "format": "int64",
      "example": 500
    },
    "pageSize": {
      "type": "integer",
      "description": "The number of results returned on this page.",
      "example": 500
    },
    "problems": {
      "type": "array",
      "description": "The list of problems on this page.",
      "example": [
        {
          "problemId": "abc123",
          "displayId": "abc123",
          "title": "example-value",
          "severityLevel": "AVAILABILITY",
          "status": "OPEN",
          "startTime": 1718153645993,
          "endTime": 1718153645993,
          "affectedEntities": [
            {
              "entityId": "abc123",
              "name": "Production Service",
              "type": "STANDARD"
            }
          ],
          "impactedEntities": [
            {
              "entityId": "abc123",
              "name": "Production Service",
              "type": "STANDARD"
            }
          ],
          "rootCauseEntity": "example-value",
          "managementZones": [
            {
              "id": "abc123",
              "name": "Production Service"
            }
          ],
          "problemFilters": [
            {
              "id": "abc123",
              "name": "Production Service"
            }
          ]
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents a Dynatrace-detected problem, which is an aggregated set of related events indicating a service degradation. Problems are detected and correlated by the Davis AI engine.",
        "properties": {
          "problemId": {
            "type": "string",
            "description": "The internal unique identifier of the problem, e.g., -1234567890123456789_V2.",
            "example": "abc123"
          },
          "displayId": {
            "type": "string",
            "description": "The human-readable problem identifier displayed in the Dynatrace UI, e.g., P-123456.",
            "example": "abc123"
          },
          "title": {
            "type": "string",
            "description": "The title summarizing the nature of the problem, generated by the Davis AI.",
            "example": "example-value"
          },
          "severityLevel": {
            "type": "string",
            "description": "The severity classification of the problem, indicating the type of impact.",
            "example": "AVAILABILITY",
            "enum": [
              "AVAILABILITY",
              "ERROR",
              "PERFORMANCE",
              "RESOURCE_CONTENTION",
              "CUSTOM_ALERT"
            ]
          },
          "status": {
            "type": "string",
            "description": "The current status of the problem.",
            "example": "OPEN",
            "enum": [
              "OPEN",
              "RESOLVED"
            ]
          },
          "startTime": {
            "type": "integer",
            "description": "The Unix timestamp in milliseconds when the problem was first detected.",
            "format": "int64",
            "example": 1718153645993
          },
          "endTime": {
            "type": "integer",
            "description": "The Unix timestamp in milliseconds when the problem was resolved. Returns -1 if the problem is still open.",
            "format": "int64",
            "example": 1718153645993
          },
          "affectedEntities": {
            "type": "array",
            "description": "The list of entities directly affected by the problem. These are the entities where the anomaly was first detected.",
            "example": [
              {
                "entityId": "abc123",
                "name": "Production Service",
                "type": "STANDARD"
              }
            ],
            "items": {
              "type": "object",
              "description": "A lightweight reference to a monitored entity.",
              "properties": {
                "entityId": {
                  "type": "string",
                  "description": "The unique identifier of the entity, e.g., SERVICE-1234567890ABCDEF.",
                  "example": "abc123"
                },
                "name": {
                  "type": "string",
                  "description": "The display name of the entity.",
                  "example": "Production Service"
                },
                "type": {
                  "type": "string",
                  "description": "The type of the entity, e.g., SERVICE, HOST, PROCESS_GROUP, APPLICATION.",
                  "example": "STANDARD"
                }
              }
            }
          },
          "impactedEntities": {
            "type": "array",
            "description": "The list of entities experiencing degradation as a result of the problem, including downstream dependencies.",
            "example": [
              {
                "entityId": "abc123",
                "name": "Production Service",
                "type": "STANDARD"
              }
            ],
            "items": {
              "type": "object",
              "description": "A lightweight reference to a monitored entity.",
              "properties": {
                "entityId": {
                  "type": "string",
                  "description": "The unique identifier of the entity, e.g., SERVICE-1234567890ABCDEF.",
                  "example": "abc123"
                },
                "name": {
                  "type": "string",
                  "description": "The display name of the entity.",
                  "example": "Production Service"
                },
                "type": {
                  "type": "string",
                  "description": "The type of the entity, e.g., SERVICE, HOST, PROCESS_GROUP, APPLICATION.",
                  "example": "STANDARD"
                }
              }
            }
          },
          "rootCauseEntity": {
            "type": "object",
            "description": "The entity identified by Davis AI as the root cause of the problem. Null if the root cause could not be determined.",
            "example": "example-value"
          },
          "managementZones": {
            "type": "array",
            "description": "The management zones that contain the affected entities, used for access control and scoping.",
            "example": [
              {
                "id": "abc123",
                "name": "Production Service"
              }
            ],
            "items": {
              "type": "object",
              "description": "A management zone reference.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique identifier of the management zone.",
                  "example": "abc123"
                },
                "name": {
                  "type": "string",
                  "description": "The display name of the management zone.",
                  "example": "Production Service"
                }
              }
            }
          },
          "problemFilters": {
            "type": "array",
            "description": "The alerting profiles (problem filters) that match this problem and control notification routing.",
            "example": [
              {
                "id": "abc123",
                "name": "Production Service"
              }
            ],
            "items": {
              "type": "object",
              "description": "A reference to an alerting profile (problem filter).",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique identifier of the alerting profile.",
                  "example": "abc123"
                },
                "name": {
                  "type": "string",
                  "description": "The display name of the alerting profile.",
                  "example": "Production Service"
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ProblemCollection"
}