Datadog APM · OpenAPI Overlay 1.0.0

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

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/v2/apm/config/metrics'].get
$.paths['/api/v2/apm/config/metrics'].post
$.paths['/api/v2/apm/config/metrics/{metric_id}'].get
$.paths['/api/v2/apm/config/metrics/{metric_id}'].delete
$.paths['/api/v2/apm/config/metrics/{metric_id}'].patch

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 APM — APM, Spans and Service Definitions (API v2) Spans Metrics API
  version: 1.0.0
extends: openapi/datadog-apm-spans-metrics-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: 5
- target: $.paths['/api/v2/apm/config/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List span-based metrics
      effect: read
      questions:
      - Which custom metrics have we generated from our ingested spans?
      - What span-based metric definitions are configured in Datadog?
      instructions:
      - text: List all span-based metrics and their definitions.
      - text: Show me every metric we generate from spans.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a metric from ingested spans
      effect: write
      questions:
      - How do I turn span data into a long-lived metric?
      - Can I build a metric that counts spans matching a query?
      instructions:
      - text: Create a span-based metric with {metric}.
        slots:
          metric: requestBody.data
      - text: Generate a new metric from ingested spans defined as {metric}.
        slots:
          metric: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/metrics/{metric_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one span-based metric
      effect: read
      questions:
      - What filter and group-bys does a particular span-based metric use?
      - Can I fetch a single span metric by its name?
      instructions:
      - text: Get the span-based metric {metric_id}.
        slots:
          metric_id: path.metric_id
      - text: Show how span metric {metric_id} is defined.
        slots:
          metric_id: path.metric_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/metrics/{metric_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a span-based metric
      effect: destructive
      questions:
      - How do I stop generating a metric from spans?
      - Can I remove a span-based metric we no longer use?
      instructions:
      - text: Delete the span-based metric {metric_id}.
        slots:
          metric_id: path.metric_id
      - text: Remove span metric {metric_id} from the organization.
        slots:
          metric_id: path.metric_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/apm/config/metrics/{metric_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a span-based metric
      effect: write
      questions:
      - Can I change the filter on an existing span-based metric?
      - What can I modify on a span metric after it's been created?
      instructions:
      - text: Update span-based metric {metric_id} with {changes}.
        slots:
          metric_id: path.metric_id
          changes: requestBody.data
      - text: Change the definition of existing span metric {metric_id} to {changes}.
        slots:
          metric_id: path.metric_id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'