Conversion::create | TUNE Dev Hub

Jump to: POST Response Notes | API Call Builder

Creates a conversion with data properties.

NOTE: Conversions created via this API method are not tied to any click session, and are intended to be used primarily for making adjustments. Using server postbacks for tracking conversions is highly recommended in most cases.

= Required Parameter

Name

Type

Description

data

Object

Conversion model object dataShow Supported Parameters

The following parameters are supported by this object.

Name	Type	Description
ad_campaign_creative_id	Integer	The ID of the Ad Campaign Creative; cannot be updated
ad_campaign_id	Integer	The ID of the Ad Campaign; cannot be updated
ad_id	Nullable String	ID of Transaction object created by the Ad Server; cannot be updated
advertiser_id	Integer	The ID of the Advertiser for the Offer; cannot be updated
advertiser_info	Nullable String	Advertiser sub passed in by the Advertiser when the conversion pixel / URL was called; cannot be updated
advertiser_manager_id	Integer	The ID of the Employee who is the account manager for the Advertiser; cannot be updated
affiliate_id	Integer	The ID of the Affiliate that generated this Conversion; cannot be updated
affiliate_info1	Nullable String	Affiliate sub 1 passed in by the Affiliate when the session was started; cannot be updated
affiliate_info2	Nullable String	Affiliate sub 2 passed in by the Affiliate when the session was started; cannot be updated
affiliate_info3	Nullable String	Affiliate sub 3 passed in by the Affiliate when the session was started; cannot be updated
affiliate_info4	Nullable String	Affiliate sub 4 passed in by the Affiliate when the session was started; cannot be updated
affiliate_info5	Nullable String	Affiliate sub 5 passed in by the Affiliate when the session was started; cannot be updated
affiliate_manager_id	Integer	The ID of the Employee who is the account manager for the Affiliate; cannot be updated
browser_id	Integer	The ID of the Browser for the user when the session was started; cannot be updated
country_code	Nullable String	The country code for the user when the session was started; cannot be updated
creative_url_id	Integer	The ID of the Offer Url; cannot be updated
currency	Nullable String	The Currency for the Conversion; cannot be updated
customer_id	Integer	ID of Customer object; cannot be updated
datetime	Datetime	The time of the conversion; cannot be updated. Required format: YYYY-MM-DD hh:mm:ss
goal_id	Integer	The ID of the Goal this Conversion is for. Only applicable if the "enable_offer_goals" Preference is enabled; cannot be updated.
ip	Nullable String	IP address used to create the Conversion
is_adjustment	Nullable Boolean	Whether the Conversion was created as an adjustment; cannot be updated
offer_file_id	Integer	The ID of the Offer File; cannot be updated
offer_id	Integer	The ID of the Offer this Conversion is for; cannot be updated
payout	Decimal	The amount to be paid to the Affiliate for this Conversion
payout_type	String	The payout type of the offer (or Goal, if applicable); cannot be updated
pixel_refer	Nullable String	Referral URL for the conversion pixel
refer	Nullable String	Referral URL where session was started
revenue	Decimal	The amount of revenue generated by this Conversion, owed to the Network by the Advertiser
revenue_type	String	The "revenue_type" of the Offer (or Goal, if applicable); cannot be updated
sale_amount	Nullable Decimal	The sale amount generated for the Advertiser by this Conversion
session_datetime	Nullable Datetime	The time the session was started
session_ip	Nullable String	The IP address used to start the session
source	Nullable String	The affiliate source passed in by the Affiliate when the session was started; cannot be updated
status	String	Status of the Conversion
status_code	Integer	The code providing more granular status details. For more information, see Conversion Status Codes.
user_agent	Nullable String	User agent for user when session was started

Show Supported Parameters

number

Integer

Number of conversion to create; defaults to 1

return_object

Boolean

If true, returns affected object; defaults to true

POST Response Notes

Returns the ID of the newly created conversion as an integer or returns the newly created Conversion model object if return_object is "true".

API Call Builder

Javascript is required to use the API Call Builder.