Api Model:Stat

From HasOffers

Contents

Stat Report Fields

  • Stat.count - Count of rows.
    • Values: (int)
  • Stat.affiliate_count - Count of distinct affiliate ids.
    • Values: (int)
  • Stat.offer_count - Count of distinct offers ids.
    • Values: (int)
  • Stat.impressions - Sum of impressions.
    • Values: (int)
  • Stat.clicks - Sum of clicks.
    • Note: If 'track_uniques' preference enabled, Alias for Stat.unique_clicks
    • Values: (int)
  • Stat.gross_clicks - Sum of gross clicks.
    • Values: (int)
  • Stat.unique_clicks - Sum of unique clicks
    • Values: (int)
  • Stat.ctr - Click through Rate: Stat.clicks ÷ Stat.impressions
    • Note: If 'track_uniques' preference enabled, Stat.unique_clicks ÷ Stat.impressions
    • Values: (float, percentage as whole number, 2 decimal max)
  • Stat.gross_ctr - Gross Click through Rate: Stat.gross_clicks ÷ Stat.impressions
    • Values: (float, percentage as whole number, 2 decimal max)
  • Stat.unique_ctr - Unique Click through Rate: Stat.unique_clicks ÷ Stat.impressions
    • Values: (float, percentage as whole number, 2 decimal max)
  • Stat.conversions - Sum of conversions.
    • Values: (int)
  • Stat.leads - Alias for Stat.conversions.
  • Stat.ltr - Lead through Rate: Stat.conversions ÷ Stat.clicks
    • Note: If 'track_uniques' preference enabled, Stat.conversions ÷ Stat.unique_clicks
    • Values: (float, percentage as whole number, 2 decimal max)
  • currency - 3 letter Currency code.
    • Values: (string)
  • Stat.goal_id - Id of goal.
    • Values: (int)
  • Goal.id - Id of goal.
    • Note: For use when grouping by goal or including additional goal field other than id, otherwise recommended to use Stat.goal_id.
    • Values: (int)
  • Goal.name - Name for goal
    • Values: (string)
  • payout_type - payout_type of Offer.
    • Values: cpa_flat, cpa_percentage, cpa_both, cpc, cpm
  • revenue_type - revenue_type of Offer.
    • Values: cpa_flat, cpa_percentage, cpa_both, cpc, cpm
  • Stat.payout - Sum of affiliate payout.
    • Values: (float, 2 decimal max)
  • Stat.cpc - Cost per Click, Payout per Click: Stat.payout ÷ Stat.clicks
    • Note: If 'track_uniques' preference enabled, Stat.payout ÷ Stat.unique_clicks
    • Values: (float, 2 decimal max)
  • Stat.cpm - Cost per Thousand Impressions: Stat.payout ÷ (Stat.impressions ÷ 1000)
    • Values: (float, 2 decimal max)
  • Stat.cpa - Cost per Acquisition, Payout per Conversion: Stat.payout ÷ Stat.conversions
    • Values: (float, 2 decimal max)
  • Stat.cpl - Cost per Lead, Alias for Stat.cpa.
    • Values: (float, 2 decimal max)
  • Stat.revenue - Sum of offer revenue.
    • Values: (float, 2 decimal max)
  • Stat.rpc -Revenue per Click: Stat.revenue ÷ Stat.clicks
    • Note: If 'track_uniques' preference enabled, Stat.revenue ÷ Stat.unique_clicks
    • Values: (float, 2 decimal max)
  • Stat.rpm - Revenue per Thousand Impressions: Stat.revenue ÷ (Stat.impressions ÷ 1000)
    • Values: (float, 2 decimal max)
  • Stat.rpa - Revenue per Acquisition, Revenue per Conversion: Stat.revenue ÷ Stat.conversions
    • Values: (float, 2 decimal max)
  • Stat.sale_amount - Sum of sale amount.
    • Values: (float, 2 decimal max)
  • Stat.profit - Network profit: Stat.revenue - Stat.payout
    • Values: (float, 2 decimal max)
  • Stat.year - Year (four digits) of Stat.date.
    • Values: (int)
  • Stat.month - Month (00..12) of Stat.date.
    • Values: (int)
  • Stat.week - Year (four digits) for the week for Stat.date, where Monday is the first day of the week + Week (00..53) for Stat.date, where Monday is the first day of the week.
    • Values: (string)
    • Example: '2010 02' for Week two of 2010
  • Stat.date - Date of activity, YYYY-MM-DD
    • Values: (string)
    • Example: '2010-12-29' for December 29, 2010
  • Stat.hour - Hour (0..23) of activity
    • Values: (int)
  • Stat.affiliate_id - Id of affiliate.
    • Values: (int)
  • Affiliate.id - Id of affiliate.
    • Note: For use when grouping by affiliate or including additional affiliate field other than id, otherwise recommended to use Stat.affiliate_id.
    • Values: (int)
  • Affiliate.company - Company name for affiliate.
    • Values: (string)
  • Stat.affiliate_manager_id - Id of employee assigned as affiliate account manager.
    • Values: (int)
  • AffiliateManager.id - Id of employee assigned as affiliate account manager.
    • Note: For use when grouping by affiliate manger or including additional affiliate manager field other than id, otherwise recommended to use Stat.affiliate_manager_id.
    • Values: (int)
  • AffiliateManager.full_name - First and last name of affiliate account manger.
    • Values: (string)
  • Stat.advertiser_id - Id of advertiser.
    • Values: (int)
  • Advertiser.id - Id of advertiser.
    • Note: For use when grouping by advertiser or including additional advertiser field other than id, otherwise recommended to use Stat.advertiser_id.
    • Values: (int)
  • Advertiser.company - Company name for advertiser.
    • Values: (string)
  • Stat.advertiser_manager_id - Id of employee assigned as advertiser account manager.
    • Values: (int)
  • AdvertiserManager.id - Id of employee assigned as advertiser account manager.
    • Note: For use when grouping by advertiser manager or including additional advertiser manger field other than id, otherwise recommended to use Stat.advertiser_manager_id.
    • Values: (int)
  • AdvertiserManager.full_name - First and last name of advertiser account manger.
    • Values: (string)
  • Stat.offer_id - Id of offer.
    • Values: (int)
  • Offer.id - Id of offer.
    • Note: For use when grouping by offer or including additional offer field other than id, otherwise recommended to use Stat.offer_id.
    • Values: (int)
  • Offer.name - Name for offer.
    • Values: (string)
  • Offer.display_advertiser - Flag on offer to display advertiser to affiliate.
    • Values: 0, 1
  • Offer.shared_type - Specifies if offer is being shared on the Offer Exchange or imported from the Offer Exchange.
    • Values: advertiser, affiliate, not_shared
  • Category.id - Id of category offer assigned to.
    • Values: (int)
  • Category.name - Name of category offer assigned to.
    • Values: (string)
  • Stat.offer_url_id - Id of offer URL.
    • Values: (int)
  • OfferUrl.id - Id of offer URL.
    • Note: For use when grouping by offer URL or including additional offer URL field other than id, otherwise recommended to use Stat.offer_url_id.
    • Values: (int)
  • OfferUrl.name - Name for Offer URL .
    • Values: (string)
  • OfferUrl.preview_url - Preview URL for Offer URL.
    • Values: (string)
  • Stat.offer_file_id - Id of offer file.
    • Values: (int)
  • OfferFile.id - Id of offer file.
    • Note: For use when grouping by offer file or including additional offer file field other than id, otherwise recommended to use Stat.offer_file_id.
    • Values: (int)
  • OfferFile.display - Name for offer file.
    • Values: (string)
  • Stat.ad_campaign_id - Id of ad campaign.
    • Values: (int)
  • AdCampaign.id - Id of ad campaign.
    • Note: For use when grouping by ad campaign or including additional ad campaign afield other than id, otherwise recommended to use Stat.ad_campaign_id.
    • Values: (int)
  • AdCampaign.name - Name for ad campaign.
    • Values: (string)
  • Stat.country_code - Country code.
    • Values: (string)
  • Country.code - Country code.
    • Note: For use when grouping by country or including additional country field other than country_code, otherwise recommended to use Stat.country_code.
    • Values: (string)
  • Country.name - Name for country.
    • Values: (string)
  • Stat.browser_id - Id of browser.
    • Values: (int)
  • Browser.id - Id of browser.
    • Note: For use when grouping by browser or including additional browser field other than id, otherwise recommended to use Stat.browser_id.
    • Values: (int)
  • Browser.display_name - Name for browser.
    • Values: (string)
  • Stat.source - Affiliate source
    • Values: (string)

