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 Impact Conversions API
version: 1.0.0
extends: openapi/impact-conversions-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: 2
- target: $.paths['/Advertisers/{AccountSID}/Conversions'].post
update:
x-apievangelist-phrasing:
intent: Submit a conversion as a brand
effect: write
questions:
- How does my brand report a sale to impact.com for attribution?
- Which identifiers must a brand-side conversion include, like a click ID or customer ID?
instructions:
- text: As brand account {account}, submit order {order} in program {campaign} dated {date} for click {click}.
slots:
account: path.AccountSID
order: requestBody.OrderId
campaign: requestBody.CampaignId
date: requestBody.EventDate
click: requestBody.ClickId
- text: Record a brand conversion for order {order} worth {amount} in program {campaign} on {date}, customer {customer}, account {account}.
slots:
account: path.AccountSID
order: requestBody.OrderId
amount: requestBody.Amount
campaign: requestBody.CampaignId
date: requestBody.EventDate
customer: requestBody.CustomerId
method: generated
generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/PartnerConversions'].post
update:
x-apievangelist-phrasing:
intent: Submit a conversion as a partner
effect: write
questions:
- Can a partner post their own conversion events to impact.com?
- What minimum fields does a partner conversion need?
instructions:
- text: As partner account {account}, submit order {order} for program {campaign}, tracker {tracker}, dated {date}, media {media}, partner {partner}.
slots:
account: path.AccountSID
order: requestBody.OrderId
campaign: requestBody.CampaignId
tracker: requestBody.ActionTrackerId
date: requestBody.EventDate
media: requestBody.MediaId
partner: requestBody.MediaPartnerId
- text: 'Post partner sale of {amount}: order {order}, program {campaign}, tracker {tracker}, {date}, partner {partner}, media {media}, account {account}.'
slots:
account: path.AccountSID
amount: requestBody.Amount
order: requestBody.OrderId
campaign: requestBody.CampaignId
tracker: requestBody.ActionTrackerId
date: requestBody.EventDate
media: requestBody.MediaId
partner: requestBody.MediaPartnerId
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.