Dynatrace · JSON Structure

Dynatrace Entities V2 Entity Collection Structure

A paginated collection of monitored entities.

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

EntityCollection is a JSON Structure definition published by Dynatrace, describing 4 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

nextPageKey totalCount pageSize entities

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "A paginated collection of monitored entities.",
  "name": "EntityCollection",
  "properties": {
    "nextPageKey": {
      "type": "string",
      "description": "Cursor for the next page of results. Null if no more pages."
    },
    "totalCount": {
      "type": "integer",
      "description": "The total number of entities matching the query."
    },
    "pageSize": {
      "type": "integer",
      "description": "The number of results returned on this page."
    },
    "entities": {
      "type": "array",
      "description": "The list of entities on this page.",
      "items": {
        "type": "object",
        "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.",
        "properties": {
          "entityId": {
            "type": "string",
            "description": "The unique identifier of the entity in the format TYPE-HEXADECIMALID, e.g., SERVICE-1234567890ABCDEF."
          },
          "displayName": {
            "type": "string",
            "description": "The human-readable display name of the entity."
          },
          "type": {
            "type": "string",
            "description": "The type of the entity, e.g., SERVICE, HOST, PROCESS_GROUP, APPLICATION, SYNTHETIC_TEST."
          },
          "firstSeenTms": {
            "type": "integer",
            "description": "The Unix timestamp in milliseconds when the entity was first seen."
          },
          "lastSeenTms": {
            "type": "integer",
            "description": "The Unix timestamp in milliseconds when the entity was last seen."
          },
          "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."
          },
          "tags": {
            "type": "array",
            "description": "The list of tags applied to the entity, including auto-detected and manually defined tags.",
            "items": {
              "type": "object",
              "description": "A tag applied to a monitored entity.",
              "properties": {
                "context": {
                  "type": "string",
                  "description": "The origin context of the tag. For example, CONTEXTLESS, ENVIRONMENT, AWS, KUBERNETES, etc."
                },
                "key": {
                  "type": "string",
                  "description": "The key of the tag."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the tag, if applicable."
                },
                "stringRepresentation": {
                  "type": "string",
                  "description": "The full string representation of the tag as displayed in the Dynatrace UI, e.g., [KUBERNETES]app:my-service."
                }
              }
            }
          },
          "managementZones": {
            "type": "array",
            "description": "The management zones that the entity belongs to, used for access control and organizational scoping.",
            "items": {
              "type": "object",
              "description": "A management zone reference.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique identifier of the management zone."
                },
                "name": {
                  "type": "string",
                  "description": "The display name of the management zone."
                }
              }
            }
          },
          "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\"]}."
          },
          "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\"]}."
          }
        }
      }
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}