Conversion Report Fields

  • Stat.id - Id of conversion.
    • Values: (int)
  • Stat.ip - IP address that created conversion.
    • Values: (string)
  • Stat.ad_id - Transaction id created by ad server.
    • Values: (string)
  • Stat.source - Affiliate source passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info1 - Affiliate sub 1 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info - Alias for Stat.affiliate_info1.
  • Stat.affiliate_info2 - Affiliate sub 2 passed in by affiliate when session was started..
    • Values: (string)
  • Stat.affiliate_info3 - Affiliate sub 3 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info3 - Affiliate sub 4 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info5 - Affiliate sub 5 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.advertiser_info - Advertiser sub passed in by advertiser when conversion pixel / URL called.
    • Values: (string)
  • Stat.hour - Hour (0..23) of activity
    • Values: (int)
  • Stat.refer - Referral URL where session was started.
    • Values: (string)
  • Stat.pixel_refer - Referral URL for the conversion pixel.
    • Values: (string)
  • Stat.status - Status of conversion.
    • Values: (string)
  • currency - 3 letter Currency code.
    • Values: (string)
  • Stat.goal_id - Id of goal.
    • Values: (int)
  • Goal.id - Id of goal.
    • Note: For use when grouping by goal or including additional goal field other than id, otherwise recommended to use Stat.goal_id.
    • Values: (int)
  • Goal.name - Name for goal
    • Values: (string)
  • Stat.payout - Affiliate payout.
    • Values: (float, 2 decimal max)
  • Stat.revenue - Offer revenue.
    • Values: (float, 2 decimal max)
  • Stat.sale_amount - Offer sale amount.
    • Values: (float, 2 decimal max)
  • Stat.user_agent - User agent for user when session was started.
    • Values: (string)
  • Stat.is_adjustment - Flag to mark if the conversion was created as an adjustment.
    • Values: 0, 1
  • Stat.datetime - Date / time object created. Default today.
    • Values: (timestamp)
  • Stat.date - Date of Stat.datetime, YYYY-MM-DD
    • Values: (string)
    • Example: '2010-12-29' for December 29, 2010
  • Stat.affiliate_id - Id of affiliate.
    • Values: (int)
  • Affiliate.id - Id of affiliate.
    • Note: For use when including addition affiliate field other than id, otherwise recommended to use Stat.affiliate_id.
    • Values: (int)
  • Affiliate.company - Company name for affiliate.
    • Values: (string)
  • Stat.affiliate_manager_id - Id of employee assigned as affiliate account manager.
    • Values: (int)
  • AffiliateManager.id - Id of employee assigned as affiliate account manager.
    • Note: For use when including addition affiliate manager field other than id, otherwise recommended to use Stat.affiliate_manager_id.
    • Values: (int)
  • AffiliateManager.full_name - First and last name of affiliate account manger.
    • Values: (string)
  • Stat.advertiser_id - Id of advertiser.
    • Values: (int)
  • Advertiser.id - Id of advertiser.
    • Note: For use when including addition advertiser field other than id, otherwise recommended to use Stat.advertiser_id.
    • Values: (int)
  • Advertiser.company - Company name for advertiser.
    • Values: (string)
  • Stat.advertiser_manager_id - Id of employee assigned as advertiser account manager.
    • Values: (int)
  • AdvertiserManager.id - Id of employee assigned as advertiser account manager.
    • Note: For use when including addition advertiser manager field other than id, otherwise recommended to use Stat.advertiser_manager_id.
    • Values: (int)
  • AdvertiserManager.full_name - First and last name of advertiser account manger.
    • Values: (string)
  • Stat.offer_id - Id of offer.
    • Values: (int)
  • Offer.id - Id of offer.
    • Note: For use when including addition offer field other than id, otherwise recommended to use Stat.offer_id.
    • Values: (int)
  • Offer.name - Name for offer.
    • Values: (int)
  • Offer.shared_type - Specifies if offer is being shared on the Offer Exchange or imported from the Offer Exchange.
    • Values: advertiser, affiliate, not_shared
  • Stat.country_code - Country code.
    • Values: (string)
  • Country.code - Country code.
    • Note: For use when including addition country field other than country_code, otherwise recommended to use Stat.country_code.
    • Values: (string)
  • Country.name - Name for country.
    • Values: (string)
  • Stat.browser_id - Id of browser.
    • Values: (int)
  • Browser.id - Id of browser.
    • Note: For use when including addition browser field other than id, otherwise recommended to use Stat.browser_id.
    • Values: (int)
  • Browser.display_name - Name for browser.
    • Values: (string)

