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.
# 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-suite-reports-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/{globalCompanyId}/reports'].post
update:
x-apievangelist-phrasing:
intent: Run an Adobe Analytics report
effect: read
questions:
- How do I pull a ranked report of a dimension and metrics from Adobe Analytics?
- Can I apply segments or date-range filters to a report request?
- What report suite and dimension does a standard report need?
instructions:
- text: Run a report for report suite {rsid} broken down by {dimension} in company {globalCompanyId}.
slots:
rsid: requestBody.rsid
dimension: requestBody.dimension
globalCompanyId: path.globalCompanyId
- text: Report on {dimension} for {rsid} with filters {globalFilters} and metrics {metricContainer}.
slots:
dimension: requestBody.dimension
rsid: requestBody.rsid
globalFilters: requestBody.globalFilters
metricContainer: requestBody.metricContainer
method: generated
generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/reports/realtime'].post
update:
x-apievangelist-phrasing:
intent: Run a real-time Analytics report
effect: read
questions:
- How do I see live, real-time data for a report suite?
- Can I get a minute-by-minute realtime report on a dimension?
instructions:
- text: Run a realtime report for {rsid} in company {globalCompanyId}.
slots:
rsid: requestBody.rsid
globalCompanyId: path.globalCompanyId
- text: Show real-time {dimension} activity for report suite {rsid}.
slots:
dimension: requestBody.dimension
rsid: requestBody.rsid
method: generated
generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/reports/topItems'].get
update:
x-apievangelist-phrasing:
intent: Get the top items for a dimension
effect: read
questions:
- What are the top pages in a report suite over the last 90 days?
- Can I search within the top items for a dimension, like pages containing a word?
instructions:
- text: Get the top items for {dimension} in report suite {rsid} for company {globalCompanyId}.
slots:
dimension: query.dimension
rsid: query.rsid
globalCompanyId: path.globalCompanyId
- text: List top {limit} {dimension} values for {rsid} between {dateRange}.
slots:
limit: query.limit
dimension: query.dimension
rsid: query.rsid
dateRange: query.dateRange
- text: Find top {dimension} items in {rsid} matching {searchPhrase}.
slots:
dimension: query.dimension
rsid: query.rsid
searchPhrase: query.searchPhrase
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.