Dynatrace · JSON Structure

Entities Api V2 Entity Structure

Represents a monitored entity in Dynatrace. Entities are the components of your monitored environment such as services, hosts, processes, and applications. Each entity has a unique ID, a type, properties, tags, and relationships to other entities.

Type: object Properties: 10
AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

Entity is a JSON Structure definition published by Dynatrace, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

entityId displayName type firstSeenTms lastSeenTms properties tags managementZones toRelationships fromRelationships

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/dynatrace/refs/heads/main/json-structure/entities-api-v2-entity-structure.json",
  "description": "Represents a monitored entity in Dynatrace. Entities are the components of your monitored environment such as services, hosts, processes, and applications. Each entity has a unique ID, a type, properties, tags, and relationships to other entities.",
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "The unique identifier of the entity in the format TYPE-HEXADECIMALID, e.g., SERVICE-1234567890ABCDEF.",
      "example": "abc123"
    },
    "displayName": {
      "type": "string",
      "description": "The human-readable display name of the entity.",
      "example": "Production Service"
    },
    "type": {
      "type": "string",
      "description": "The type of the entity, e.g., SERVICE, HOST, PROCESS_GROUP, APPLICATION, SYNTHETIC_TEST.",
      "example": "STANDARD"
    },
    "firstSeenTms": {
      "type": "int64",
      "description": "The Unix timestamp in milliseconds when the entity was first seen.",
      "example": 500
    },
    "lastSeenTms": {
      "type": "int64",
      "description": "The Unix timestamp in milliseconds when the entity was last seen.",
      "example": 500
    },
    "properties": {
      "type": "object",
      "description": "A map of entity-type-specific properties. Available properties vary by entity type. For example, a HOST entity may include osType, cpuCores, and memoryTotalBytes.",
      "additionalProperties": true,
      "example": {}
    },
    "tags": {
      "type": "array",
      "description": "The list of tags applied to the entity, including auto-detected and manually defined tags.",
      "items": {
        "$ref": "#/components/schemas/EntityTag"
      },
      "example": [
        {
          "context": "example-value",
          "key": "example-value",
          "value": "example-value",
          "stringRepresentation": "example-value"
        }
      ]
    },
    "managementZones": {
      "type": "array",
      "description": "The management zones that the entity belongs to, used for access control and organizational scoping.",
      "items": {
        "$ref": "#/components/schemas/ManagementZone"
      },
      "example": [
        {
          "id": "abc123",
          "name": "Production Service"
        }
      ]
    },
    "toRelationships": {
      "type": "object",
      "description": "Relationships where this entity is the target. Keys are relationship types (e.g., isProcessOf), values are arrays of entity IDs. For example, {\"isProcessOf\": [\"PROCESS_GROUP-123\"]}.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "example": {}
    },
    "fromRelationships": {
      "type": "object",
      "description": "Relationships where this entity is the source. Keys are relationship types (e.g., runsOn), values are arrays of entity IDs. For example, {\"runsOn\": [\"HOST-456\"]}.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "example": {}
    }
  },
  "name": "Entity"
}