# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Suite Metrics API
  version: 1.0.0
extends: openapi/adobe-suite-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: 4
- target: $.paths['/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve observability metrics (deprecated V1)
      effect: read
      questions:
      - Can I still pull Experience Platform observability metrics with the older GET version?
      - Which older metrics call takes the metric names as query parameters?
      instructions:
      - text: Using the deprecated V1 GET, retrieve metric {metric} for date range {dateRange} in sandbox {sandbox}.
        slots:
          metric: query.metric
          dateRange: query.dateRange
          sandbox: header.x-sandbox-name
      - text: Get V1 metric {metric} for dataset or entity {id}.
        slots:
          metric: query.metric
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve observability metrics (V2)
      effect: read
      questions:
      - How do I query Experience Platform observability metrics over a time window?
      - Is there pagination on observability metrics, or should I use a coarser granularity to limit results?
      instructions:
      - text: Retrieve metrics {metrics} from {start} to {end} at {granularity} granularity in sandbox {sandbox}.
        slots:
          metrics: requestBody.metrics
          start: requestBody.start
          end: requestBody.end
          granularity: requestBody.granularity
          sandbox: header.x-sandbox-name
      - text: Pull daily observability metrics {metrics} for sandbox {sandbox} starting {start}.
        slots:
          metrics: requestBody.metrics
          sandbox: header.x-sandbox-name
          start: requestBody.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List metrics available for a report suite
      effect: read
      questions:
      - Which Analytics metrics can I use in a given report suite?
      - Can I list only the metrics that are segmentable?
      instructions:
      - text: List the metrics for report suite {rsid} in company {globalCompanyId}.
        slots:
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
      - text: Show segmentable metrics for report suite {rsid} in company {globalCompanyId} with locale {locale}.
        slots:
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/metrics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Analytics metric by ID
      effect: read
      questions:
      - What does a single Analytics metric mean and how is it defined?
      - Can I get one metric's details in a specific locale?
      instructions:
      - text: Get metric {id} for report suite {rsid} in company {globalCompanyId}.
        slots:
          id: path.id
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
      - text: Describe metric {id} of report suite {rsid} in company {globalCompanyId} in locale {locale}.
        slots:
          id: path.id
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
          locale: query.locale
      method: generated
      generated: '2026-09-26'