Generated by API Evangelist
Written by API Evangelist tooling for Scope3's API. It is a proposal applied on top of the contract, not a document Scope3 publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Scope3 Reporting API
version: 1.0.0
extends: openapi/scope3-reporting-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['/advertisers/{advertiserId}/events/summary'].get
update:
x-apievangelist-phrasing:
intent: Get hourly event counts for an advertiser
effect: read
questions:
- How many events of each type did my advertiser record per hour?
- Can I limit the event summary to one event type?
instructions:
- text: Get the hourly event summary for advertiser {advertiserId}.
slots:
advertiserId: path.advertiserId
- text: Count {eventType} events for advertiser {advertiserId} between {startHour} and {endHour}.
slots:
eventType: query.eventType
advertiserId: path.advertiserId
startHour: query.startHour
endHour: query.endHour
method: generated
generated: '2026-10-01'
- target: $.paths['/reporting/metrics'].get
update:
x-apievangelist-phrasing:
intent: Get campaign reporting metrics
effect: read
questions:
- What did my campaigns spend and deliver over the last 30 days?
- Can I download reporting as a CSV or as a daily time series?
instructions:
- text: Get reporting for campaign {campaignId} from {startDate} to {endDate}, demo {demo}.
slots:
campaignId: query.campaignId
startDate: query.startDate
endDate: query.endDate
demo: query.demo
- text: Show the last {days} days of metrics for advertiser {advertiserId} in view {view}, demo {demo}.
slots:
days: query.days
advertiserId: query.advertiserId
view: query.view
demo: query.demo
method: generated
generated: '2026-10-01'
- target: $.paths['/reporting/margin'].get
update:
x-apievangelist-phrasing:
intent: Get storefront resale margin P&L
effect: read
questions:
- What margin am I making reselling inventory through my storefront?
- Can I see booked versus realized spread for one buyer?
instructions:
- text: Show my storefront margin report.
- text: Get the resale P&L for buyer {buyerCustomerId}.
slots:
buyerCustomerId: query.buyerCustomerId
- text: Show margin for inventory source {inventorySourceId}.
slots:
inventorySourceId: query.inventorySourceId
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.