Dynatrace · Schema

EventCollection

A paginated collection of events.

AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

Properties

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

JSON Schema

dynatrace-events-v2-event-collection-schema.json Raw ↑
{
  "type": "object",
  "description": "A paginated collection of events.",
  "properties": {
    "nextPageKey": {
      "type": "string",
      "description": "The cursor for the next page of results. Null if there are no more pages.",
      "example": "example-value"
    },
    "totalCount": {
      "type": "integer",
      "description": "The total number of events matching the query.",
      "format": "int64",
      "example": 500
    },
    "pageSize": {
      "type": "integer",
      "description": "The number of results returned on this page.",
      "example": 500
    },
    "events": {
      "type": "array",
      "description": "The list of events on this page.",
      "example": [
        {
          "eventId": "abc123",
          "eventType": "STANDARD",
          "title": "example-value",
          "startTime": 1718153645993,
          "endTime": 1718153645993,
          "entityId": {},
          "properties": {},
          "status": "OPEN"
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents a single event in the Dynatrace environment. Events can be ingested via the API or detected automatically by Dynatrace.",
        "properties": {
          "eventId": {
            "type": "string",
            "description": "The unique identifier of the event.",
            "example": "abc123"
          },
          "eventType": {
            "type": "string",
            "description": "The type of the event.",
            "example": "STANDARD"
          },
          "title": {
            "type": "string",
            "description": "The display title of the event.",
            "example": "example-value"
          },
          "startTime": {
            "type": "integer",
            "description": "The start time of the event as a Unix timestamp in milliseconds.",
            "format": "int64",
            "example": 1718153645993
          },
          "endTime": {
            "type": "integer",
            "description": "The end time of the event as a Unix timestamp in milliseconds. Null for open events.",
            "format": "int64",
            "example": 1718153645993
          },
          "entityId": {
            "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"
              }
            }
          },
          "properties": {
            "type": "object",
            "description": "Additional key-value metadata attached to the event.",
            "example": {}
          },
          "status": {
            "type": "string",
            "description": "The current status of the event. OPEN indicates the event is still active; CLOSED indicates it has ended.",
            "example": "OPEN",
            "enum": [
              "OPEN",
              "CLOSED"
            ]
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EventCollection"
}