Generated by API Evangelist
Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Partner Reports API
version: 1.0.0
extends: openapi/impact-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['/Mediapartners/{AccountSID}/Reports'].get
update:
x-apievangelist-phrasing:
intent: List reports available to a partner
effect: read
questions:
- Which reports can I run programmatically as a partner?
- How can I tell which partner reports are API-accessible versus UI-only?
instructions:
- text: List all reports available to partner account {account}.
slots:
account: path.AccountSID
- text: Show which reports account {account} can run through the API.
slots:
account: path.AccountSID
method: generated
generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Reports/{Id}'].get
update:
x-apievangelist-phrasing:
intent: Run a partner report synchronously (legacy)
effect: read
questions:
- Can I pull partner report rows inline for a date range?
- What's the row limit when running a partner report directly?
instructions:
- text: Run report {id} for account {account} from {start} to {end}.
slots:
account: path.AccountSID
id: path.Id
start: query.START_DATE
end: query.END_DATE
- text: Run partner report {id} in account {account} between {start} and {end} for sub-affiliate {subaid}.
slots:
account: path.AccountSID
id: path.Id
start: query.START_DATE
end: query.END_DATE
subaid: query.SUBAID
method: generated
generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Reports/{Id}/MetaData'].get
update:
x-apievangelist-phrasing:
intent: Get a partner report's filters and columns
effect: read
questions:
- Which filters does a partner report accept before I run it?
- What columns will a given partner report return?
instructions:
- text: Get the metadata for report {id} in account {account}.
slots:
account: path.AccountSID
id: path.Id
- text: Show filters and columns of partner report {id}, account {account}.
slots:
account: path.AccountSID
id: path.Id
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.