Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Historical API

3 actions 3 updates phrasing extends openapi/datadog-historical-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/siem-historical-detections/jobs'].get
$.paths['/api/v2/siem-historical-detections/jobs'].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 Historical API
  version: 1.0.0
extends: openapi/datadog-historical-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/siem-historical-detections/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List historical detection jobs
      effect: read
      questions:
      - Which SIEM historical detection jobs have I run?
      - Can I page through historical jobs up to 100 at a time?
      instructions:
      - text: List my historical detection jobs.
      - text: List historical jobs matching {query}.
        slots:
          query: query.filter[query]
      - text: Show {size} historical jobs per page sorted by {sort}.
        slots:
          size: query.page[size]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/siem-historical-detections/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a historical detection job
      effect: write
      questions:
      - How do I run a detection rule against past logs?
      - Can I backtest a rule over historical data?
      instructions:
      - text: Run a historical detection job with {data}.
        slots:
          data: requestBody.data
      - text: Start a backfill detection job using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'