Datadog · Schema

IncidentsResponse

Response containing a paginated list of incidents

AnalyticsDashboardsMonitoringPlatformT1Visualizations

Properties

Name Type Description
data array List of incident objects
included array Related resources included in the response based on the include query parameter
meta object Metadata about the incidents list response
View JSON Schema on GitHub

JSON Schema

datadog-incidents-incidents-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-incidents-incidents-response-schema.json",
  "title": "IncidentsResponse",
  "description": "Response containing a paginated list of incidents",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "List of incident objects",
      "items": {
        "$ref": "#/components/schemas/Incident"
      }
    },
    "included": {
      "type": "array",
      "description": "Related resources included in the response based on the include query parameter",
      "items": {
        "type": "object"
      }
    },
    "meta": {
      "type": "object",
      "description": "Metadata about the incidents list response",
      "properties": {
        "pagination": {
          "type": "object",
          "description": "Pagination information for navigating through results",
          "properties": {
            "next_offset": {
              "type": "integer",
              "description": "The offset to use in the next request to retrieve the next page"
            },
            "prev_offset": {
              "type": "integer",
              "description": "The offset to use to retrieve the previous page"
            },
            "size": {
              "type": "integer",
              "description": "The number of incidents in this page"
            },
            "total_count": {
              "type": "integer",
              "description": "The total number of incidents matching the filter criteria"
            }
          }
        }
      }
    }
  }
}