For the complete documentation index, see llms.txt. This page is also available as Markdown.

Conversions

Submit a Conversion Event

post

Submits a conversion event for tracking and attribution. A minimum set of parameters including an event identifier, an attribution key, event date, campaign ID, and order ID is required. It is highly recommended to provide as much data as possible for accurate attribution and payout calculation.

Authorizations
AuthorizationstringRequired
Path parameters
AccountSIDstringRequired
Body
EventTypeIdintegerOptional

Unique identifier for the event type (action tracker).

Example: 8180
EventTypeCodestringOptional

Configurable string code for the event type.

Example: ACME_SALE
ClickIdstringOptional

Unique identifier of a referring click.

Example: QiiWXOVnrQ3SQHl24jQjyxBGUkmzfJ3i1VHrWM0
CustomerIdstringOptional

Your unique, non-PII identifier for the customer.

Example: BCZ2WVSH674563PDPYOTM3AXDQ
CustomProfileIdstringOptional

Unique identifier for a visitor on your website.

Example: a1b2c3d4e5f6
OrderPromoCodestringOptional

Promo code used for the order. Used for attribution if assigned to a specific partner.

Example: 10OFF-ROCKET
UniqueUrlstring · uriOptional

Unique URL of a partner that referred the conversion.

GoogAIdstringOptional

Google Advertising ID.

Example: 38400000-8cf0-11bd-b23e-10b96e40000d
AppleIfastringOptional

Apple ID for Advertising (IDFA).

Example: 38400000-8cf0-11bd-b23e-10b96e40000d
AppleIfvstringOptional

Apple ID for Vendors (IDFV).

Example: 38400000-8cf0-11bd-b23e-10b96e40000d
MediaIdintegerOptional

Force attribution to a specific partner ID. Use with caution.

Example: 10000
SubId1string · max: 255Optional

Only used if you are specifying the MediaId 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
SubId2string · max: 255Optional

Only used if you are specifying the MediaId 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
SubId3string · max: 255Optional

Only used if you are specifying the MediaId 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
SharedIdstring · max: 255Optional

Only used if you are specifying the MediaId 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
PhoneNumberstringOptional

Phone number called for call tracking conversions.

Example: 8051234567
CallerIdstringOptional

Unique identifier of the customer in call tracking conversions.

Example: 8051234567
CountryCodestringOptional

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
IpAddressstringOptional

Customer's IP address. Used for fraud detection and install attribution.

Example: 72.194.216.61
EventDatestring · date-timeRequired

Timestamp of when the conversion occurred (ISO 8601).

Example: 2023-02-15T22:55:32-08:00
CampaignIdintegerRequired

Unique identifier for your program/campaign.

Example: 3641
OrderIdstringRequired

Your unique identifier for the order.

Example: 9217374917471
CustomerEmailstringOptional

Customer's email, must be sent as a SHA1 or SHA256 hash. Plaintext emails are not accepted.

Example: 4db6c86b5d02c22ab6c5e1b1a0b82a7b5d4ef068
CustomerStatusstringOptional

Status of the customer, such as NEW or EXISTING. Before being passed, values must be configured in the Customer Status Mapping section when editing an event type, found in the event type settings section of the platform.

Example: NEW
CustomerCitystringOptional

City of the customer, such as Santa Barbara.

Example: Santa Barbara
CustomerPostCodestringOptional

Postal (or "ZIP") code of the customer, such as 93101.

Example: 93101
CustomerCountrystringOptional

Country of the customer, such as USA.

Example: USA
CustomerRegionstringOptional

Region of the customer, such as AMER.

Example: AMER
OrderDiscountnumber · decimalOptional

For sales, this is the discount applied to the order overall. Amount is automatically subtracted from the order total on processing. If item amounts are used, this discount will be subtracted proportionally from each item amount sent in. Note that typically you will want to exclude shipping discounts from this field.

Example: 5
OrderSubTotalPostDiscountnumber · decimalOptional

