Conversion Model

Conversion.

Deprecation notice: We are deprecating the conversion 'id' field (also called conversion.id, stat.id, conversion_id  in some contexts)  and migrating to tune_event_id. Use the new tune_event_id in all places where you would have used the conversion id, unless otherwise specified.

NameTypeDescription
ad_campaign_creative_idIntegerThe ID of the Ad Campaign Creative; cannot be updated
ad_campaign_idIntegerThe ID of the Ad Campaign; cannot be updated
ad_idNullable StringID of Transaction object created by the Ad Server; cannot be updated
advertiser_idIntegerThe ID of the Advertiser for the Offer; cannot be updated
advertiser_infoNullable StringAdvertiser sub passed in by the Advertiser when the conversion pixel / URL was called; cannot be updated
advertiser_manager_idIntegerThe ID of the Employee who is the account manager for the Advertiser; cannot be updated
affiliate_idIntegerThe ID of the Affiliate that generated this Conversion; cannot be updated
affiliate_info1Nullable StringAffiliate sub 1 passed in by the Affiliate when the session was started; cannot be updated
affiliate_info2Nullable StringAffiliate sub 2 passed in by the Affiliate when the session was started; cannot be updated
affiliate_info3Nullable StringAffiliate sub 3 passed in by the Affiliate when the session was started; cannot be updated
affiliate_info4Nullable StringAffiliate sub 4 passed in by the Affiliate when the session was started; cannot be updated
affiliate_info5Nullable StringAffiliate sub 5 passed in by the Affiliate when the session was started; cannot be updated
affiliate_manager_idIntegerThe ID of the Employee who is the account manager for the Affiliate; cannot be updated
browser_idIntegerThe ID of the Browser for the user when the session was started; cannot be updated
country_codeNullable StringThe country code for the user when the session was started; cannot be updated
creative_url_idIntegerThe ID of the Offer Url; cannot be updated
currencyNullable StringThe Currency for the Conversion; cannot be updated
customer_idIntegerID of Customer object; cannot be updated
datetimeDatetimeThe time of the conversion; cannot be updated.
Required format: YYYY-MM-DD hh:mm:ss
goal_idIntegerThe ID of the Goal this Conversion is for. Only applicable if the "enable_offer_goals" Preference is enabled; cannot be updated.
idIntegerDeprecated. Replaced by 'tune_event_id'. ID of unique, auto-generated object for this Conversion
This parameter is non-writable
ipNullable StringIP address used to create the Conversion
is_adjustmentNullable BooleanWhether the Conversion was created as an adjustment; cannot be updated
offer_file_idIntegerThe ID of the Offer File; cannot be updated
offer_idIntegerThe ID of the Offer this Conversion is for; cannot be updated
payoutDecimalThe amount to be paid to the Affiliate for this Conversion
payout_typeStringThe payout type of the offer (or Goal, if applicable); cannot be updatedShow Supported Values
pixel_referNullable StringReferral URL for the conversion pixel
referNullable StringReferral URL where session was started
revenueDecimalThe amount of revenue generated by this Conversion, owed to the Network by the Advertiser
revenue_typeStringThe "revenue_type" of the Offer (or Goal, if applicable); cannot be updatedShow Supported Values
sale_amountNullable DecimalThe sale amount generated for the Advertiser by this Conversion
session_datetimeNullable DatetimeThe time the session was started
session_ipNullable StringThe IP address used to start the session
sourceNullable StringThe affiliate source passed in by the Affiliate when the session was started; cannot be updated
statusStringStatus of the ConversionShow Supported Values
status_codeIntegerThe code providing more granular status details. For more information, see Conversion Status Codes.
tune_event_idStringID of unique, auto-generated object for this Conversion. Use instead of 'id', which is deprecated.
This parameter is non-writable
user_agentNullable StringUser agent for user when session was started
Have a Question? Please contact [email protected] for technical support.