Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Analytics 2.0 Calculated…

6 actions 6 updates phrasing extends openapi/adobe-experience-cloud-calculated-metrics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe Experience Cloud's API. It is a proposal applied on top of the contract, not a document Adobe Experience Cloud publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/{companyId}/calculatedmetrics'].get

$.paths['/api/{companyId}/calculatedmetrics'].post

$.paths['/api/{companyId}/calculatedmetrics/{calculatedMetricId}'].get

$.paths['/api/{companyId}/calculatedmetrics/{calculatedMetricId}'].put

$.paths['/api/{companyId}/calculatedmetrics/{calculatedMetricId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Analytics 2.0 Calculated…
  version: 1.0.0
extends: openapi/adobe-experience-cloud-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['/api/{companyId}/calculatedmetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List calculated metrics
      effect: read
      questions:
      - Which calculated metrics can I use in Adobe Analytics?
      - Can I filter calculated metrics by report suite?
      instructions:
      - text: List calculated metrics for company {companyId}.
        slots:
          companyId: path.companyId
      - text: List calculated metrics in company {companyId} for report suites {rsids}.
        slots:
          companyId: path.companyId
          rsids: query.rsids
      - text: Show page {page} of calculated metrics for company {companyId}, {limit} per page.
        slots:
          page: query.page
          companyId: path.companyId
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{companyId}/calculatedmetrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a calculated metric
      effect: write
      questions:
      - How do I build a new calculated metric from a formula?
      - Can I set polarity on a calculated metric when I create it?
      instructions:
      - text: Create calculated metric {name} in company {companyId} for report suite {rsid}.
        slots:
          name: requestBody.name
          companyId: path.companyId
          rsid: requestBody.rsid
      - text: Create a calculated metric named {name} in company {companyId} with definition {definition}.
        slots:
          name: requestBody.name
          companyId: path.companyId
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{companyId}/calculatedmetrics/{calculatedMetricId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a calculated metric's definition
      effect: read
      questions:
      - What formula sits behind one particular calculated metric?
      - Where can I see who owns a calculated metric?
      instructions:
      - text: Show calculated metric {calculatedMetricId} in company {companyId}.
        slots:
          calculatedMetricId: path.calculatedMetricId
          companyId: path.companyId
      - text: Get the definition of calculated metric {calculatedMetricId} for company {companyId}.
        slots:
          calculatedMetricId: path.calculatedMetricId
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{companyId}/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?
      - Is it possible to rename a calculated metric that's already saved?
      instructions:
      - text: Rename calculated metric {calculatedMetricId} in company {companyId} to {name}.
        slots:
          calculatedMetricId: path.calculatedMetricId
          companyId: path.companyId
          name: requestBody.name
      - text: Replace the definition of calculated metric {calculatedMetricId} in company {companyId} with {definition}.
        slots:
          calculatedMetricId: path.calculatedMetricId
          companyId: path.companyId
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{companyId}/calculatedmetrics/{calculatedMetricId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a calculated metric
      effect: destructive
      questions:
      - Can a deleted calculated metric be recovered?
      - How do I remove a calculated metric we no longer use?
      instructions:
      - text: Delete calculated metric {calculatedMetricId} from company {companyId}.
        slots:
          calculatedMetricId: path.calculatedMetricId
          companyId: path.companyId
      - text: Permanently remove calculated metric {calculatedMetricId} in company {companyId}.
        slots:
          calculatedMetricId: path.calculatedMetricId
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'