Referral URL Report Fields

  • Stat.url - Referral URL when session started.
    • Values: (string)
  • Stat.source - Affiliate source passed in by affiliate when session was started.
    • Values: (string)
  • Stat.clicks - Sum of clicks.
    • Values: (int)
  • Stat.conversions - Sum of conversions.
    • Values: (int)
  • Stat.affiliate_info1 - Affiliate sub 1 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info2 - Affiliate sub 2 passed in by affiliate when session was started..
    • Values: (string)
  • Stat.affiliate_info3 - Affiliate sub 3 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info3 - Affiliate sub 4 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info5 - Affiliate sub 5 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.date - Date of Stat.datetime, YYYY-MM-DD
    • Values: (String)
    • Example: '2010-12-29' for December 29, 2010
  • Stat.affiliate_id - Id of affiliate.
    • Values: (int)
  • Affiliate.id - Id of affiliate.
    • Note: For use when including addition affiliate field other than id, otherwise recommended to use Stat.affiliate_id.
    • Values: (int)
  • Affiliate.company - Company name for affiliate.
    • Values: (string)
  • Stat.affiliate_manager_id - Id of employee assigned as affiliate account manager.
    • Values: (int)
  • AffiliateManager.id - Id of employee assigned as affiliate account manager.
    • Note: For use when including addition affiliate manager field other than id, otherwise recommended to use Stat.affiliate_manager_id.
    • Values: (int)
  • AffiliateManager.full_name - First and last name of affiliate account manger.
    • Values: (string)
  • Stat.offer_id - Id of offer.
    • Values: (int)
  • Offer.id - Id of offer.
    • Note: For use when including addition offer field other than id, otherwise recommended to use Stat.offer_id.
    • Values: (int)
  • Offer.name - Name for offer.
    • Values: (string)