Used when reporting conversions at the order-level (i.e., no item reporting). The subtotal of the order after discounts, taxes, shipping, and any other costs. If you're submitting item-level data, this value should not be submitted.

Example: 95
OrderShippingnumber · decimalOptional

Primarily used for retail sales. This is the cost of shipping for this conversion. Note that the total sale amount used for payout purposes will not include shipping costs.

Example: 5
OrderTaxnumber · decimalOptional

Primarily used for retail sales. This is the cost of tax for this conversion. Note that the total sale amount used for payout purposes will not include shipping costs.

Example: 8
OrderMarginnumber · decimalOptional

Primarily used for retail sales. This is the total margin made on the conversion (revenue less costs). Typically this is provided either at an item level through the ItemMargin field or through the product catalog.

Example: 30
OrderDiscountRatenumber · decimalOptional

The discount rate (%) applied to the order.

Example: 10
PaymentTypestringOptional

This method of payment used for this conversion (e.g. Credit).

Example: CREDIT_CARD
GiftPurchasebooleanOptional

If you're tracking gift purchases, you can submit true to mark the order in the conversion as a gift purchase. Submit false if the order isn't a gift purchase.

Example: false
CurrencyCodestringOptional

3-character ISO 4217 currency code of the purchase.

Example: USD
Amountnumber · decimalOptional

This is the total order sale amount made on an item or order level of the conversion.

Example: 123
ItemSku[i]stringOptional

SKU for the item (e.g., ItemSku1, ItemSku2).

ItemPromoCode[i]stringOptional

Promotional code applied to the item for the order. Note that this parameter does not work with unique tracking codes setup for particular partners.

Example: 10OFF-ACME
ItemName[i]stringOptional

The name for the product referenced. Can also be automatically appended through uploading a product catalog.

ItemCategory[i]stringOptional

Category of the item.

ItemSubCategory[i]stringOptional

If applicable, the subcategory for the product referenced at the item level. Can also be automatically pulled if a product catalog has been uploaded.

Example: Tennis
ItemMpn[i]stringOptional

Manufacturer part number (MPN) for the product referenced. Can also be automatically pulled if a product catalog has been uploaded.

Example: ACME-MPN-101
ItemBrand[i]stringOptional

Brand name for the product referenced. Can also be automatically pulled if a product catalog has been uploaded.

Example: Acme
ItemQuantity[i]integerOptional

Number of units for this line item.

ItemPrice[i]number · decimalOptional

Unit price for the item. Do not send if ItemSubTotal[i] is passed.

ItemSubTotal[i]number · decimalOptional

Total price for the line item. Do not send if ItemPrice[i] is passed.

ItemDiscount[i]number · decimalOptional

Discount applied to each item purchased of this type (not to the entire line item).

ItemDiscountRate[i]number · decimalOptional

The discount rate (%) applied to each item purchased.

Example: 10
ItemTotalDiscount[i]number · decimalOptional

Discount applied to this line item (not just for each product of this type). Note that this amount is automatically subtracted from the ItemSubTotal to determine the final sale amount for payout and reporting purposes.

ItemDeliveryType[i]stringOptional

Type of delivery method specified for this item (e.g. INSTORE).

Example: INSTORE
ItemText[i]_1 to ItemText[i]_50string · max: 64Optional

You can associate up to 50 custom text fields with each line item using the ItemText{i}_[x] parameter syntax, where {i} is the line item index and [x] is the custom text parameter index (1 to 50). For example, ItemText1_1 is custom text parameter 1 for line item 1, and ItemText2_40 is custom text parameter 40 for line item 2. Appears in your reports.

Example: itemtext1_2=Blue (Custom text parameter 2 for line item 1)
ItemNumeric[i]_1 to ItemNumeric[i]_10number · decimalOptional

General numeral field associated with a specific line item, using the ItemNumeric{i}_[x] parameter syntax, where {i} is the line item index and [x] is the numeric parameter index (1 to 10). Appears in your reports.

