# 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-suite-calculated-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: 8
- target: $.paths['/{globalCompanyId}/calculatedmetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List calculated metrics
      effect: read
      questions:
      - Which calculated metrics exist in our Adobe Analytics company?
      - Can I list only approved or favorite calculated metrics?
      - How do I find calculated metrics tied to a particular report suite or owner?
      instructions:
      - text: List calculated metrics for company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Find calculated metrics in {globalCompanyId} whose name contains {name}.
        slots:
          globalCompanyId: path.globalCompanyId
          name: query.name
      - text: Show calculated metrics for report suite {rsids} owned by {ownerId} in {globalCompanyId}.
        slots:
          rsids: query.rsids
          ownerId: query.ownerId
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/calculatedmetrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a calculated metric
      effect: write
      questions:
      - How do I create a new calculated metric such as visits per visitor?
      - What fields are required when saving a new calculated metric?
      instructions:
      - text: Create calculated metric {name} on report suite {rsid} in {globalCompanyId} with definition {definition}.
        slots:
          name: requestBody.name
          rsid: requestBody.rsid
          globalCompanyId: path.globalCompanyId
          definition: requestBody.definition
      - text: Save a new calculated metric in {globalCompanyId} using {definition} with {precision} decimal places.
        slots:
          globalCompanyId: path.globalCompanyId
          definition: requestBody.definition
          precision: requestBody.precision
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/calculatedmetrics/functions'].get
  update:
    x-apievangelist-phrasing:
      intent: List functions available to calculated metrics
      effect: read
      questions:
      - What functions can I use inside a calculated metric formula?
      - Is there a catalog of calculated metric functions I can build definitions from?
      instructions:
      - text: List the calculated metric functions for company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Show all formula functions in {globalCompanyId} in locale {locale}.
        slots:
          globalCompanyId: path.globalCompanyId
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/calculatedmetrics/functions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one calculated metric function
      effect: read
      questions:
      - What arguments does a specific calculated metric function take?
      - Can I look up one formula function by its ID?
      instructions:
      - text: Show calculated metric function {id} for company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Describe formula function {id} in {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/calculatedmetrics/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a calculated metric definition
      effect: read
      questions:
      - Can I check a calculated metric definition is valid before saving it?
      - Does validation catch errors in a metric formula without creating anything?
      instructions:
      - text: Validate calculated metric definition {definition} for company {globalCompanyId}.
        slots:
          definition: requestBody.definition
          globalCompanyId: path.globalCompanyId
      - text: Check whether {definition} is a valid metric formula in {globalCompanyId}, including migration functions {migrating}.
        slots:
          definition: requestBody.definition
          globalCompanyId: path.globalCompanyId
          migrating: query.migrating
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/calculatedmetrics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one calculated metric
      effect: read
      questions:
      - How do I retrieve a single calculated metric and its definition?
      - Can I request extra metadata like tags when fetching one calculated metric?
      instructions:
      - text: Show calculated metric {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Get calculated metric {id} from {globalCompanyId} expanded with {expansion}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          expansion: query.expansion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/calculatedmetrics/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a calculated metric
      effect: write
      questions:
      - Can I change the formula of an existing calculated metric?
      - Which fields of a saved calculated metric can be modified, like owner or name?
      instructions:
      - text: Update calculated metric {id} in {globalCompanyId} to use definition {definition}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          definition: requestBody.definition
      - text: Rename existing calculated metric {id} in {globalCompanyId} to {name} with formula {definition}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          name: requestBody.name
          definition: requestBody.definition
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/calculatedmetrics/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a calculated metric
      effect: destructive
      questions:
      - How do I remove a calculated metric we no longer use?
      - Is deleting a calculated metric permanent?
      instructions:
      - text: Delete calculated metric {id} from company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Remove the calculated metric {id} in {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'