Affiliate Commission Report Fields

  • Stat.amount - Sum of commission.
    • Values: (float, 2 decimal max)
  • Stat.var_total - Sum of field used to compute commission.
    • Values: (float, 2 decimal max)
  • Stat.date - Date of activity, YYYY-MM-DD
    • Values: (string)
    • Example: '2010-12-29' for December 29, 2010
  • Stat.referral_id - Id of referral affiliate, affiliate who referred another affiliate.
    • Values: (int)
  • Affiliate.id - Id of referring affiliate, affiliate who referred another affiliate.
    • Note: For use when grouping by affiliate or including additional affiliate field other than id, otherwise recommended to use Stat.referral_id.
    • Values: (int)
  • Affiliate.company - Company name of referring affiliate.
    • Values: (string)
  • Stat.affiliate_id - Id of referred affiliate, affiliate who was referred.
    • Values: (int)
  • ReferredAffiliate.id - Id of referred affiliate, affiliate who was referred.
    • Note: For use when grouping by referred affiliate or including additional referred affiliate field other than id, otherwise recommended to use Stat.affiliate_id.
    • Values: (int)
  • ReferredAffiliate.company - Company name of referred affiliate.
    • Values: (string)

Affiliate Manager Commission Report Fields

  • Stat.amount - Sum of commission.
    • Values: (float, 2 decimal max)
  • Stat.var_total - Sum of field used to compute commission.
    • Values: (float, 2 decimal max)
  • Stat.commission_field - Field used from stats to base commission calculations.
    • Values: leads, payout, revenue, profit
  • Stat.commission_rate - Rate used to compute commission calculation.
    • Values: (float, percentage entered as whole number)
  • Stat.commission_type - Method to compute commission from field. Select 'flat' if a commission is being made per each addition field. Select 'percentage' to compute commission as a percentage of the field.
    • Values: flat, percentage
  • Stat.date - Date of activity, YYYY-MM-DD
    • Values: (string)
    • Example: '2010-12-29' for December 29, 2010
  • Stat.affiliate_manager_id - Id of employee assigned as affiliate account manager.
    • Values: (int)
  • AffiliateManager.id - Id of employee assigned as affiliate account manager.
    • Note: For use when including addition affiliate manager field other than id, otherwise recommended to use Stat.affiliate_manager_id.
    • Values: (int)
  • AffiliateManager.full_name - First and last name of affiliate account manger.
    • Values: (string)

