Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Aggregate API

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

$.info
$.paths['/api/v2/ci/pipelines/analytics/aggregate'].post
$.paths['/api/v2/ci/tests/analytics/aggregate'].post
$.paths['/api/v2/logs/analytics/aggregate'].post
$.paths['/api/v2/rum/analytics/aggregate'].post
$.paths['/api/v2/spans/analytics/aggregate'].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 Aggregate API
  version: 1.0.0
extends: openapi/datadog-aggregate-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: 5
- target: $.paths['/api/v2/ci/pipelines/analytics/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate CI pipeline events
      effect: read
      questions:
      - Can I compute average CI pipeline duration grouped by branch?
      - How do I get timeseries metrics over CI Visibility pipeline runs?
      instructions:
      - text: Aggregate CI pipeline events matching {filter}, computing {compute}.
        slots:
          filter: requestBody.filter
          compute: requestBody.compute
      - text: Break down CI pipeline runs by {group_by}.
        slots:
          group_by: requestBody.group_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/ci/tests/analytics/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate CI test events
      effect: read
      questions:
      - Can I count failing CI tests grouped by test suite?
      - What metrics can I compute over CI Visibility test events?
      instructions:
      - text: Aggregate CI test events matching {filter}, computing {compute}.
        slots:
          filter: requestBody.filter
          compute: requestBody.compute
      - text: Break down CI test results by {group_by}.
        slots:
          group_by: requestBody.group_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/analytics/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate log events into buckets
      effect: read
      questions:
      - Can I count log events grouped by service or status?
      - Can log aggregation results be paged?
      instructions:
      - text: Aggregate log events matching {filter} and compute {compute}.
        slots:
          filter: requestBody.filter
          compute: requestBody.compute
      - text: Group matching log events by {group_by} and page with {page}.
        slots:
          group_by: requestBody.group_by
          page: requestBody.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/analytics/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate RUM events
      effect: read
      questions:
      - Can I count Real User Monitoring sessions grouped by browser?
      - What timeseries can I compute over RUM events?
      instructions:
      - text: Aggregate RUM events matching {filter}, computing {compute}.
        slots:
          filter: requestBody.filter
          compute: requestBody.compute
      - text: Break down RUM events by {group_by}.
        slots:
          group_by: requestBody.group_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/spans/analytics/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate APM spans
      effect: read
      questions:
      - Can I compute latency percentiles across APM spans?
      - What's the rate limit on span aggregation requests?
      instructions:
      - text: Aggregate spans with query {query}.
        slots:
          query: requestBody.data
      - text: Compute span metrics and timeseries for {query}.
        slots:
          query: requestBody.data
      method: generated
      generated: '2026-10-01'