Conversions
Unique identifier for your account. Must match the MediaPartnerId (or MediaId) supplied in the body.
The details of a conversion event you submit.
Your account ID. Must match the credential in the path. You can use MediaId instead, but you must provide one of the two.
1924609An alias for MediaPartnerId. Accepted when MediaPartnerId is omitted.
1924609The campaign this conversion should be attributed to.
10306The action tracker associated with the conversion event.
19845The date/time of the transaction. Accepts NOW or an ISO 8601 timestamp.
2023-02-15T22:55:32-08:00A unique identifier you supply for this transaction. Used for deduplication.
9217374917471The conversion type. The only accepted value is CLO (card-linked offer). Omit this for standard partner conversions.
CLOPossible values: Card BIN for CLO transactions. Must be exactly 6 or 8 digits; invalid values are ignored with a warning.
411111The last four digits of the card used. Must be exactly 4 digits; invalid values are ignored with a warning.
1234Payout amount for CLO transactions. Required when ConversionType=CLO. Must be a non-negative decimal; invalid values are ignored with a warning.
12.5The total transaction (sale) amount for the conversion. Returns and negative amounts are not currently supported and will result in an error.
156.11Three-letter ISO 4217 alpha currency code for the transaction. If omitted, your account's default currency is used.
USDCity of the customer (billing city).
New YorkPostal (ZIP) code of the customer (billing ZIP).
11101Country of the customer (billing country).
USIdentifier for the location associated with this conversion, such as a merchant ID (MID). Primarily used for accommodations and card-linked transactions.
12345Name of the location associated with this conversion, such as a physical store or website.
company.comA free-form field that accepts any value brands can use to create custom payouts to partners.
RecurringCustom text field typically used by partners to segment their traffic. Appears in brand reports.
Card-LinkedCustom text field typically used by partners to segment their traffic. Appears in brand reports.
subid2valueCustom text field typically used by partners to segment their traffic. Appears in brand reports.
subid3valueGeneral numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
15.6General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
20General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
30General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
40General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
50General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
60General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
70General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
80General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
90General numeric field that accepts any numeric data you want to send. Appears in brand reports. Format: decimal (18,2).
100General money field that accepts any monetary data you want to send. Appears in brand reports. Format: decimal (18,2).
173.11General money field that accepts any monetary data you want to send. Appears in brand reports. Format: decimal (18,2).
50General money field that accepts any monetary data you want to send. Appears in brand reports. Format: decimal (18,2).
75Customer's IP address. Used for fraud detection and install attribution.
72.194.216.61User agent of the customer, used to provide device reporting.
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36Mobile device's manufacturer. Pass android.os.Build.MANUFACTURER on Android or "Apple" on iOS.
AppleMobile device's model. Pass android.os.Build.MODEL on Android or the value from systemInfo.machine on iOS.
iPhone 15SKU for the item (e.g., ItemSku1, ItemSku2).
The name for the product referenced. Can also be automatically appended through uploading a product catalog.
Category of the item.
If applicable, the subcategory for the product referenced at the item level. Can also be automatically pulled if a product catalog has been uploaded.
TennisBrand name for the product referenced. Can also be automatically pulled if a product catalog has been uploaded.
AcmeManufacturer part number (MPN) for the product referenced. Can also be automatically pulled if a product catalog has been uploaded.
ACME-MPN-101Promotional code applied to the item for the order. Note that this parameter does not work with unique tracking codes set up for particular partners.
10OFF-ACMENumber of units for this line item.
Unit price for the item. Do not send if ItemSubTotal[i] is passed.
Total price for the line item. Do not send if ItemPrice[i] is passed.
Discount applied to each item purchased of this type (not to the entire line item).
The discount rate (%) applied to each item purchased.
10Discount 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.
Type of delivery method specified for this item (e.g. INSTORE).
INSTOREGeneral field used to pass information for event-level reporting purposes.
Customer confirmed delivery.General text field that accepts strings of any text data you want to send. Appears in brand reports.
text1valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text2valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text3valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text4valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text5valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text6valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text7valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text8valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text9valueGeneral text field that accepts strings of any text data you want to send. Appears in brand reports.
text10valueGeneral field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00General field that accepts a date and time in ISO 8601 format you want to send. Appears in brand reports.
2026-09-10T22:55:32-08:00The conversion event was successfully queued for processing.
Returned when a conversion event is successfully queued for processing.
The submission status. QUEUED means the conversion was accepted for processing.
QUEUEDURI of the queued submission record. Use this to poll for processing status.
/Mediapartners/<AccountSID>/APISubmissions/A-b1234c56-7d89-0e12-3f4g-5h6ij7k8901lIncluded 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.
["CardBin ignored: must be exactly 6 or 8 digits."]Your account ID as the submitting partner.
1924609The conversion subtype.
CLOBad Request. The request was invalid, likely due to missing required fields or incorrect data formats.
Last updated
