Conversions

Create a conversion

post

Submit a conversion event. Requires at least one attribution key (e.g., ClickId, CustomerId), event date, campaign ID, and order ID.

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

Body

EventTypeIdintegerOptional

Unique identifier for the event type. Required if EventTypeCode is not provided.

Example: 8180

EventTypeCodestringOptional

Configurable string identifying the event type. Required if EventTypeId is not provided.

Example: ACME_SALE

EventDatestring · date-timeRequired

Time and date of conversion in ISO 8601 format, or NOW.

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

CampaignIdintegerRequired

Unique identifier for the program.

Example: 3641

OrderIdstringRequired

Your unique identifier for the order.

Example: 9217374917471

ClickIdstringOptional

impact.com generated click identifier.

Example: QiiWXOVnrQ3SQHl24jQjyxBGUkmzfJ3i1VHrWM0

CustomerIdstringOptional

Non-identifying unique identifier for the customer.

Example: BCZ2WVSH674563PDPYOTM3AXDQ

CustomProfileIdstringOptional

Unique identifier used to identify a visitor (e.g., cookies).

Example: a1b2c3d4e5f6

OrderPromoCodestringOptional

Promo code used for the order.

Example: 10OFF-ROCKET

CustomerEmailstringOptional

Customer email (hashed or plain text).

Example: customer@gmail.com

IpAddressstringOptional

IP address of the customer.

Example: 72.194.216.61

CurrencyCodestringOptional

Three-letter ISO 4217 alpha code.

Example: USD

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

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

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

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).

Example: 1

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.

Example: 5

ItemDeliveryType[i]stringOptional

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

Example: INSTORE

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

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

NotestringOptional

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–Text50stringOptional

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

Numeric1numberOptional

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

Example: 100.5

Money1numberOptional

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

Example: 50

Numeric2numberOptional

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

Example: 20

Numeric3numberOptional

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

Example: 30

Numeric4numberOptional

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

Example: 40

Numeric5numberOptional

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

Example: 50

Numeric6numberOptional

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

Example: 60

Numeric7numberOptional

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

Example: 70

Numeric8numberOptional

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

Example: 80

Numeric9numberOptional

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

Example: 90

Numeric10numberOptional

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

Example: 100

Money2numberOptional

General numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.

Example: 50

Money3numberOptional

General numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.

Example: 75

Date1stringOptional