Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Report Suites API

5 actions 5 updates phrasing extends openapi/adobe-analytics-report-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 5

$.info
$.paths['/reportsuites/collections/suites'].get
$.paths['/reportsuites/collections/suites/{rsid}'].get
$.paths['/{globalCompanyId}/reportsuites/reportsuites/timezones'].get
$.paths['/{globalCompanyId}/reportsuites/reportsuites/{rsid}'].post

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 Report Suites API
  version: 1.0.0
extends: openapi/adobe-analytics-report-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: 4
- target: $.paths['/reportsuites/collections/suites'].get
  update:
    x-apievangelist-phrasing:
      intent: List accessible report suites
      effect: read
      questions:
      - Which report suites can I access in Adobe Analytics?
      - How do I page through report suites and see their timezones?
      instructions:
      - text: List the report suites I have access to.
      - text: List report suites, {limit} per page, page {page}.
        slots:
          limit: query.limit
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reportsuites/collections/suites/{rsid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report suite
      effect: read
      questions:
      - What are the name, timezone and type of one report suite?
      - How do I look up a report suite by its RSID?
      instructions:
      - text: Get report suite {rsid}.
        slots:
          rsid: path.rsid
      - text: Show the details of report suite {rsid}.
        slots:
          rsid: path.rsid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/reportsuites/timezones'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported report suite timezones
      effect: read
      questions:
      - Which timezones can I choose when creating a report suite?
      - What timezone values does Analytics support?
      instructions:
      - text: List supported timezones for company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Show every timezone I can assign to a report suite.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/reportsuites/{rsid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a report suite
      effect: write
      questions:
      - How do I create a new standard report suite?
      - Can I copy settings from an existing report suite when creating a new one?
      - Does a new RSID need my company's prefix?
      instructions:
      - text: Create report suite {rsid} named {name} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          rsid: path.rsid
          name: requestBody.name
      - text: Create report suite {rsid} copying settings from {copySettingsFromRsid}.
        slots:
          rsid: path.rsid
          copySettingsFromRsid: query.copySettingsFromRsid
      - text: Create report suite {rsid} in timezone {timezone} with currency {currencyCode}.
        slots:
          rsid: path.rsid
          timezone: requestBody.timezone
          currencyCode: requestBody.currencyCode
      method: generated
      generated: '2026-10-01'