Difference between revisions of "NATS5 REST API Member GET surfer-actions"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Member GET surfer-actions to NATS5 REST API Member GET surfer-actions: Renaming NATS5 API pages) |
|
(No difference)
| |
Revision as of 15:18, 9 August 2019
GET /member/surfer-actions
Description
- Get surfer actions for a member
Resource URL
- http://domain/api/member/surfer-actions
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- memberid
- optional
- start
- type: digit
- optional
- count
- type: digit
- optional (default value: 50)
Example Request
Method: GET
URL: http://domain/api/member/surfer-actions
Query String: memberid=2
Response:
{
"actions": [
{
"surfer_action_id": "3",
"identid": "4",
"loginid": "0",
"networkid": "0",
"session": "cd96844378cc8b89b1b93834a4f2bc2a",
"time": "1559929898",
"type": "18",
"extra1": "1",
"extra2": "0",
"details": {
"campaignid": {
"campaignid": null,
"loginid": null,
"name": null,
"description": null
},
"programid": {
"programid": null,
"program": null,
"type": null,
"name": null,
"deleted": null,
"hidden": null
},
"siteid": {
"siteid": "1",
"site": "member_a",
"name": "Membership Site A",
"type": "0",
"deleted": "0",
"hidden": "0"
},
"tourid": {
"tourid": "1",
"tour": "MAIN",
"name": "Default Tour",
"siteid": "1",
"url": "https:\/\/www.google.com",
"linkdomain": "root.nats4.com",
"description": "",
"hidden": "0",
"deleted": "0"
}
},
"campaignid": "0",
"programid": "0",
"siteid": "1",
"tourid": "1",
"optionid": "0",
"adtoolid": "0",
"subid1": "0",
"subid2": "0",
"billerid": "0",
"countryid": "000",
"promotionalid": "0",
"type_nice": "Manual Add",
"description_details": {
"description": "",
"extra": [
{
"field": "status",
"value": "Active"
},
{
"field": "trial",
"value": "No"
}
]
}
}
],
"total_count": 1,
"session": "cd96844378cc8b89b1b93834a4f2bc2a"
}
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(
'memberid' => '2',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/member/surfer-actions',
'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);
?>