Example: 100.5
ItemDate[i]_1 to ItemDate[i]_10string · date-timeOptional

General date and time field (ISO 8601 format) associated with a specific line item, using the ItemDate{i}_[x] parameter syntax, where {i} is the line item index and [x] is the date parameter index (1 to 10). Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
ItemMoney[i]_1 to ItemMoney[i]_3number · decimalOptional

General monetary field associated with a specific line item, using the ItemMoney{i}_[x] parameter syntax, where {i} is the line item index and [x] is the money parameter index (1 to 3). Appears in your reports.

Example: 50
UserAgentstringOptional

User agent of the customer, used to provide device reporting.

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
DeviceMfrstringOptional

Mobile device's manufacturer. Pass android.os.Build.MANUFACTURER on Android or "Apple" on iOS.

Example: Apple
DeviceModelstringOptional

Mobile device's model. Pass android.os.Build.MODEL on Android or the value from systemInfo.machine on iOS.

Example: iPhone 15
PropertyIdintegerOptional

For mobile app conversions, this value is the "System App ID" of your app in impact.com. Found in Settings → Mobile Apps.

Example: 12345
AppPackagestringOptional

Package name for the mobile app the user installed. Only for mobile conversions. Note that this is also picked up through the PropertyId field.

Example: com.acme.app
AppInstallRefstringOptional

Only for Android conversions. Install referrer passed from the Google Play Store when the app is installed. Usually, the value passed from impact.com tracking links will be ClickId={clickidvalue}.

Example: ClickId=QiiWXOVnrQ3SQHl24jQjyxBGUkmzfJ3i1VHrWM0
AppVerstringOptional

Version of the mobile app. Only for mobile conversions.

Example: 1.2.3
LocationIdstringOptional

Primarily used for accommodations, this is the unique identifier for the location specified in this conversion.

Example: LOC-12345
LocationNamestringOptional

Primarily used for accommodations, this is the name for the location specified in this conversion.

Example: Acme Resort Santa Barbara
LocationTypestringOptional

Primarily used for accommodations, this is the category for the location specified in this conversion.

Example: HOTEL
TrackingConsentbooleanOptional

Indicates whether the user has provided consent to be tracked at the moment of the request. Derived from your consent management platform or through frameworks like Apple's ATT (App Tracking Transparency) available on iOS.

Example: true
Notestring · max: 255Optional

General field used to pass information for event-level reporting purposes.

Example: Customer confirmed delivery.
DispositionCodestringOptional

If you have a custom disposition code configured in event type settings, you can submit that value as a default disposition for the action that results from this conversion.

Example: DEFAULT
Text1–Text50string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in your reports. There are 50 of these fields, from Text1 to Text50.

Example: text1value
Numeric1number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 100.5
Numeric2number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 20
Numeric3number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 30
Numeric4number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 40
Numeric5number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 50
Numeric6number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 60
Numeric7number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 70
Numeric8number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 80
Numeric9number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 90
Numeric10number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Example: 100
Money1number · decimalOptional

General money field that accepts any monetary numeric data you want to send. Appears in your reports.

Example: 50
Money2number · decimalOptional

General money field that accepts any monetary numeric data you want to send. Appears in your reports.

Example: 50
Money3number · decimalOptional

General money field that accepts any monetary numeric data you want to send. Appears in your reports.

Example: 75
Date1string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date2string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date3string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date4string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date5string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date6string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date7string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date8string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date9string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Date10string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in your reports.

Example: 2026-09-10T22:55:32-08:00
Responses
200

The conversion event has been successfully queued for processing.

application/json
StatusstringOptional

Indicates whether the conversion was successfully queued.

Example: QUEUED
QueuedUristring · uri-referenceOptional

The unique reference to the queued submission.

Example: /Advertisers/<AccountSID>/APISubmissions/<SubmissionID>
post/Advertisers/{AccountSID}/Conversions

Last updated