Difference between revisions of "NATS5 REST API Report GET surfer"
From TMM Wiki
Jump to navigationJump to search| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_report_section = true |
}} | }} | ||
== '''GET /report/surfer''' == | == '''GET /report/surfer''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get the surfer action report | * Get the surfer action 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 81: | Line 82: | ||
** optional | ** optional | ||
* '''direction''' | * '''direction''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 140: | Line 141: | ||
</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 16:01, 9 August 2019
GET /report/surfer
Description
- Get the surfer action report
Resource URL
- http://domain/api/report/surfer
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- focus
- optional
- widget
- optional
- display
- type: string
- optional
- output_format
- type: string
- optional
- period
- optional
- start
- optional
- count
- type: digit
- optional
- end
- optional
- filter_loginid
- optional
- filter_loginid_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_action_type
- optional
- filter_action_type_compare
- type: string
- optional (default value: =)
- filter_details
- optional
- filter_details_compare
- type: string
- optional (default value: =)
- surfer_start
- type: digit
- optional
- surfer_count
- type: digit
- 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/surfer',
'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);
?>
