Api Model:Conversion

From HasOffers

Required Parameters

  • id
    • Values: (int)
  • affiliate_id - Id of affiliate.
    • Values: (int)
  • offer_id - Id of offer.
    • Values: (int)
  • payout - Amount to be paid to affiliate for conversion.
    • Values: (float, 2 decimal max)
  • revenue - Amount generated by offer owed to network by advertiser.
    • Values: (float, 2 decimal max)

Other Optional Parameters

  • sale_amount - Sale amount generated for advertiser by offer.
    • Values: (float, 2 decimal max)
  • affiliate_manager_id - Id of employee managing affiliate.
    • Values: (int)
  • advertiser_id - Id of advertiser for offer.
    • Values: (int)
  • advertiser_manager_id - Id of employee managing advertiser.
    • Values: (int)
  • offer_url_id - Id of offer URL.
    • Values: (int)
  • offer_file_id - Id of offer file.
    • Values: (int)
  • ad_campaign_id - Id of ad campaign.
    • Values: (int)
  • ad_campaign_creative_id - Id of ad campaign creative.
    • Values: (int)
  • payout_type - payout_type of Offer. Default based on offer_id.
    • Values: cpa_flat, cpa_percentage, cpa_both, cpc, cpm
  • revenue_type - revenue_type of Offer. Default based on offer_id.
    • Values: cpa_flat, cpa_percentage, cpa_both, cpc, cpm
  • source - Affiliate source passed in by affiliate when session was started.
    • Values: (string)
  • affiliate_info1 - Affiliate sub 1 passed in by affiliate when session was started.
    • Values: (string)
  • affiliate_info2 - Affiliate sub 2 passed in by affiliate when session was started.
    • Values: (string)
  • affiliate_info3 - Affiliate sub 3 passed in by affiliate when session was started..
    • Values: (string)
  • affiliate_info4 - Affiliate sub 5 passed in by affiliate when session was started.
    • Values: (string)
  • affiliate_info5 - Affiliate sub 6 passed in by affiliate when session was started.
    • Values: (string)
  • advertiser_info - Advertiser sub passed in by advertiser when conversion pixel / URL called.
    • Values: (string)
  • user_agent - User agent for user when session was started.
    • Values: (string)
  • country_code - Country code for user when session was started.
    • Values: (string)
  • browser_id - Id of browser for user when session was started.
    • Values: (int)
  • datetime - Date time object created formatted with year-month-day hour-minute like YYYY-MM-DD HH:MM "2010-09-08 10:48". Default today.
    • Values: (datetime)
  • refer - Referral URL where session was started..
    • Values: (string)
  • pixel_refer - Referral URL for the conversion pixel.
    • Values: (string)
  • ip - IP address used to create conversion.
    • Values: (string)
  • status - Status of conversion. Default approved.
    • Values: approved, pending, rejected
  • is_adjustment - Flag to mark if the conversion was created as an adjustment.
    • Values: (string)
  • ad_id - Transaction id created by ad server.
    • Values: (string)
  • internal_ad_id - Transaction id created by ad server for internal tracking purposes.
    • Values: (string)
  • currency - 3 letter Currency code of AffiliateInvoice.
    • Values: (string)
  • goal_id - Id of goal.
    • Values: (int)

Read-Only Attributes

Note that some attributes can be set when creating a Conversion but cannot be updated:

  • affiliate_id
  • advertiser_manager_id
  • advertiser_id
  • affiliate_manager_id
  • offer_id
  • offer_url_id
  • source
  • affiliate_info1
  • affiliate_info2
  • affiliate_info3
  • affiliate_info4
  • affiliate_info5
  • advertiser_info
  • datetime
  • currency
  • ad_campaign_id
  • ad_campaign_creative_id
  • offer_file_id
  • goal_id
  • payout_type
  • revenue_type
  • country_code
  • browser_id
  • offer_url_id

 
Email this page to a friend or co-worker