Api Model:Goal

From HasOffers

Contents

Required Parameters

  • id
    • Values: (int)
  • offer_id - Id of offer
    • Values: (int)
  • name - Name of Goal
    • Values: (string)
  • protocol - Conversion tracking method to be implemented for goal.
    • Values: http, https, http_img, https_img, server, server_affiliate

Other Optional Parameters

  • advertiser_id - Id of advertiser
    • Values: (int)
  • description - Description of goal.
    • Values: (string)
  • status - Default 'active'.
    • Values: active, deleted
  • is_private - Hide from affiliates and only track revenue.
    • Values: 0, 1 for private

Optional Payout Parameters

  • payout_type - Method used to determine offer payout.
    • Values: cpa_flat, cpa_percentage, cpa_both, cpc, cpm
  • revenue_type - Method used to determine offer revenue.
    • Values: cpa_flat, cpa_percentage, cpa_both, cpc, cpm
  • default_payout
    • Values: (float, 2 decimal max)
  • max_payout
    • Values: (float, 2 decimals max)
  • percent_payout
    • Values: (float, 2 decimals max, percentage as whole number)
    • Example: 10 for 10%
  • max_percent_payout
    • Values: (float, 2 decimals max, percentage as whole number)
    • Example: 10 for 10%
  • tiered_payout - Enable payouts based on affiliate tiers.
    • Values: 0, 1

Additional Return Parameters

Read only parameters return with each object.

  • created - Date / time object was created.
    • Values: (timestamp)
  • modified - Date / time object was last modified.
    • Values: (timestamp)

 
Email this page to a friend or co-worker