Datadog · Schema

EventsListResponse

Response containing a paginated list of events from the Events Explorer

AnalyticsDashboardsMonitoringPlatformT1Visualizations

Properties

Name Type Description
data array List of event objects matching the search criteria
links object Pagination links for navigating through the result set
meta object Metadata about the event list response
View JSON Schema on GitHub

JSON Schema

datadog-events-events-list-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/datadog/refs/heads/main/json-schema/datadog-events-events-list-response-schema.json",
  "title": "EventsListResponse",
  "description": "Response containing a paginated list of events from the Events Explorer",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "List of event objects matching the search criteria",
      "items": {
        "$ref": "#/components/schemas/Event"
      }
    },
    "links": {
      "type": "object",
      "description": "Pagination links for navigating through the result set",
      "properties": {
        "next": {
          "type": "string",
          "description": "URL for the next page of results; absent if this is the last page"
        }
      }
    },
    "meta": {
      "type": "object",
      "description": "Metadata about the event list response",
      "properties": {
        "page": {
          "type": "object",
          "description": "Pagination cursor information for this response",
          "properties": {
            "after": {
              "type": "string",
              "description": "Cursor token to pass in the next request to retrieve the next page of results"
            }
          }
        },
        "elapsed": {
          "type": "integer",
          "description": "Time in milliseconds taken to process the event search query"
        },
        "request_id": {
          "type": "string",
          "description": "A unique identifier for this search request, useful for debugging"
        },
        "status": {
          "type": "string",
          "description": "The completion status of the search request",
          "enum": [
            "done",
            "timeout"
          ]
        },
        "warnings": {
          "type": "array",
          "description": "List of non-fatal warning messages about the search query or results",
          "items": {
            "type": "object"
          }
        }
      }
    }
  }
}