Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Date Ranges API

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

$.info

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

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

$.paths['/{globalCompanyId}/dateranges/{id}'].delete

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

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

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 Date Ranges API
  version: 1.0.0
extends: openapi/adobe-suite-date-ranges-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: 5
- target: $.paths['/{globalCompanyId}/dateranges/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one saved date range
      effect: read
      questions:
      - How do I read the definition of one saved Adobe Analytics date range?
      - Can I get a single date range's details in a specific locale?
      instructions:
      - text: Get date range {id} for company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Show date range {id} in company {globalCompanyId} with extra fields {expansion}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          expansion: query.expansion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/dateranges/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved date range
      effect: write
      questions:
      - Can I rename or redefine a date range I already saved in Analytics?
      - How do I change the definition of an existing reusable date range?
      instructions:
      - text: Rename date range {id} in company {globalCompanyId} to {name}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          name: requestBody.name
      - text: Change the definition of existing date range {id} in {globalCompanyId} to {definition}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/dateranges/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved date range
      effect: destructive
      questions:
      - How do I remove a reusable date range I no longer need?
      - Can I permanently delete one of my saved Analytics date ranges?
      instructions:
      - text: Delete date range {id} from company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Remove saved date range {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/dateranges'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's saved date ranges
      effect: read
      questions:
      - Which reusable date ranges have I saved in Analytics?
      - Can I include date ranges shared with me, not just the ones I own?
      - Is there a way to list only date ranges modified after a certain date?
      instructions:
      - text: List my date ranges in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: List date ranges in company {globalCompanyId} changed since {filterByModifiedAfter}.
        slots:
          globalCompanyId: path.globalCompanyId
          filterByModifiedAfter: query.filterByModifiedAfter
      - text: Show {limit} date ranges per page for company {globalCompanyId}, including type {includeType}.
        slots:
          limit: query.limit
          globalCompanyId: path.globalCompanyId
          includeType: query.includeType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/dateranges'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reusable date range
      effect: write
      questions:
      - How do I save a new custom date range to reuse across Analytics projects?
      - Can I add tags and a description when I create a date range?
      instructions:
      - text: Create a date range called {name} in company {globalCompanyId} with definition {definition}.
        slots:
          name: requestBody.name
          globalCompanyId: path.globalCompanyId
          definition: requestBody.definition
      - text: Save a new date range {name} described as {description} for company {globalCompanyId}.
        slots:
          name: requestBody.name
          description: requestBody.description
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-10-01'