API Evangelist conversational phrasing for Datadog APM — APM, Spans and Service Definitions (API v2) APM Retention Filters API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Datadog APM — APM, Spans and Service Definitions (API v2) APM Retention Filters API
  version: 1.0.0
extends: openapi/datadog-apm-apm-retention-filters-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api/v2/apm/config/retention-filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List APM retention filters
      effect: read
      questions:
      - Which retention filters decide what spans get indexed in my Datadog org?
      - What span retention filters do we have configured today?
      instructions:
      - text: List all of my APM retention filters.
      - text: Show me every span retention filter configured in the organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/retention-filters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a span retention filter
      effect: write
      questions:
      - How do I start indexing a specific slice of my spans with a new retention filter?
      - Can I create my own error or AppSec sampling retention filter, or are those defaults only?
      instructions:
      - text: Create a new APM retention filter defined by {filter}.
        slots:
          filter: requestBody.data
      - text: Add a retention filter that indexes spans matching {filter}.
        slots:
          filter: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/retention-filters-execution-order'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the execution order of retention filters
      effect: write
      questions:
      - Can I change the order in which my retention filters are evaluated?
      - How do I make one retention filter run before the others?
      instructions:
      - text: 'Re-order my retention filters to run in this sequence: {filters}.'
        slots:
          filters: requestBody.data
      - text: Set the retention filter execution order to {filters}.
        slots:
          filters: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/retention-filters/{filter_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one APM retention filter
      effect: read
      questions:
      - What query and sample rate does a particular retention filter use?
      - Can I look up a single retention filter by its ID?
      instructions:
      - text: Get the details of retention filter {filter_id}.
        slots:
          filter_id: path.filter_id
      - text: Show me how retention filter {filter_id} is configured.
        slots:
          filter_id: path.filter_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/retention-filters/{filter_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a span retention filter
      effect: write
      questions:
      - How do I change the query or rate on a retention filter I already have?
      - Can I rename one of the default error sampling retention filters?
      instructions:
      - text: Update retention filter {filter_id} with {changes}.
        slots:
          filter_id: path.filter_id
          changes: requestBody.data
      - text: Change the existing retention filter {filter_id} so its definition becomes {changes}.
        slots:
          filter_id: path.filter_id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/retention-filters/{filter_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a span retention filter
      effect: destructive
      questions:
      - How do I stop a retention filter from indexing spans by removing it?
      - Can the default AppSec sampling retention filter be deleted?
      instructions:
      - text: Delete retention filter {filter_id}.
        slots:
          filter_id: path.filter_id
      - text: Remove the APM retention filter {filter_id} from my organization.
        slots:
          filter_id: path.filter_id
      method: generated
      generated: '2026-09-26'