Subscription Report Fields

  • Stat.id - Id of subscription.
  • Stat.status - Status of subscription.
    • Values: active, deleted
  • Stat.created - Date / time object created. Default today.
    • Values: (timestamp)
  • Stat.start_date - Start date for the subscription.
    • Values: (date)
  • Stat.end_date - End date for the subscription.
    • Values: (date)
  • Stat.payout - Affiliate payout.
    • Values: (float, 2 decimal max)
  • Stat.revenue - Offer revenue.
    • Values: (float, 2 decimal max)
  • Stat.sale_amount - Offer sale amount.
    • Values: (float, 2 decimal max)
  • Stat.source - Affiliate source passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info1 - Affiliate sub 1 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info2 - Affiliate sub 2 passed in by affiliate when session was started..
    • Values: (string)
  • Stat.affiliate_info3 - Affiliate sub 3 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info3 - Affiliate sub 4 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.affiliate_info5 - Affiliate sub 5 passed in by affiliate when session was started.
    • Values: (string)
  • Stat.advertiser_info - Advertiser sub passed in by advertiser when conversion pixel / URL called.
    • Values: (string)
  • Stat.refer - Referral URL where session was started.
    • Values: (string)
  • Stat.pixel_refer - Referral URL for the conversion pixel.
    • Values: (string)
  • Stat.provided_id - Reference customer id.
    • Values: (string)
  • Stat.customer_list_id - Id of customer list.
    • Values: (int)
  • CustomerList.id - Id of customer list.
    • Note: For use when including additional customer list field other than id, otherwise recommended to use Stat.customer_list_id.
    • Values: (int)
  • CustomerList.name - Name for customer list.
    • Values: (string)
  • Stat.affiliate_id - Id of affiliate.
    • Values: (int)
  • Affiliate.id - Id of affiliate.
    • Note: For use when including additional affiliate field other than id, otherwise recommended to use Stat.affiliate_id.
    • Values: (int)
  • Affiliate.company - Company name for affiliate.
    • Values: (string)
  • Stat.affiliate_manager_id - Id of employee assigned as affiliate account manager.
    • Values: (int)
  • AffiliateManager.id - Id of employee assigned as affiliate account manager.
    • Note: For use when including additional affiliate manager field other than id, otherwise recommended to use Stat.affiliate_manager_id.
    • Values: (int)
  • AffiliateManager.full_name - First and last name of affiliate account manger.
    • Values: (string)
  • Stat.offer_id - Id of offer.
    • Values: (int)
  • Offer.id - Id of offer.
    • Note: For use when including additional offer field other than id, otherwise recommended to use Stat.offer_id.
    • Values: (int)
  • Offer.name - Name for offer.
    • Values: (string)

Mod Logs Report Fields

  • ModLog.id
    • Values: (int)
  • ModLog.ip
    • Values: (string)
  • ModLog.country_code
    • Values: (string)
  • ModLog.region
    • Values: (string)
  • ModLog.url
    • Values: (string)
  • ModLog.session
    • Values: (string)
  • ModLog.action
    • Values: (string)
  • ModLog.type
    • Values: (string)
  • ModLog.message
    • Values: (string)
  • ModLog.count
    • Values: (string)
  • ModLog.datetime
    • Values: (timestamp)
  • ModLog.date
    • Values: (date)
Retrieved from "http://wiki.hasoffers.com/wiki/Api_Model:Stat"

 
Email this page to a friend or co-worker