NATS For Networks REST Get Commission Changes
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
GET /offer/get_commission_changes
Description
- get_commission_changes gets a list of all commission changes for an offer. This can be used to get the change ids needed to update the commission change amouns in set_commission_change_payouts
Resource URL
- http://domain/api/offer/get_commission_changes
- Replace domain with the NATS For Networks domain
Response Format
- JSON
- GET
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
- offerid
- type: int
- required
- Id of the offer to get the commission changes for
Example Request
GET
http://domain/api/offer/get_commission_changes
- Response:
{ "result": "Success", "message": {"changes": [ { "Change Id": 55, "Start Time": "Never", "End Time": "Never", "Countries": ["All"] }, { "Change Id": 46, "Start Time": "Never", "End Time": "Never", "Countries": ["All"], "Affiliates": {"43": "davedomaintestac"}, "Sub Affiliates": { "Subaff": "a", "Subaff 2": "b", "Subaff 3": "c", "Subaff 4": "e", "Subaff 5": "e" } }, { "Change Id": 45, "Start Time": "2016-06-16 21:01:33", "End Time": "Never", "Countries": { "248": "AX", "012": "DZ", "008": "AL", "004": "AF" }, "Page View Payout": 5, "Unique Visitor Payout": 2, "Flat Conversion Payout": 3, "Flat Continuity Payout": 4, "Percentage Conversion Payout": 5, "Percentage Continuity Payout": 6, "CPM Payout": 7 }, { "Change Id": 44, "Start Time": "2016-06-09 17:26:05", "End Time": "Never", "Countries": { "004": "AF", "008": "AL", "016": "AS", "248": "AX", "012": "DZ" }, "Page View Payout": 6 }, { "Change Id": 0, "Start Time": "2016-11-03 17:52:55", "End Time": "Never", "Countries": ["All"], "Page View Payout": 1, "Unique Visitor Payout": 2, "Flat Conversion Payout": 3, "Flat Continuity Payout": 4, "Percentage Conversion Payout": 5, "Percentage Continuity Payout": 6, "CPM Payout": 7 }, { "Change Id": 0, "Start Time": "2016-06-16 19:56:26", "End Time": "Never", "Countries": ["All"], "offer_goal_id": 48, "Pay Affiliate Managers": true, "Pay Referring Affiliates": false, "Pay Offer Partners": false, "Percentage Conversion Payout": 10 }, { "Change Id": 17, "Start Time": "2016-06-16 21:04:36", "End Time": "Never", "Countries": { "012": "DZ", "024": "AO", "008": "AL", "020": "AD", "004": "AF", "016": "AS", "660": "AI" }, "offer_goal_id": 50, "Pay Affiliate Managers": true, "Pay Referring Affiliates": false, "Pay Offer Partners": false, "Percentage Conversion Payout": 25 }, { "Change Id": 0, "Start Time": "2016-06-16 19:57:23", "End Time": "Never", "Countries": ["All"], "offer_goal_id": 50, "Pay Affiliate Managers": true, "Pay Referring Affiliates": false, "Pay Offer Partners": false, "Percentage Conversion Payout": 25 }, { "Change Id": 0, "Start Time": "2016-09-06 21:30:45", "End Time": "Never", "Countries": ["All"], "offer_goal_id": 54, "Pay Affiliate Managers": false, "Pay Referring Affiliates": true, "Pay Offer Partners": false } ]} }
NOTE: change id 0 is the default commission value for the offer or goal that it goes with
Example Code
PHP
<?php $curl = curl_init(); $url = 'http://domain/api/offer/get_commission_changes'; $headers = array( 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: productsupport' ); $data = array( 'offerid' => 2 ); $data_string = http_build_query($data); $url .= '?'.$data_string; curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_URL, $url); $resp = curl_exec($curl); //dumps an associative array representation of the json response $output = json_decode($resp, true); if($output !== NULL) { //json was valid. Dump the decoded array print_r($output); } else { //invalid json, just dump the raw response print_r($resp); } // Close request to clear up some resources curl_close($curl); ?>