Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Metrics API

7 actions 7 updates phrasing extends openapi/datadog-metrics-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 7

$.info
$.paths['/api/v2/apm/config/metrics/{metric_id}'].patch
$.paths['/api/v2/logs/config/metrics/{metric_id}'].patch
$.paths['/api/v2/rum/config/metrics/{metric_id}'].patch
$.paths['/api/v2/series'].post
$.paths['/api/v2/query/timeseries'].post
$.paths['/api/v2/query/scalar'].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 Metrics API
  version: 1.0.0
extends: openapi/datadog-metrics-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: 6
- 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 group-by tags on a span-based metric?
      - Is it possible to edit a metric generated from APM spans?
      instructions:
      - text: Update span-based metric {metric_id} with {data}.
        slots:
          metric_id: path.metric_id
          data: requestBody.data
      - text: Change the filter on span metric {metric_id}.
        slots:
          metric_id: path.metric_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/metrics/{metric_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a log-based metric
      effect: write
      questions:
      - Can I change the grouping on a metric generated from logs?
      - Is editing a log-based metric's filter possible?
      instructions:
      - text: Update log-based metric {metric_id} with {data}.
        slots:
          metric_id: path.metric_id
          data: requestBody.data
      - text: Change the group-by on log metric {metric_id}.
        slots:
          metric_id: path.metric_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/config/metrics/{metric_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a RUM-based metric
      effect: write
      questions:
      - Can I edit a metric generated from RUM events?
      - Is it possible to add tags to a rum-based metric?
      instructions:
      - text: Update RUM-based metric {metric_id} with {data}.
        slots:
          metric_id: path.metric_id
          data: requestBody.data
      - text: Change the filter on RUM metric {metric_id}.
        slots:
          metric_id: path.metric_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/series'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit custom metric data points
      effect: write
      questions:
      - How do I send my own time-series metrics to Datadog?
      - What's the maximum payload size when posting metrics?
      - Can I send compressed metric payloads?
      instructions:
      - text: Submit the series {series} to Datadog.
        slots:
          series: requestBody.series
      - text: Post metrics {series} compressed with {encoding}.
        slots:
          series: requestBody.series
          encoding: header.Content-Encoding
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/query/timeseries'].post
  update:
    x-apievangelist-phrasing:
      intent: Query metric timeseries data
      effect: read
      questions:
      - Can I pull metric values over time for a chart outside Datadog?
      - Is it possible to run several metric queries in one timeseries request?
      instructions:
      - text: Query the timeseries for {data}.
        slots:
          data: requestBody.data
      - text: Fetch CPU usage points over the last hour as a timeseries.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/query/scalar'].post
  update:
    x-apievangelist-phrasing:
      intent: Query a scalar metric value
      effect: read
      questions:
      - What was the average latency over the last day as a single number?
      - Can I compute a percentile across a time window in one value?
      instructions:
      - text: Compute a scalar value for {data}.
        slots:
          data: requestBody.data
      - text: Get the summed request count for the past 24 hours as one value.
      method: generated
      generated: '2026-10-01'