Offerit API Get Profit Loss Report
From Offerit
This functions allows for you to grab all the details for the profit and loss report remotely. The get_profit_loss_report accepts the following parameters:
- view - The breakdown of the report to display. The possible options are:
- period
- month
- year
- offer_group
- landing_page
- offer
- subid1
- subid2
- login
- adtool
- demographic
- params - Parameters for the report. Must be an array and may contain any of the following:
- period - Which period of time to select data for. The following are the allowed periods parameters for Offerit:
- 0 - Current Period
- 1 - Last Period
- 2 - Today
- 3 - Yesterday
- 4 - Past Week
- 5 - Past Month
- 6 - Past Year
- 7 - All Time
- 8 - Free Form Date
- start - Free Form start date for stats. Used when period is not sent or set to 8
- end - Free Form end date for stats. Used when period is not sent or set to 8
- acct_rep - View the profit and loss report as an account rep. Will only see stats for the affiliates assigned to the account rep.
- filter_loginid - Only see stats for the specific login ID passed in.
- filter_campaignid - Only see stats for the specific campaign ID for the affiliate. This parameter can only be used if filter_loginid is passed in.
- filter_offerid - Only see stats for the specific Offer ID passed in.
- filter_landing_pageid - Only see stats for the specific Landing Page ID passed in.
- filter_adtoolid - Only see stats for the specific Creative ID passed in.
- filter_offeritcode - Breakdown the Offerit code and only view stats associated with the Offerit code.
- no_inhouse - Remove in-house traffic from the returned report.
- no_typein - Remove type-in traffic from the returned report.
- period - Which period of time to select data for. The following are the allowed periods parameters for Offerit:
NuSOAP Example
This example continues from the main article NuSOAP Example:
$function = 'get_profit_loss_report'; $values = Array( 'view' => 'year', 'params' => Array( 'period' => 7, ), ); $result = $client->call($function, $values, 'offeritapiadmin_wsdl');
Sample Output
Array ( [total] => Array ( [breakdown] => year [row] => Array ( [page_view] => 18994 [unique_visitor] => 7970 [conversion] => 783 [conversion_amount] => 2722318 [advertiser_initial] => 6 [advertiser_initial_amount] => 9000 [phone_call] => 0 [phone_call_amount] => 0 [phone_conversion] => 0 [phone_conversion_amount] => 0 [affiliate_referral_join] => 58 [continuity] => 90 [continuity_amount] => 240066 [advertiser_income_amount] => 4600 [void] => 154 [void_amount] => -147406 [chargeback] => 21 [chargeback_amount] => -5700 [void_reversal] => 72 [void_reversal_amount] => 75816 [chargeback_reversal] => 1 [chargeback_reversal_amount] => 428 [affiliate_payout] => 3464990 [referral_join] => 0 [referral_payout] => 104802 [affiliate_manager_payout] => 286034 [partner_payout] => -80080 [tier_adjustment_payout] => 0 [correction_payout] => 0 ) ) [rows] => Array ( [0] => Array ( [break] => 1325394000 [stats] => Array ( [void] => 12 [void_amount] => -50200 [chargeback] => 0 [chargeback_amount] => 0 [void_reversal] => 12 [void_reversal_amount] => 50200 [chargeback_reversal] => 0 [chargeback_reversal_amount] => 0 [affiliate_payout] => 485237 [referral_payout] => 67686 [partner_payout] => -50000 [advertiser_income_amount] => 500 [name] => 1325394000 [advertiser_initial] => 0 [advertiser_initial_amount] => 0 [phone_call] => 0 [phone_call_amount] => 0 [phone_conversion] => 0 [phone_conversion_amount] => 0 [tier_adjustment_payout] => 0 [correction_payout] => 0 [page_view] => 13599 [unique_visitor] => 5988 [conversion] => 232 [conversion_amount] => 1780000 [affiliate_referral_join] => 40 [continuity] => 46 [continuity_amount] => 235000 [referral_join] => 0 [affiliate_manager_payout] => 177450 ) ) [1] => Array ( [break] => 1357016400 [stats] => Array ( [void] => 142 [void_amount] => -97206 [chargeback] => 21 [chargeback_amount] => -5700 [void_reversal] => 60 [void_reversal_amount] => 25616 [chargeback_reversal] => 1 [chargeback_reversal_amount] => 428 [affiliate_payout] => 2979753 [referral_payout] => 37116 [partner_payout] => -30080 [advertiser_income_amount] => 4100 [advertiser_initial] => 6 [advertiser_initial_amount] => 9000 [name] => 1357016400 [phone_call] => 0 [phone_call_amount] => 0 [phone_conversion] => 0 [phone_conversion_amount] => 0 [tier_adjustment_payout] => 0 [correction_payout] => 0 [page_view] => 5395 [unique_visitor] => 1982 [conversion] => 551 [conversion_amount] => 942318 [affiliate_referral_join] => 18 [continuity] => 44 [continuity_amount] => 5066 [referral_join] => 0 [affiliate_manager_payout] => 108584 ) ) ) )