Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Data Warehouse Data Warehouse Report API

4 actions 4 updates phrasing extends openapi/adobe-analytics-data-warehouse-report-api-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 4

$.info
$.paths['/{globalCompanyId}/data_warehouse/report/{UUID}'].get
$.paths['/{globalCompanyId}/data_warehouse/report/{UUID}'].put
$.paths['/{globalCompanyId}/data_warehouse/report'].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 Adobe Analytics Data Warehouse Data Warehouse Report API
  version: 1.0.0
extends: openapi/adobe-analytics-data-warehouse-report-api-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: 3
- target: $.paths['/{globalCompanyId}/data_warehouse/report/{UUID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Data Warehouse report's details
      effect: read
      questions:
      - How do I see the full details of one Data Warehouse report run?
      - What's the delivery status of a specific Data Warehouse report?
      instructions:
      - text: Get Data Warehouse report {UUID} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          UUID: path.UUID
      - text: Show the details of Data Warehouse report {UUID}.
        slots:
          UUID: path.UUID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/data_warehouse/report/{UUID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Data Warehouse report
      effect: write
      questions:
      - Can I change the metadata on a Data Warehouse report that already ran?
      - How do I modify an existing Data Warehouse report entry?
      instructions:
      - text: Update the metadata of Data Warehouse report {UUID} in company {globalCompanyId} to {metadata}.
        slots:
          globalCompanyId: path.globalCompanyId
          UUID: path.UUID
          metadata: requestBody.metadata
      - text: Change report {UUID}'s metadata to {metadata}.
        slots:
          UUID: path.UUID
          metadata: requestBody.metadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/data_warehouse/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Find Data Warehouse reports by filter
      effect: read
      questions:
      - Which Data Warehouse reports were generated for a given scheduled request?
      - Can I filter Data Warehouse reports by status or creation date?
      instructions:
      - text: List Data Warehouse reports in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Find Data Warehouse reports for scheduled request {scheduledRequestUUID} with status {status}.
        slots:
          scheduledRequestUUID: query.scheduledRequestUUID
          status: query.status
      - text: Show Data Warehouse reports created after {createdAfter}.
        slots:
          createdAfter: query.createdAfter
      method: generated
      generated: '2026-10-01'