Dynatrace · Schema

EntityCollection

A paginated collection of monitored entities.

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 entities matching the query.
pageSize integer The number of results returned on this page.
entities array The list of entities on this page.
View JSON Schema on GitHub

JSON Schema

dynatrace-entities-v2-entity-collection-schema.json Raw ↑
{
  "type": "object",
  "description": "A paginated collection of monitored entities.",
  "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 entities matching the query.",
      "format": "int64",
      "example": 500
    },
    "pageSize": {
      "type": "integer",
      "description": "The number of results returned on this page.",
      "example": 500
    },
    "entities": {
      "type": "array",
      "description": "The list of entities on this page.",
      "example": [
        {
          "entityId": "abc123",
          "displayName": "Production Service",
          "type": "STANDARD",
          "firstSeenTms": 500,
          "lastSeenTms": 500,
          "properties": {},
          "tags": [
            {
              "context": "example-value",
              "key": "example-value",
              "value": "example-value",
              "stringRepresentation": "example-value"
            }
          ],
          "managementZones": [
            {
              "id": "abc123",
              "name": "Production Service"
            }
          ],
          "toRelationships": {},
          "fromRelationships": {}
        }
      ],
      "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.",
            "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": "integer",
            "description": "The Unix timestamp in milliseconds when the entity was first seen.",
            "format": "int64",
            "example": 500
          },
          "lastSeenTms": {
            "type": "integer",
            "description": "The Unix timestamp in milliseconds when the entity was last seen.",
            "format": "int64",
            "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.",
            "example": {}
          },
          "tags": {
            "type": "array",
            "description": "The list of tags applied to the entity, including auto-detected and manually defined tags.",
            "example": [
              {
                "context": "example-value",
                "key": "example-value",
                "value": "example-value",
                "stringRepresentation": "example-value"
              }
            ],
            "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.",
                  "example": "example-value"
                },
                "key": {
                  "type": "string",
                  "description": "The key of the tag.",
                  "example": "example-value"
                },
                "value": {
                  "type": "string",
                  "description": "The value of the tag, if applicable.",
                  "example": "example-value"
                },
                "stringRepresentation": {
                  "type": "string",
                  "description": "The full string representation of the tag as displayed in the Dynatrace UI, e.g., [KUBERNETES]app:my-service.",
                  "example": "example-value"
                }
              }
            }
          },
          "managementZones": {
            "type": "array",
            "description": "The management zones that the entity belongs to, used for access control and organizational 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"
                }
              }
            }
          },
          "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\"]}.",
            "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\"]}.",
            "example": {}
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EntityCollection"
}