Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Brand Conversions API
description: API for submitting conversion events (e.g., sales, leads, subscriptions) to be reported on and potentially attributed to partners. Once a conversion is attributed, it becomes an Action.
version: v13
x-gitbook-description-document:
object: document
data:
schemaVersion: 9
nodes:
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: API for submitting conversion events (e.g., sales, leads, subscriptions) to be reported on and potentially attributed to partners. Once a conversion is attributed, it becomes an Action.
marks: []
key: 7zYgC8SpW1H1
key: sebstG3tAJKY
key: Yt0l4mTVois2
x-gitbook-description-html: <p>API for submitting conversion events (e.g., sales, leads, subscriptions) to be reported on and potentially attributed to partners. Once a conversion is attributed, it becomes an Action.</p>
servers:
- url: https://api.impact.com
security:
- basicAuth: []
tags:
- name: Conversions
paths:
/Advertisers/{AccountSID}/Conversions:
post:
summary: Submit a Conversion Event
description: "Submits a conversion event for tracking and attribution.\n\n **Additional required parameters** not captured in the `required` list below:\n - One of `ActionTrackerId`, `EventTypeId`, or `EventTypeCode` is required (event identifier).\n - One of `ClickId`, `CustomerId`, `CustomProfileId`, `CustomClickId`, `PromoCode`, `MediaId`/`MediaPartnerId`, `UniqueUrl`, `CallerId`, `GoogAId`, `AndroidId`, `AppleIfa`, or `AppleIfv` is required (attribution key).\n\n **Note on conditional requirements:** Many parameters listed below as *optional* are conditionally required based on what else you submit. For example:\n - Item-level fields (`ItemSku[i]`, `ItemQuantity[i]`, `ItemPrice[i]`, `ItemSubTotal[i]`, etc.) become required when reporting at the item level.\n - `CurrencyCode` is required when monetary fields are provided.\n - Mobile-app fields (`AppleIfa`, `GoogAId`, `AppPackage`, `AppInstallRef`, `PropertyId`) are required for mobile-app install attribution.\n - Call-tracking fields (`PhoneNumber`, `CallerId`, `CountryCode`) are required for call-tracking conversions.\n\nIt is highly recommended to provide as much data as possible for accurate attribution and payout calculation."
operationId: submitConversion
tags:
- Conversions
parameters:
- name: AccountSID
in: path
required: true
schema:
type: string
requestBody:
description: 'The details of the conversion event.
**Additional required parameters** not captured in the `required` list below:
- One of `ActionTrackerId`, `EventTypeId`, or `EventTypeCode` is required (event identifier).
- One of `ClickId`, `CustomerId`, `CustomProfileId`, `CustomClickId`, `PromoCode`, `MediaId`/`MediaPartnerId`, `UniqueUrl`, `CallerId`, `GoogAId`, `AndroidId`, `AppleIfa`, or `AppleIfv` is required (attribution key).
**Note on conditional requirements:** Many parameters listed below as *optional* are conditionally required based on what else you submit. For example:
- Item-level fields (`ItemSku[i]`, `ItemQuantity[i]`, `ItemPrice[i]`, `ItemSubTotal[i]`, etc.) become required when reporting at the item level.
- `CurrencyCode` is required when monetary fields are provided.
- Mobile-app fields (`AppleIfa`, `GoogAId`, `AppPackage`, `AppInstallRef`, `PropertyId`) are required for mobile-app install attribution.
- Call-tracking fields (`PhoneNumber`, `CallerId`, `CountryCode`) are required for call-tracking conversions.
See each field''s description for specific conditional requirements.'
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ConversionPayload'
x-gitbook-description-html: '<p>The details of the conversion event.</p>
<p><strong>Additional required parameters</strong> not captured in the <code>required</code> list below:</p>
<ul>
<li>One of <code>ActionTrackerId</code>, <code>EventTypeId</code>, or <code>EventTypeCode</code> is required (event identifier).</li>
<li>One of <code>ClickId</code>, <code>CustomerId</code>, <code>CustomProfileId</code>, <code>CustomClickId</code>, <code>PromoCode</code>, <code>MediaId</code>/<code>MediaPartnerId</code>, <code>UniqueUrl</code>, <code>CallerId</code>, <code>GoogAId</code>, <code>AndroidId</code>, <code>AppleIfa</code>, or <code>AppleIfv</code> is required (attribution key).</li>
</ul>
<p><strong>Note on conditional requirements:</strong> Many parameters listed below as <em>optional</em> are conditionally required based on what else you submit. For example:</p>
<ul>
<li>Item-level fields (<code>ItemSku[i]</code>, <code>ItemQuantity[i]</code>, <code>ItemPrice[i]</code>, <code>ItemSubTotal[i]</code>, etc.) become required when reporting at the item level.</li>
<li><code>CurrencyCode</code> is required when monetary fields are provided.</li>
<li>Mobile-app fields (<code>AppleIfa</code>, <code>GoogAId</code>, <code>AppPackage</code>, <code>AppInstallRef</code>, <code>PropertyId</code>) are required for mobile-app install attribution.</li>
<li>Call-tracking fields (<code>PhoneNumber</code>, <code>CallerId</code>, <code>CountryCode</code>) are required for call-tracking conversions.</li>
</ul>
<p>See each field''s description for specific conditional requirements.</p>'
responses:
'200':
description: The conversion event has been successfully queued for processing.
content:
application/json:
schema:
type: object
properties:
Status:
type: string
description: Indicates whether the conversion was successfully queued.
example: QUEUED
x-gitbook-description-html: <p>Indicates whether the conversion was successfully queued.</p>
QueuedUri:
type: string
format: uri-reference
description: The unique reference to the queued submission.
example: /Advertisers/<AccountSID>/APISubmissions/<SubmissionID>
x-gitbook-description-html: <p>The unique reference to the queued submission.</p>
x-gitbook-description-html: <p>The conversion event has been successfully queued for processing.</p>
'400':
description: Bad Request. The request was invalid, likely due to missing required fields or incorrect data formats.
content:
application/json:
schema:
type: object
properties:
Status:
type: string
description: Indicates that the request failed.
example: ERROR
x-gitbook-description-html: <p>Indicates that the request failed.</p>
errors:
type: array
description: One or more validation errors describing what was wrong with the request.
items:
type: object
properties:
field:
type: string
description: The name of the field that caused the error.
x-gitbook-description-html: <p>The name of the field that caused the error.</p>
level:
type: string
description: The severity of the error.
x-gitbook-description-html: <p>The severity of the error.</p>
message:
type: string
description: A human-readable error message.
x-gitbook-description-html: <p>A human-readable error message.</p>
x-gitbook-description-html: <p>One or more validation errors describing what was wrong with the request.</p>
x-gitbook-description-html: <p>Bad Request. The request was invalid, likely due to missing required fields or incorrect data formats.</p>
x-gitbook-description-document:
object: document
data:
schemaVersion: 9
nodes:
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: Submits a conversion event for tracking and attribution.
marks: []
key: Sk2wLPNc13Fy
key: weOWuO1Kv5BG
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: Additional required parameters
marks:
- object: mark
type: bold
data: {}
- object: leaf
text: ' not captured in the '
marks: []
- object: leaf
text: required
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ' list below:'
marks: []
key: 153k9r5YHCDa
key: 0GoHohmU8k3Z
- object: block
type: list-unordered
isVoid: false
data: {}
nodes:
- object: block
type: list-item
isVoid: false
data: {}
nodes:
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: 'One of '
marks: []
- object: leaf
text: ActionTrackerId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: EventTypeId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', or '
marks: []
- object: leaf
text: EventTypeCode
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ' is required (event identifier).'
marks: []
key: 7wLpZi54K2ep
key: vhB0gR9sA212
key: Y4s0qblxEaZB
- object: block
type: list-item
isVoid: false
data: {}
nodes:
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: 'One of '
marks: []
- object: leaf
text: ClickId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: CustomerId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: CustomProfileId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: CustomClickId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: PromoCode
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: MediaId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: /
marks: []
- object: leaf
text: MediaPartnerId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: UniqueUrl
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: CallerId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: GoogAId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: AndroidId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: AppleIfa
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', or '
marks: []
- object: leaf
text: AppleIfv
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ' is required (attribution key).'
marks: []
key: PuCbo6uG8cPV
key: NrgO7xPyUpAm
key: qAx9iEEbjMDu
key: QTSkAyC6Qqf6
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: 'Note on conditional requirements:'
marks:
- object: mark
type: bold
data: {}
- object: leaf
text: ' Many parameters listed below as '
marks: []
- object: leaf
text: optional
marks:
- object: mark
type: italic
data: {}
- object: leaf
text: ' are conditionally required based on what else you submit. For example:'
marks: []
key: qRngOBdTPQuJ
key: AcbLTS1mKH4d
- object: block
type: list-unordered
isVoid: false
data: {}
nodes:
- object: block
type: list-item
isVoid: false
data: {}
nodes:
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: Item-level fields (
marks: []
- object: leaf
text: ItemSku[i]
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: ItemQuantity[i]
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: ItemPrice[i]
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: ItemSubTotal[i]
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', etc.) become required when reporting at the item level.'
marks: []
key: Z1pvXaAKaT9K
key: uVdhcRkJCOws
key: vxgNodPramts
- object: block
type: list-item
isVoid: false
data: {}
nodes:
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: CurrencyCode
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ' is required when monetary fields are provided.'
marks: []
key: 6efLb2oUtXRN
key: EU3d6tAGVctM
key: IsXAECx060eu
- object: block
type: list-item
isVoid: false
data: {}
nodes:
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: Mobile-app fields (
marks: []
- object: leaf
text: AppleIfa
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: GoogAId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: AppPackage
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: AppInstallRef
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: PropertyId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ) are required for mobile-app install attribution.
marks: []
key: GLOxqAaNxH6s
key: Uh2aKstRIFGP
key: FrE6ugfcdnmW
- object: block
type: list-item
isVoid: false
data: {}
nodes:
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: Call-tracking fields (
marks: []
- object: leaf
text: PhoneNumber
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: CallerId
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ', '
marks: []
- object: leaf
text: CountryCode
marks:
- object: mark
type: code
data: {}
- object: leaf
text: ) are required for call-tracking conversions.
marks: []
key: By0M4OwLiYz6
key: 5PdcCbVMZS82
key: TPspyvYXOSs0
key: GmuknIzzykOR
- object: block
type: paragraph
isVoid: false
data: {}
nodes:
- object: text
leaves:
- object: leaf
text: It is highly recommended to provide as much data as possible for accurate attribution and payout calculation.
marks: []
key: BUBQ6SPqiIrx
key: pzNkQBxNggQ6
key: 710FKJsgf9GS
x-gitbook-description-html: <p>Submits a conversion event for tracking and attribution.</p><p><strong>Additional required parameters</strong> not captured in the <code>required</code> list below:</p><ul><li>One of <code>ActionTrackerId</code>, <code>EventTypeId</code>, or <code>EventTypeCode</code> is required (event identifier).</li><li>One of <code>ClickId</code>, <code>CustomerId</code>, <code>CustomProfileId</code>, <code>CustomClickId</code>, <code>PromoCode</code>, <code>MediaId</code>/<code>MediaPartnerId</code>, <code>UniqueUrl</code>, <code>CallerId</code>, <code>GoogAId</code>, <code>AndroidId</code>, <code>AppleIfa</code>, or <code>AppleIfv</code> is required (attribution key).</li></ul><p><strong>Note on conditional requirements:</strong> Many parameters listed below as <em>optional</em> are conditionally required based on what else you submit. For example:</p><ul><li>Item-level fields (<code>ItemSku[i]</code>, <code>ItemQuantity[i]</code>, <code>ItemPrice[i]</code>, <code>ItemSubTotal[i]</code>, etc.) become required when reporting at the item level.</li><li><code>CurrencyCode</code> is required when monetary fields are provided.</li><li>Mobile-app fields (<code>AppleIfa</code>, <code>GoogAId</code>, <code>AppPackage</code>, <code>AppInstallRef</code>, <code>PropertyId</code>) are required for mobile-app install attribution.</li><li>Call-tracking fields (<code>PhoneNumber</code>, <code>CallerId</code>, <code>CountryCode</code>) are required for call-tracking conversions.</li></ul><p>It is highly recommended to provide as much data as possible for accurate attribution and payout calculation.</p>
components:
schemas:
ConversionPayload:
type: object
required:
- CampaignId
- EventDate
- OrderId
properties:
EventTypeId:
type: integer
description: Unique identifier for the event type (action tracker).
example: 8180
x-tags:
- Event ID
x-gitbook-description-html: <p>Unique identifier for the event type (action tracker).</p>
EventTypeCode:
type: string
description: Configurable string code for the event type.
example: ACME_SALE
x-tags:
- Event ID
x-gitbook-description-html: <p>Configurable string code for the event type.</p>
ClickId:
type: string
description: Unique identifier of a referring click.
example: QiiWXOVnrQ3SQHl24jQjyxBGUkmzfJ3i1VHrWM0
x-tags:
- Attribution key
x-gitbook-description-html: <p>Unique identifier of a referring click.</p>
CustomerId:
type: string
description: Your unique, non-PII identifier for the customer.
example: BCZ2WVSH674563PDPYOTM3AXDQ
x-tags:
- Attribution key
x-gitbook-description-html: <p>Your unique, non-PII identifier for the customer.</p>
CustomProfileId:
type: string
description: Unique identifier for a visitor on your website.
example: a1b2c3d4e5f6
x-tags:
- Attribution key
x-gitbook-description-html: <p>Unique identifier for a visitor on your website.</p>
OrderPromoCode:
type: string
description: Promo code used for the order. Used for attribution if assigned to a specific partner.
example: 10OFF-ROCKET
x-tags:
- Attribution key
x-gitbook-description-html: <p>Promo code used for the order. Used for attribution if assigned to a specific partner.</p>
UniqueUrl:
type: string
format: uri
description: Unique URL of a partner that referred the conversion.
x-tags:
- Attribution key
x-gitbook-description-html: <p>Unique URL of a partner that referred the conversion.</p>
GoogAId:
type: string
description: Google Advertising ID.
example: 38400000-8cf0-11bd-b23e-10b96e40000d
x-tags:
- Attribution key
x-gitbook-description-html: <p>Google Advertising ID.</p>
AppleIfa:
type: string
description: Apple ID for Advertising (IDFA).
example: 38400000-8cf0-11bd-b23e-10b96e40000d
x-tags:
- Attribution key
x-gitbook-description-html: <p>Apple ID for Advertising (IDFA).</p>
AppleIfv:
type: string
description: Apple ID for Vendors (IDFV).
example: 38400000-8cf0-11bd-b23e-10b96e40000d
x-tags:
- Attribution key
x-gitbook-description-html: <p>Apple ID for Vendors (IDFV).</p>
MediaId:
type: integer
description: Force attribution to a specific partner ID. Interchangeable with `MediaPartnerId` — provide either one, not both. Use with caution.
example: 10000
x-tags:
- Attribution key
x-gitbook-description-html: <p>Force attribution to a specific partner ID. Interchangeable with <code>MediaPartnerId</code> — provide either one, not both. Use with caution.</p>
MediaPartnerId:
type: integer
description: Force attribution to a specific partner ID. Interchangeable with `MediaId` — provide either one, not both. Use with caution.
example: 10000
x-tags:
- Attribution key
x-gitbook-description-html: <p>Force attribution to a specific partner ID. Interchangeable with <code>MediaId</code> — provide either one, not both. Use with caution.</p>
SubId1:
type: string
maxLength: 255
description: Only used if you are specifying the MediaId/MediaPartnerId directly and have no other means to tie this conversion to a click or impression. Custom text field typically used by partners to segment their traffic.
example: subid1value
x-gitbook-description-html: <p>Only used if you are specifying the <code>MediaId</code>/<code>MediaPartnerId</code> directly and have no other means to tie this conversion to a click or impression. Custom text field typically used by partners to segment their traffic.</p>
SubId2:
type: string
maxLength: 255
description: Only used if you are specifying the MediaId/MediaPartnerId directly and have no other means to tie this conversion to a click or impression. Custom text fields typically used by partners to segment their traffic.
example: subid2value
x-gitbook-description-html: <p>Only used if you are specifying the <code>MediaId</code>/<code>MediaPartnerId</code> directly and have no other means to tie this conversion to a click or impression. Custom text fields typically used by partners to segment their traffic.</p>
SubId3:
type: string
maxLength: 255
description: Only used if you are specifying the MediaId/MediaPartnerId directly and have no other means to tie this conversion to a click or impression. Custom text field typically used by partners to segment their traffic.
example: subid3value
x-gitbook-description-html: <p>Only used if you are specifying the <code>MediaId</code>/<code>MediaPartnerId</code> directly and have no other means to tie this conversion to a click or impression. Custom text field typically used by partners to segment their traffic.</p>
SharedId:
type: string
maxLength: 255
description: Only used if you are specifying the MediaId/MediaPartnerId directly and have no other means to tie this conversion to a click or impression. Custom text field typically used by partners to share traffic segments with the brands they work with.
example: sharedidvalue
x-gitbook-description-html: <p>Only used if you are specifying the <code>MediaId</code>/<code>MediaPartnerId</code> directly and have no other means to tie this conversion to a click or impression. Custom text field typically used by partners to share traffic segments with the brands they work with.</p>
PhoneNumber:
type: string
description: Phone number called for call tracking conversions.
example: '8051234567'
x-tags:
- Attribution key
x-gitbook-description-html: <p>Phone number called for call tracking conversions.</p>
CallerId:
type: string
description: Unique identifier of the customer in call tracking conversions.
example: '8051234567'
x-tags:
- Attribution key
x-gitbook-description-html: <p>Unique identifier of the customer in call tracking conversions.</p>
CountryCode:
type: string
description: Primarily used for conversions over the phone, this is the ISO 3166-1 alpha-2 two-letter country code of the number called by the customer.
example: US
x-gitbook-description-html: <p>Primarily used for conversions over the phone, this is the ISO 3166-1 alpha-2 two-letter country code of the number called by the customer.</p>
IpAddress:
type: string
description: Customer's IP address. Used for fraud detection and install attribution.
example: 72.194.216.61
x-tags:
- Attribution key
x-gitbook-description-html: <p>Customer's IP address. Used for fraud detection and install attribution.</p>
EventDate:
type: string
format: date-time
description: Timestamp of when the conversion occurred (ISO 8601).
example: '2023-02-15T22:55:32-08:00'
x-gitbook-description-html: <p>Timestamp of when the conversion occurred (ISO 8601).</p>
CampaignId:
type: integer
description: Unique identifier for your program/campaign.
example: 3641
x-gitbook-description-html: <p>Unique identifier for your program/campaign.</p>
OrderId:
type: string
description: Your unique identifier for the order.
example: '9217374917471'
x-gitbook-description-html: <p>Your unique identifier for the order.</p>
CustomerEmail:
type: string
description: Customer's email, must be sent as a SHA1 or SHA256 hash. Plaintext emails are not accepted.
example: 4db6c86b5d02c22ab6c5e
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/impact-radius/refs/heads/main/openapi/impact-radius-conversions-api-openapi.yml