Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Reports API

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

$.info

$.paths['/reports'].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 Reports API
  version: 1.0.0
extends: openapi/adobe-analytics-reports-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: 1
- target: $.paths['/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an Analytics report
      effect: read
      questions:
      - How do I pull page views by page for last month from a report suite?
      - Can I apply segment and date range filters when running a report?
      - Which metrics and dimension go into a report request?
      instructions:
      - text: Run a report on {rsid} with metrics {metricContainer}, filters {globalFilters}, broken down by {dimension}.
        slots:
          rsid: requestBody.rsid
          metricContainer: requestBody.metricContainer
          globalFilters: requestBody.globalFilters
          dimension: requestBody.dimension
      - text: Report {metricContainer} for report suite {rsid} filtered by {globalFilters}.
        slots:
          rsid: requestBody.rsid
          metricContainer: requestBody.metricContainer
          globalFilters: requestBody.globalFilters
      method: generated
      generated: '2026-10-01'