Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Segments API

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

$.info

$.paths['/{globalCompanyId}/segments'].get

$.paths['/{globalCompanyId}/segments'].post

$.paths['/{globalCompanyId}/segments/validate'].post

$.paths['/{globalCompanyId}/segments/{id}'].get

$.paths['/{globalCompanyId}/segments/{id}'].put

$.paths['/{globalCompanyId}/segments/{id}'].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 Analytics Segments API
  version: 1.0.0
extends: openapi/adobe-suite-segments-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: 6
- target: $.paths['/{globalCompanyId}/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Analytics segments
      effect: read
      questions:
      - How do I list the segments available in my Adobe Analytics company?
      - Can I filter segments by report suite, name or tag?
      - Is it possible to include segments shared with me, not just ones I own?
      instructions:
      - text: List segments in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: List segments for {globalCompanyId} whose name contains {name}.
        slots:
          globalCompanyId: path.globalCompanyId
          name: query.name
      - text: Show segments tied to report suites {rsids} in {globalCompanyId}.
        slots:
          rsids: query.rsids
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Analytics segment
      effect: write
      questions:
      - What do I send to build a new segment in Analytics?
      - Can I attach a new segment to a specific report suite and tags?
      instructions:
      - text: Create segment {name} on report suite {rsid} in {globalCompanyId}.
        slots:
          name: requestBody.name
          rsid: requestBody.rsid
          globalCompanyId: path.globalCompanyId
      - text: Build a new segment in {globalCompanyId} described as {description}.
        slots:
          globalCompanyId: path.globalCompanyId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/segments/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a segment definition
      effect: read
      questions:
      - Can I check that a segment definition is valid before saving it?
      - Will my segment definition work against a given report suite?
      instructions:
      - text: Validate this segment definition against report suite {rsid} in {globalCompanyId}.
        slots:
          rsid: query.rsid
          globalCompanyId: path.globalCompanyId
      - text: Check whether my segment is compatible with {rsid}.
        slots:
          rsid: query.rsid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/segments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Analytics segment
      effect: read
      questions:
      - How can I view the definition of one specific segment?
      - Can I expand extra metadata when retrieving a single segment?
      instructions:
      - text: Show segment {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Get segment {id} with extra fields {expansion}.
        slots:
          id: path.id
          expansion: query.expansion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/segments/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Analytics segment
      effect: write
      questions:
      - Can I change the definition or name of an existing segment?
      - What's the call to edit a segment I already created?
      instructions:
      - text: Update segment {id} in {globalCompanyId} with my changes.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Edit segment {id} and return {expansion} in the response.
        slots:
          id: path.id
          expansion: query.expansion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/segments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Analytics segment
      effect: destructive
      questions:
      - How do I delete a segment nobody uses anymore?
      - Can I remove a segment by its ID?
      instructions:
      - text: Delete segment {id} from company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Remove segment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'