Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Segments API

10 actions 10 updates phrasing extends openapi/adobe-experience-cloud-segments-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 10

$.info
$.paths['/api/{companyId}/segments'].get
$.paths['/api/{companyId}/segments'].post
$.paths['/api/{companyId}/segments/{segmentId}'].get
$.paths['/api/{companyId}/segments/{segmentId}'].put
$.paths['/api/{companyId}/segments/{segmentId}'].delete
$.paths['/data/core/ups/segment/definitions'].get
$.paths['/data/core/ups/segment/definitions'].post
$.paths['/data/core/ups/segment/definitions/{segmentId}'].get
$.paths['/data/core/ups/segment/definitions/{segmentId}'].delete

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 Experience Cloud Segments API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-segments-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: 9
- target: $.paths['/api/{companyId}/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Analytics segments
      effect: read
      questions:
      - Which Adobe Analytics segments can I use in reports?
      - Can I filter Analytics segments by report suite?
      instructions:
      - text: List Analytics segments for company {companyId}.
        slots:
          companyId: path.companyId
      - text: List Analytics segments in company {companyId} for report suites {rsids}.
        slots:
          companyId: path.companyId
          rsids: query.rsids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{companyId}/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Analytics segment
      effect: write
      questions:
      - How do I build a new Analytics segment with container rules?
      - Can I tag an Analytics segment when creating it?
      instructions:
      - text: Create Analytics segment {name} in company {companyId} for report suite {rsid}.
        slots:
          name: requestBody.name
          companyId: path.companyId
          rsid: requestBody.rsid
      - text: Create an Analytics segment 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}/segments/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Analytics segment
      effect: read
      questions:
      - What rules make up a specific Analytics segment?
      - Who is an Analytics segment shared with?
      instructions:
      - text: Show Analytics segment {segmentId} in company {companyId}.
        slots:
          segmentId: path.segmentId
          companyId: path.companyId
      - text: Get the definition of Analytics segment {segmentId} for company {companyId}.
        slots:
          segmentId: path.segmentId
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{companyId}/segments/{segmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Analytics segment
      effect: write
      questions:
      - Can I change the rules of an existing Analytics segment?
      - Is renaming a saved Analytics segment possible?
      instructions:
      - text: Rename Analytics segment {segmentId} in company {companyId} to {name}.
        slots:
          segmentId: path.segmentId
          companyId: path.companyId
          name: requestBody.name
      - text: Replace the definition of Analytics segment {segmentId} in company {companyId} with {definition}.
        slots:
          segmentId: path.segmentId
          companyId: path.companyId
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{companyId}/segments/{segmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Analytics segment
      effect: destructive
      questions:
      - Can a deleted Analytics segment be recovered?
      - How do I remove an Analytics segment nobody uses?
      instructions:
      - text: Delete Analytics segment {segmentId} from company {companyId}.
        slots:
          segmentId: path.segmentId
          companyId: path.companyId
      - text: Permanently remove Analytics segment {segmentId} in company {companyId}.
        slots:
          segmentId: path.segmentId
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/core/ups/segment/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Experience Platform audience segments
      effect: read
      questions:
      - Which PQL audience segment definitions exist in Experience Platform?
      - Can I see the evaluation status of our platform segment definitions?
      instructions:
      - text: List segment definitions in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {limit} PQL segment definitions.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/core/ups/segment/definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a PQL audience segment
      effect: write
      questions:
      - How do I define an audience with a Profile Query Language expression?
      - Which merge policy does a new platform segment definition need?
      instructions:
      - text: Create segment definition {name} with PQL {expression} on schema {schema} using merge policy {mergePolicyId}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
          schema: requestBody.schema
          mergePolicyId: requestBody.mergePolicyId
      - text: Define PQL audience {name} as {expression} for schema {schema}, merge policy {mergePolicyId}, sandbox {sandbox}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
          schema: requestBody.schema
          mergePolicyId: requestBody.mergePolicyId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/core/ups/segment/definitions/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a PQL segment definition
      effect: read
      questions:
      - What PQL expression and merge policy does a platform segment definition use?
      - When is a specific segment definition scheduled to evaluate?
      instructions:
      - text: Show segment definition {segmentId} in sandbox {sandbox}.
        slots:
          segmentId: path.segmentId
          sandbox: header.x-sandbox-name
      - text: Get the PQL expression of segment definition {segmentId}.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/core/ups/segment/definitions/{segmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a PQL segment definition
      effect: destructive
      questions:
      - Do running segment jobs finish if I delete the segment definition?
      - Can I remove a platform audience segment definition?
      instructions:
      - text: Delete segment definition {segmentId} in sandbox {sandbox}.
        slots:
          segmentId: path.segmentId
          sandbox: header.x-sandbox-name
      - text: Remove PQL segment definition {segmentId}.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-10-01'