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

Conversions

Endpoint for submitting your conversion events to impact.com.

Submit a Conversion Event

post

Submits a conversion event for tracking and attribution to you. A minimum set of parameters is required, along with your ID: the campaign, an event identifier (ActionTrackerId), an event date, and a unique order ID.

You must also pass MediaPartnerId (or MediaId) and it must match your AccountSID. On success the conversion is queued and a QueuedUri is returned that points to the API Submissions resource, which you can poll to follow processing status.

Path parameters
AccountSIDstringRequired

Unique identifier for your account. Must match the MediaPartnerId (or MediaId) supplied in the body.

Body

The details of a conversion event you submit.

MediaPartnerIdintegerOptional

Your account ID. Must match the credential in the path. You can use MediaId instead, but you must provide one of the two.

Example: 1924609
MediaIdintegerOptional

An alias for MediaPartnerId. Accepted when MediaPartnerId is omitted.

Example: 1924609
CampaignIdintegerRequired

The campaign this conversion should be attributed to.

Example: 10306
ActionTrackerIdintegerRequired

The action tracker associated with the conversion event.

Example: 19845
EventDatestringRequired

The date/time of the transaction. Accepts NOW or an ISO 8601 timestamp.

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

A unique identifier you supply for this transaction. Used for deduplication.

Example: 9217374917471
ConversionTypestring · enumOptional

The conversion type. The only accepted value is CLO (card-linked offer). Omit this for standard partner conversions.

Example: CLOPossible values:
CardBinstringOptional

Card BIN for CLO transactions. Must be exactly 6 or 8 digits; invalid values are ignored with a warning.

Example: 411111
CardLastFourstringOptional

The last four digits of the card used. Must be exactly 4 digits; invalid values are ignored with a warning.

Example: 1234
PayoutAmountnumber · decimalOptional

Payout amount for CLO transactions. Required when ConversionType=CLO. Must be a non-negative decimal; invalid values are ignored with a warning.

Example: 12.5
Amountnumber · decimalOptional

The total transaction (sale) amount for the conversion. Returns and negative amounts are not currently supported and will result in an error.

Example: 156.11
CurrencyCodestringOptional

Three-letter ISO 4217 alpha currency code for the transaction. If omitted, your account's default currency is used.

Example: USD
CustomerCitystringOptional

City of the customer (billing city).

Example: New York
CustomerPostCodestringOptional

Postal (ZIP) code of the customer (billing ZIP).

Example: 11101
CustomerCountrystringOptional

Country of the customer (billing country).

Example: US
LocationIdstringOptional

Identifier for the location associated with this conversion, such as a merchant ID (MID). Primarily used for accommodations and card-linked transactions.

Example: 12345
LocationNamestringOptional

Name of the location associated with this conversion, such as a physical store or website.

Example: company.com
SharedIdstring · max: 255Optional

A free-form field that accepts any value brands can use to create custom payouts to partners.

Example: Recurring
SubId1string · max: 255Optional

Custom text field typically used by partners to segment their traffic. Appears in brand reports.

Example: Card-Linked
SubId2string · max: 255Optional

Custom text field typically used by partners to segment their traffic. Appears in brand reports.

Example: subid2value
SubId3string · max: 255Optional

Custom text field typically used by partners to segment their traffic. Appears in brand reports.

Example: subid3value
Numeric1number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 15.6
Numeric2number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 20
Numeric3number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 30
Numeric4number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 40
Numeric5number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 50
Numeric6number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 60
Numeric7number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 70
Numeric8number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 80
Numeric9number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 90
Numeric10number · decimalOptional

General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 100
Money1number · decimalOptional

General money field that accepts any monetary data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 173.11
Money2number · decimalOptional

General money field that accepts any monetary data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 50
Money3number · decimalOptional

General money field that accepts any monetary data you want to send. Appears in brand reports. Format: decimal (18,2).

Example: 75
IpAddressstringOptional

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

Example: 72.194.216.61
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
ItemSku[i]stringOptional

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

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
ItemBrand[i]stringOptional

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

Example: Acme
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
ItemPromoCode[i]stringOptional

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

Example: 10OFF-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). 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
Notestring · max: 255Optional

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

Example: Customer confirmed delivery.
Text1string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text1value
Text2string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text2value
Text3string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text3value
Text4string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text4value
Text5string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text5value
Text6string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text6value
Text7string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text7value
Text8string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text8value
Text9string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text9value
Text10string · max: 64Optional

General text field that accepts strings of any text data you want to send. Appears in brand reports.

Example: text10value
Date1string · date-timeOptional

General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand 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 brand 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 brand 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 brand 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 brand 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 brand 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 brand 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 brand 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 brand 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 brand reports.

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

The conversion event was successfully queued for processing.

application/json

Returned when a conversion event is successfully queued for processing.

StatusstringOptional

The submission status. QUEUED means the conversion was accepted for processing.

Example: QUEUED
QueuedUristring · uri-referenceOptional

URI of the queued submission record. Use this to poll for processing status.

Example: /Mediapartners/<AccountSID>/APISubmissions/A-b1234c56-7d89-0e12-3f4g-5h6ij7k8901l
Warningsstring[]Optional

Included when one or more optional CLO field values were invalid and ignored. Each entry is a human-readable message identifying the field and why it was discarded.

Example: ["CardBin ignored: must be exactly 6 or 8 digits."]
submitterAccountIdintegerOptional

Your account ID as the submitting partner.

Example: 1924609
subtypestringOptional

The conversion subtype.

Example: CLO
post/Mediapartners/{AccountSID}/Conversions

Last updated