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.
# 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 Annotations API
version: 1.0.0
extends: openapi/adobe-analytics-annotations-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['/annotations'].get
update:
x-apievangelist-phrasing:
intent: List report annotations
effect: read
questions:
- What annotations have been added to dates in my Adobe Analytics reports?
- Can I limit how many annotations come back when listing them?
instructions:
- text: List all annotations across my report suites.
- text: List the first {limit} annotations in locale {locale}.
slots:
limit: query.limit
locale: query.locale
method: generated
generated: '2026-10-01'
- target: $.paths['/annotations'].post
update:
x-apievangelist-phrasing:
intent: Annotate a date range in reports
effect: write
questions:
- How do I mark a campaign launch date on my analytics reports with a note?
- Can I add an annotation to several report suites and give it a color?
instructions:
- text: Create an annotation named {name} for date range {dateRange}.
slots:
name: requestBody.name
dateRange: requestBody.dateRange
- text: Add annotation {name} covering {dateRange} on report suites {rsids} in {color}.
slots:
name: requestBody.name
dateRange: requestBody.dateRange
rsids: requestBody.rsids
color: requestBody.color
method: generated
generated: '2026-10-01'
- target: $.paths['/componentmetadata/tags'].get
update:
x-apievangelist-phrasing:
intent: List component tags
effect: read
questions:
- Which tags are being used on segments, calculated metrics and projects in my company?
- What component tags exist across Analytics?
instructions:
- text: List every tag applied to Analytics components.
- text: Show me the component metadata tags in use.
method: generated
generated: '2026-10-01'
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.