Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Search API

3 actions 3 updates phrasing extends openapi/datadog-search-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Datadog's API. It is a proposal applied on top of the contract, not a document Datadog publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v2/incidents/search'].get
$.paths['/api/v2/spans/events/search'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Datadog Search API
  version: 1.0.0
extends: openapi/datadog-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/v2/incidents/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search incidents
      effect: read
      questions:
      - Which incidents are still active?
      - Can I search incidents by severity or state?
      instructions:
      - text: Search incidents for {query}.
        slots:
          query: query.query
      - text: Find incidents matching {query} sorted by {sort}.
        slots:
          query: query.query
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/spans/events/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search APM spans
      effect: read
      questions:
      - Can I search individual trace spans with a complex query?
      - What's the rate limit for searching spans?
      instructions:
      - text: Search spans with {data}.
        slots:
          data: requestBody.data
      - text: Find spans from the checkout service with errors in the last hour.
      method: generated
      generated: '2026-10-01'