Difference between revisions of "NATS5 REST API Report GET profitloss"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS5 Manual | show_api_admin_section = true }} == '''GET /report/profitloss''' == '''Note''': This is an autogenerated wiki page for the NATS5 API. There may be additional...") |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{NATS5 Manual | {{NATS5 Manual | ||
| − | | | + | | show_api_admin_report_section = true |
}} | }} | ||
== '''GET /report/profitloss''' == | == '''GET /report/profitloss''' == | ||
| Line 50: | Line 50: | ||
** optional | ** optional | ||
* '''filter_countryid''' | * '''filter_countryid''' | ||
| + | ** optional | ||
| + | * '''filter_groupid''' | ||
** optional | ** optional | ||
* '''natscode''' | * '''natscode''' | ||
| Line 57: | Line 59: | ||
* '''no_typein''' | * '''no_typein''' | ||
** optional | ** optional | ||
| − | + | * '''inhouse''' | |
| + | ** optional | ||
== '''Example Code''' == | == '''Example Code''' == | ||
Latest revision as of 15:04, 6 April 2023
GET /report/profitloss
Note: This is an autogenerated wiki page for the NATS5 API. There may be additional descriptions or examples available on the NATS 4 API wiki for this API.
Description
- Get the profit/loss report (legacy)
Resource URL
- http://domain/api/report/profitloss
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- view
- optional
- period
- optional
- start
- optional
- end
- optional
- acct_rep
- optional
- filter_loginid
- optional
- filter_campaignid
- optional
- filter_siteid
- optional
- filter_tourid
- optional
- filter_optionid
- optional
- filter_adtoolid
- optional
- filter_billerid
- optional
- filter_programid
- optional
- filter_countryid
- optional
- filter_groupid
- optional
- natscode
- optional
- no_inhouse
- optional
- no_typein
- optional
- inhouse
- optional
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = array(
// Add API parameters here
);
$request = Array(
'method' => 'GET',
'path' => 'v1/report/profitloss',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
