Difference between revisions of "NATS5 REST API Report GET profit-loss"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Report GET profit-loss to NATS5 REST API Report GET profit-loss: Renaming NATS5 API pages) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_report_section = true |
}} | }} | ||
== '''GET /report/profit-loss''' == | == '''GET /report/profit-loss''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get the profit/loss report | * Get the profit/loss report | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 43: | Line 44: | ||
** optional | ** optional | ||
* '''total_only''' | * '''total_only''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''acct_rep''' | * '''acct_rep''' | ||
| Line 95: | Line 96: | ||
** type: string | ** type: string | ||
** optional (default value: =) | ** optional (default value: =) | ||
| + | * '''filter_groupid''' | ||
| + | ** optional | ||
* '''natscode''' | * '''natscode''' | ||
** optional | ** optional | ||
| Line 101: | Line 104: | ||
** optional (default value: =) | ** optional (default value: =) | ||
* '''no_inhouse''' | * '''no_inhouse''' | ||
| + | ** optional | ||
| + | * '''inhouse''' | ||
** optional | ** optional | ||
* '''no_typein''' | * '''no_typein''' | ||
| Line 114: | Line 119: | ||
** optional | ** optional | ||
* '''direction''' | * '''direction''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| − | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 173: | Line 177: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_report_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Missing_Autogenerated_Rest_Sample]]<!-- This article is missing a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Missing_Autogenerated_Rest_Sample]]<!-- This article is missing a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 15:12, 6 April 2023
GET /report/profit-loss
Description
- Get the profit/loss report
Resource URL
- http://domain/api/report/profit-loss
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- view
- optional
- focus
- optional
- widget
- optional
- display
- type: string
- optional
- output_format
- type: string
- optional
- period
- optional
- start
- optional
- count
- type: digit
- optional
- end
- optional
- total_only
- type: boolean_digit (0 or 1)
- optional
- acct_rep
- optional
- acct_rep_compare
- type: string
- optional (default value: =)
- filter_loginid
- optional
- filter_loginid_compare
- type: string
- optional (default value: =)
- filter_campaignid
- optional
- filter_campaignid_compare
- type: string
- optional (default value: =)
- filter_siteid
- optional
- filter_siteid_compare
- type: string
- optional (default value: =)
- filter_tourid
- optional
- filter_tourid_compare
- type: string
- optional (default value: =)
- filter_optionid
- optional
- filter_optionid_compare
- type: string
- optional (default value: =)
- filter_adtoolid
- optional
- filter_adtoolid_compare
- type: string
- optional (default value: =)
- filter_billerid
- optional
- filter_billerid_compare
- type: string
- optional (default value: =)
- filter_programid
- optional
- filter_programid_compare
- type: string
- optional (default value: =)
- filter_countryid
- optional
- filter_countryid_compare
- type: string
- optional (default value: =)
- filter_groupid
- optional
- natscode
- optional
- natscode_compare
- type: string
- optional (default value: =)
- no_inhouse
- optional
- inhouse
- optional
- no_typein
- optional
- trans_start
- type: digit
- optional
- trans_count
- type: digit
- optional
- order
- type: string
- optional
- direction
- type: boolean_digit (0 or 1)
- 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/profit-loss',
'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);
?>
