Dynatrace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dynatrace Account Management Dynatrace Platform… Dynatrace……

12 actions 12 updates phrasing extends openapi/dynatrace-dynatrace-platform-subscription-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 12

$.info
$.paths['/sub/v2/accounts/{account-uuid}/subscriptions'].get
$.paths['/sub/v2/accounts/{account-uuid}/subscriptions/forecast'].get
$.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}'].get
$.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}/environments/usage'].get
$.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}/usage'].get
$.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}/cost'].get
$.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}/environments/cost'].get
$.paths['/sub/v3/accounts/{account-uuid}/subscriptions/{subscription-uuid}/environments/cost'].get
$.paths['/sub/v3/accounts/{account-uuid}/subscriptions/{subscription-uuid}/environments/usage'].get
$.paths['/sub/v1/accounts/{account-uuid}/rate-cards'].get
$.paths['/v1/subscriptions/{subscription-uuid}/cost-allocation'].get

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 Account Management Dynatrace Platform… Dynatrace……
  version: 1.0.0
extends: openapi/dynatrace-dynatrace-platform-subscription-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: 11
- target: $.paths['/sub/v2/accounts/{account-uuid}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's subscriptions
      effect: read
      questions:
      - Which Dynatrace Platform Subscriptions does my account have?
      - Can I see all subscriptions tied to one account?
      instructions:
      - text: List every subscription on account {account}.
        slots:
          account: path.account-uuid
      - text: Show me the subscriptions my account {account} holds.
        slots:
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v2/accounts/{account-uuid}/subscriptions/forecast'].get
  update:
    x-apievangelist-phrasing:
      intent: Forecast usage by end of annual commitment
      effect: read
      questions:
      - Will we overrun our annual commitment before the term ends?
      - What is projected usage by the end of the commitment period?
      instructions:
      - text: Forecast subscription usage through the end of the commitment for account {account}.
        slots:
          account: path.account-uuid
      - text: Project where account {account} will land against its annual commit.
        slots:
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscription's details
      effect: read
      questions:
      - What are the terms and budget of a specific subscription?
      - Can I look up one subscription by its UUID?
      instructions:
      - text: Get subscription {subscription} on account {account}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
      - text: Show the details of subscription {subscription} for {account}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}/environments/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-environment usage (deprecated v2)
      effect: read
      questions:
      - Is the older v2 per-environment usage endpoint still available?
      - When does the deprecated v2 environment usage report get removed?
      instructions:
      - text: Use the deprecated v2 endpoint to get per-environment usage of subscription {subscription} on {account} from {start} to {end}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          start: query.startTime
          end: query.endTime
      - text: Fetch legacy v2 environment usage for {subscription} in account {account} between {start} and {end}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's usage by date
      effect: read
      questions:
      - How much of my subscription have we consumed each day?
      - Can I narrow daily subscription usage to certain capabilities or clusters?
      instructions:
      - text: Show daily usage for subscription {subscription} on account {account}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
      - text: Get usage by date for {subscription} in {account}, limited to capabilities {capabilities}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          capabilities: query.capabilityKeys
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}/cost'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's aggregated cost by date
      effect: read
      questions:
      - What has my subscription cost us day by day?
      - Can I see aggregated subscription spend for only some environments?
      instructions:
      - text: Show aggregated cost by date for subscription {subscription} on {account}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
      - text: Get the daily cost of {subscription} in account {account} for environments {environments}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          environments: query.environmentIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v2/accounts/{account-uuid}/subscriptions/{subscription-uuid}/environments/cost'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-environment cost (deprecated v2)
      effect: read
      questions:
      - Where is the old v2 report of SaaS costs per environment?
      - Is the v2 environment cost endpoint going away?
      instructions:
      - text: Use the deprecated v2 endpoint for per-environment cost of {subscription} on {account} from {start} to {end}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          start: query.startTime
          end: query.endTime
      - text: Fetch legacy v2 environment costs for subscription {subscription}, account {account}, {start} to {end}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v3/accounts/{account-uuid}/subscriptions/{subscription-uuid}/environments/cost'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subscription cost broken down by environment
      effect: read
      questions:
      - Which environment is driving most of our subscription cost?
      - Can the per-environment cost breakdown be paged and filtered by cluster?
      instructions:
      - text: Break down the cost of subscription {subscription} on {account} by environment from {start} to {end}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          start: query.startTime
          end: query.endTime
      - text: Show cost per environment for {subscription} in {account} between {start} and {end} for clusters {clusters}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          start: query.startTime
          end: query.endTime
          clusters: query.clusterIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v3/accounts/{account-uuid}/subscriptions/{subscription-uuid}/environments/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subscription usage broken down by environment
      effect: read
      questions:
      - Which environments consume the most of our subscription?
      - Can I see per-environment consumption for just one capability?
      instructions:
      - text: Break down usage of subscription {subscription} on {account} by environment from {start} to {end}.
        slots:
          subscription: path.subscription-uuid
          account: path.account-uuid
          start: query.startTime
          end: query.endTime
      - text: Show per-environment consumption of {capabilities} for {subscription} in {account}, {start} to {end}.
        slots:
          capabilities: query.capabilityKeys
          subscription: path.subscription-uuid
          account: path.account-uuid
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sub/v1/accounts/{account-uuid}/rate-cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's rate cards
      effect: read
      questions:
      - What prices are we paid per capability under our contract?
      - Where can I find the rate cards for my account?
      instructions:
      - text: List the rate cards for account {account}.
        slots:
          account: path.account-uuid
      - text: Show the per-capability pricing on account {account}.
        slots:
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscriptions/{subscription-uuid}/cost-allocation'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down usage by cost allocation field
      effect: read
      questions:
      - How much usage did each cost center or product account for?
      - Can I split subscription usage by cost allocation field for one environment?
      instructions:
      - text: Break down usage of subscription {subscription} by {field} from {from} to {to}.
        slots:
          subscription: path.subscription-uuid
          field: query.field
          from: query.from
          to: query.to
      - text: Show cost allocation for {subscription} in environment {environment} grouped by {field}.
        slots:
          subscription: path.subscription-uuid
          environment: query.environment-id
          field: query.field
      method: generated
      generated: '2026-09-26'