NATS For Networks REST API Get Profit Loss Report
From TMM Wiki
GET /profitlossreport
Description
- NATS for Networks supports an API resource to grab all the stats used within the NATS profit and loss report.
Resource URL
- http://domain/api/service/profitloss
- Replace domain with the nats domain
- GET
Response Format
- JSON
[[[NATS_For_Netowrks_REST_API_Overview#Authentication|Authentication]]
- HTTP headers
- view - The breakdown of the report to display. Possible options are:
- period
- month
- year
- offer_group
- landing_page
- offer
- subid1
- subid2
- login
- adtool
- demographic
- refurl
- params - Parameters for the report. An array that may contain:
- period - Which period of time to select data for. See below for more information regarding the periods within NATS.
- start - start date for the stats. Used when period is not sent or set to 8
- end - end date for the 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 affiliates assigned to the account rep
- filter_loginid - Only see stats for the specifc login ID passed in.
- filter_campaignid - Only see stats for the specific campaign ID for the affiliate. (Can only be used if filter_loginid is passed in)
- filter_offerid - Only see stats for the specific site ID passed in.
- filter_landingpageid - Only see stats for the specific tour ID passed in.
- filter_adtoolid - Only see stats for the specific adtool ID passed in.
- filter_programid - Only see stats for the specific program ID passed in.
- filter_countryid - Only see stats for the specific Country ID passed in.
- productcode - Breakdown the NATS code and only view stats associated with the NATS code.
- limit_inhouse - 0 for all affiliates, 1 for only inhouse, 2 to exclude inhouse.
- limit_mediabuy - 0 for all affiliates, 1 for only media buys, 2 to exclude media buys.
- filter_device_type - 0 for desktop, 1 for mobile, unset for all types.
- filter_device_brand_id - Device Brand ID.
- filter_device_model_id - Device Model ID.
- filter_device_os_id - Operating System ID.
- filter_device_browser_id - Browser ID.
- filter_device_carrier_id - IP/Carrier.
Periods
| # | Name | Argument Description |
|---|---|---|
| 0 | current | Current Period |
| 1 | last | Last Period |
| 2 | today | Today |
| 3 | yesterday | Yesterday |
| 4 | week | This Week |
| 5 | month | This Month |
| 6 | year | This Year |
| 7 | all | All Time |
| 8 | free | Freeform (See also the start and end parameters above) |
NuSOAP Example
This example continues from the main article NuSOAP Example):
$params = Array(
'view' => 'year',
'params' => Array(
'period' => '8',
'start' => '2012-01-01',
'end' => '2012-12-30',
),
);
$result = $client->call('report/profitloss', $params, 'natsapiadmin_wsdl');
print_r($result);
