Datadog · Schema

EventsSearchRequest

Request body for searching events using the Events Explorer query language

AnalyticsDashboardsMonitoringPlatformT1Visualizations

Properties

Name Type Description
filter object Filter configuration for the event search
sort string Sort order for the returned events
page object Pagination settings for the event search results
View JSON Schema on GitHub

JSON Schema

datadog-events-events-search-request-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-search-request-schema.json",
  "title": "EventsSearchRequest",
  "description": "Request body for searching events using the Events Explorer query language",
  "type": "object",
  "properties": {
    "filter": {
      "type": "object",
      "description": "Filter configuration for the event search",
      "properties": {
        "query": {
          "type": "string",
          "description": "A Datadog events search query to filter events by text, tags, and attributes"
        },
        "from": {
          "type": "string",
          "description": "The start of the search time range as an ISO 8601 timestamp or relative time"
        },
        "to": {
          "type": "string",
          "description": "The end of the search time range as an ISO 8601 timestamp or relative time"
        }
      }
    },
    "sort": {
      "type": "string",
      "description": "Sort order for the returned events",
      "enum": [
        "timestamp",
        "-timestamp"
      ],
      "example": "timestamp"
    },
    "page": {
      "type": "object",
      "description": "Pagination settings for the event search results",
      "properties": {
        "cursor": {
          "type": "string",
          "description": "Cursor token from a previous response to retrieve the next page"
        },
        "limit": {
          "type": "integer",
          "description": "Maximum number of events to return per page",
          "minimum": 1,
          "maximum": 1000,
          "default": 10
        }
      }
    }
  }
}