Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Dimensions API

3 actions 3 updates phrasing extends openapi/adobe-suite-dimensions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/{globalCompanyId}/dimensions'].get
$.paths['/{globalCompanyId}/dimensions/{id}'].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 Adobe Analytics Dimensions API
  version: 1.0.0
extends: openapi/adobe-suite-dimensions-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: 2
- target: $.paths['/{globalCompanyId}/dimensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List dimensions for a report suite
      effect: read
      questions:
      - Which dimensions are available in my Adobe Analytics report suite?
      - Can I list only the dimensions that are usable in segments or reports?
      - Is there a way to see just the classifiable dimensions?
      instructions:
      - text: List the dimensions in report suite {rsid} for company {globalCompanyId}.
        slots:
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
      - text: Show only segmentable dimensions in {rsid} for {globalCompanyId}, segmentable={segmentable}.
        slots:
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
          segmentable: query.segmentable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/dimensions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Analytics dimension by ID
      effect: read
      questions:
      - How do I look up details of a single dimension like variables/evar1?
      - Can I get a dimension's metadata in another locale?
      instructions:
      - text: Get dimension {id} in report suite {rsid} for company {globalCompanyId}.
        slots:
          id: path.id
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
      - text: Describe dimension {id} from {rsid} under {globalCompanyId} in locale {locale}.
        slots:
          id: path.id
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
          locale: query.locale
      method: generated
      generated: '2026-09-26'