Dynatrace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dynatrace API v2 Metrics API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/metrics'].get
$.paths['/metrics/{metricKey}'].get
$.paths['/metrics/{metricKey}'].delete
$.paths['/metrics/query'].get
$.paths['/metrics/ingest'].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 Dynatrace API v2 Metrics API
  version: 1.0.0
extends: openapi/dynatrace-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['/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List available metrics
      effect: read
      questions:
      - What metrics are available in my environment?
      - Can I list only metrics that have received data recently?
      instructions:
      - text: List metrics matching {selector}.
        slots:
          selector: query.metricSelector
      - text: Show metrics written since {since}.
        slots:
          since: query.writtenSince
      method: generated
      generated: '2026-09-26'
- target: $.paths['/metrics/{metricKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a metric's descriptor
      effect: read
      questions:
      - What unit and aggregations does a given metric support?
      - Which dimensions does a specific metric key have?
      instructions:
      - text: Describe metric {metric}.
        slots:
          metric: path.metricKey
      - text: Show the unit, aggregations and dimensions of {metric}.
        slots:
          metric: path.metricKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/metrics/{metricKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom metric
      effect: destructive
      questions:
      - How do I get rid of a custom metric I no longer send?
      - Can built-in metrics be deleted, or only custom ones?
      instructions:
      - text: Delete the custom metric {metric}.
        slots:
          metric: path.metricKey
      - text: Remove custom metric {metric} from the environment.
        slots:
          metric: path.metricKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/metrics/query'].get
  update:
    x-apievangelist-phrasing:
      intent: Query metric data points
      effect: read
      questions:
      - What was average CPU on my hosts over the last day?
      - Can I scope a metric query to certain entities or a management zone?
      instructions:
      - text: Query {selector} from {from} to {to} at {resolution} resolution.
        slots:
          selector: query.metricSelector
          from: query.from
          to: query.to
          resolution: query.resolution
      - text: Get data points for {selector} on entities matching {entities}.
        slots:
          selector: query.metricSelector
          entities: query.entitySelector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/metrics/ingest'].post
  update:
    x-apievangelist-phrasing:
      intent: Send custom metric data points
      effect: write
      questions:
      - How do I push my own metric values using the line protocol?
      - Which token scope is needed to ingest custom metrics?
      instructions:
      - text: Ingest these custom metric lines.
      - text: Push these data points to Dynatrace in MINT line format.
      method: generated
      generated: '2026-09-26'