Dynatrace Problem Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/dynatrace/refs/heads/main/json-structure/dynatrace-problem-structure.json",
  "description": "A Dynatrace-detected problem representing an aggregated service degradation identified by the Davis AI engine. Problems correlate multiple related anomaly events into a single issue with severity, root cause analysis, and affected entity information.",
  "type": "object",
  "required": [
    "problemId",
    "title",
    "severityLevel",
    "status",
    "startTime"
  ],
  "properties": {
    "problemId": {
      "type": "string",
      "description": "The internal unique identifier of the problem, e.g., -1234567890123456789_V2. Used in API calls to retrieve or act on this specific problem.",
      "examples": [
        "-1234567890123456789_V2"
      ]
    },
    "displayId": {
      "type": "string",
      "description": "The human-readable problem identifier displayed in the Dynatrace UI, e.g., P-123456. This is the ID referenced in notifications and alert messages.",
      "pattern": "^P-[0-9]+$",
      "examples": [
        "P-123456",
        "P-987654"
      ]
    },
    "title": {
      "type": "string",
      "description": "The title of the problem, generated by the Davis AI engine to summarize the nature and scope of the detected degradation.",
      "examples": [
        "High failure rate on checkout-service",
        "Response time degradation on payment-service",
        "Host CPU saturation on web-01"
      ]
    },
    "severityLevel": {
      "type": "string",
      "description": "The severity classification of the problem, indicating the category of service impact detected by Davis AI.",
      "enum": [
        "AVAILABILITY",
        "ERROR",
        "PERFORMANCE",
        "RESOURCE_CONTENTION",
        "CUSTOM_ALERT"
      ]
    },
    "status": {
      "type": "string",
      "description": "The current lifecycle status of the problem.",
      "enum": [
        "OPEN",
        "RESOLVED"
      ]
    },
    "startTime": {
      "type": "int64",
      "description": "The Unix timestamp in milliseconds when the problem was first detected by Davis AI.",
      "minimum": 0,
      "examples": [
        1609459200000
      ]
    },
    "endTime": {
      "type": "int64",
      "description": "The Unix timestamp in milliseconds when the problem was resolved. Returns -1 if the problem is still open (status is OPEN).",
      "examples": [
        1609462800000,
        -1
      ]
    },
    "affectedEntities": {
      "type": "array",
      "description": "The list of entities directly affected by the problem \u2014 those where the anomaly was first detected by Davis AI.",
      "items": {
        "$ref": "#/$defs/EntityStub"
      }
    },
    "impactedEntities": {
      "type": "array",
      "description": "The list of entities experiencing service degradation as a downstream consequence of the problem, including dependent services and infrastructure.",
      "items": {
        "$ref": "#/$defs/EntityStub"
      }
    },
    "rootCauseEntity": {
      "description": "The entity identified by Davis AI as the root cause of the problem. Null if the root cause could not be determined or if insufficient data is available.",
      "oneOf": [
        {
          "$ref": "#/$defs/EntityStub"
        },
        {
          "type": "null"
        }
      ]
    },
    "managementZones": {
      "type": "array",
      "description": "The management zones that contain the affected entities. Management zones are used for access control and organizational scoping within Dynatrace.",
      "items": {
        "$ref": "#/$defs/ManagementZone"
      }
    },
    "tags": {
      "type": "array",
      "description": "Tags applied to the affected entities that were relevant at the time the problem was detected. Useful for routing notifications and categorizing problems.",
      "items": {
        "$ref": "#/$defs/Tag"
      }
    },
    "evidenceDetails": {
      "type": "object",
      "description": "Root cause evidence collected by Davis AI, including the anomaly evidence items that contributed to problem detection and root cause determination.",
      "properties": {
        "totalCount": {
          "type": "int32",
          "description": "The total number of evidence items for this problem."
        },
        "details": {
          "type": "array",
          "description": "The list of individual evidence items.",
          "items": {
            "type": "object",
            "description": "A single piece of evidence contributing to root cause analysis."
          }
        }
      }
    },
    "comments": {
      "type": "object",
      "description": "Comments attached to the problem for collaboration and tracking investigation notes.",
      "properties": {
        "totalCount": {
          "type": "int32",
          "description": "The total number of comments on this problem."
        },
        "items": {
          "type": "array",
          "description": "The list of comments.",
          "items": {
            "type": "object",
            "description": "A single comment on the problem.",
            "properties": {
              "id": {
                "type": "string",
                "description": "The unique identifier of the comment."
              },
              "createdAtTimestamp": {
                "type": "int64",
                "description": "The Unix timestamp in milliseconds when the comment was created."
              },
              "authorName": {
                "type": "string",
                "description": "The display name of the comment author."
              },
              "content": {
                "type": "string",
                "description": "The text content of the comment."
              },
              "context": {
                "type": "string",
                "description": "Optional context reference, such as a ticket ID or runbook URL."
              }
            }
          }
        }
      }
    }
  },
  "$defs": {
    "EntityStub": {
      "type": "object",
      "title": "Entity Stub",
      "description": "A lightweight reference to a monitored entity, containing the minimum fields needed to identify and display the entity.",
      "properties": {
        "entityId": {
          "type": "string",
          "description": "The unique Dynatrace entity identifier in the format TYPE-HEXADECIMALID, e.g., SERVICE-1234567890ABCDEF.",
          "pattern": "^[A-Z_]+-[0-9A-F]+$",
          "examples": [
            "SERVICE-ABCDEF1234567890",
            "HOST-1234567890ABCDEF",
            "PROCESS_GROUP-ABCDEF1234567890"
          ]
        },
        "name": {
          "type": "string",
          "description": "The display name of the entity as shown in the Dynatrace UI.",
          "examples": [
            "payment-service",
            "web-01",
            "checkout-service"
          ]
        },
        "type": {
          "type": "string",
          "description": "The entity type identifier, e.g., SERVICE, HOST, PROCESS_GROUP, APPLICATION.",
          "examples": [
            "SERVICE",
            "HOST",
            "PROCESS_GROUP",
            "APPLICATION"
          ]
        }
      }
    },
    "ManagementZone": {
      "type": "object",
      "title": "Management Zone",
      "description": "A reference to a Dynatrace management zone, used for access control and organizational scoping.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier of the management zone."
        },
        "name": {
          "type": "string",
          "description": "The display name of the management zone.",
          "examples": [
            "Production",
            "US-East",
            "Team-Payments"
          ]
        }
      }
    },
    "Tag": {
      "type": "object",
      "title": "Tag",
      "description": "A tag applied to a monitored entity. Tags provide metadata for filtering, routing, and categorizing entities and problems.",
      "properties": {
        "context": {
          "type": "string",
          "description": "The origin context of the tag, indicating how it was applied.",
          "enum": [
            "CONTEXTLESS",
            "ENVIRONMENT",
            "AWS",
            "AZURE",
            "CLOUD_FOUNDRY",
            "GOOGLE_CLOUD",
            "KUBERNETES"
          ]
        },
        "key": {
          "type": "string",
          "description": "The key of the tag.",
          "examples": [
            "env",
            "team",
            "version"
          ]
        },
        "value": {
          "type": [
            "string",
            "null"
          ],
          "description": "The value associated with the tag key. Null for tags without a value.",
          "examples": [
            "production",
            "payments",
            null
          ]
        },
        "stringRepresentation": {
          "type": "string",
          "description": "The full string representation of the tag as displayed in the Dynatrace UI. For example, [KUBERNETES]env:production or [ENVIRONMENT]team:backend.",
          "examples": [
            "[KUBERNETES]env:production",
            "[ENVIRONMENT]team:backend",
            "my-contextless-tag"
          ]
        }
      }
    }
  },
  "name": "Dynatrace Problem"
}