Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Report Suite Collections Suites API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/{globalCompanyId}/reportsuites/collections/suites/{rsid}'].get
$.paths['/{globalCompanyId}/reportsuites/collections/suites'].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 Report Suite Collections Suites API
  version: 1.0.0
extends: openapi/adobe-analytics-collections-suites-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: 2
- target: $.paths['/{globalCompanyId}/reportsuites/collections/suites/{rsid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report suite by ID
      effect: read
      questions:
      - How do I look up one report suite's details by its RSID?
      - Can I expand extra fields when retrieving a single report suite?
      instructions:
      - text: Get report suite {rsid} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          rsid: path.rsid
      - text: Show report suite {rsid} with {expansion} expanded.
        slots:
          rsid: path.rsid
          expansion: query.expansion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/collections/suites'].get
  update:
    x-apievangelist-phrasing:
      intent: Search report suites
      effect: read
      questions:
      - Which report suites does my company have?
      - Can I find report suites whose RSID contains a certain string?
      instructions:
      - text: List report suites in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Find report suites whose RSID contains {rsidContains}.
        slots:
          rsidContains: query.rsidContains
      - text: Get report suites {rsids}, {limit} per page.
        slots:
          rsids: query.rsids
          limit: query.limit
      method: generated
      generated: '2026-10-01'