# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Analytics Calculated Metrics API
  version: 1.0.0
extends: openapi/adobe-analytics-calculated-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: 5
- target: $.paths['/calculatedmetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List calculated metrics
      effect: read
      questions:
      - What calculated metrics exist in my Adobe Analytics company?
      - Can I include shared or template calculated metrics when listing them?
      - How do I page through a long list of calculated metrics?
      instructions:
      - text: List all calculated metrics.
      - text: List calculated metrics of type {includeType}, {limit} per page, page {page}.
        slots:
          includeType: query.includeType
          limit: query.limit
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/calculatedmetrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a calculated metric
      effect: write
      questions:
      - How do I build a new calculated metric that combines existing metrics with a formula?
      - Can I create a conversion-rate style metric for a specific report suite?
      instructions:
      - text: Create a calculated metric named {name} on report suite {rsid} with definition {definition}.
        slots:
          name: requestBody.name
          rsid: requestBody.rsid
          definition: requestBody.definition
      - text: Build a new calculated metric {name} described as {description} for {rsid} using formula {definition}.
        slots:
          name: requestBody.name
          description: requestBody.description
          rsid: requestBody.rsid
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/calculatedmetrics/{calculatedMetricId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a calculated metric
      effect: read
      questions:
      - How do I see the formula behind one calculated metric?
      - What is the definition of a calculated metric with a given ID?
      instructions:
      - text: Show calculated metric {calculatedMetricId}.
        slots:
          calculatedMetricId: path.calculatedMetricId
      - text: Get the formula and owner of calculated metric {calculatedMetricId}.
        slots:
          calculatedMetricId: path.calculatedMetricId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/calculatedmetrics/{calculatedMetricId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a calculated metric
      effect: write
      questions:
      - Can I change the formula of an existing calculated metric?
      - How do I rename a calculated metric I already created?
      instructions:
      - text: Update calculated metric {calculatedMetricId} to name {name} with definition {definition} on report suite {rsid}.
        slots:
          calculatedMetricId: path.calculatedMetricId
          name: requestBody.name
          definition: requestBody.definition
          rsid: requestBody.rsid
      - text: Change the formula of existing calculated metric {calculatedMetricId} named {name} on {rsid} to {definition}.
        slots:
          calculatedMetricId: path.calculatedMetricId
          name: requestBody.name
          definition: requestBody.definition
          rsid: requestBody.rsid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/calculatedmetrics/{calculatedMetricId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a calculated metric
      effect: destructive
      questions:
      - How do I permanently remove a calculated metric?
      - Is deleting a calculated metric reversible?
      instructions:
      - text: Delete calculated metric {calculatedMetricId}.
        slots:
          calculatedMetricId: path.calculatedMetricId
      - text: Permanently remove calculated metric {calculatedMetricId}.
        slots:
          calculatedMetricId: path.calculatedMetricId
      method: generated
      generated: '2026-10-01'