NATS4 REST API Get Affiliate Hit Data
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 affiliate/hits
Description
- NATS4 has a REST API resource to get affiliate hit data for a specific time frame. You can choose a specific site or receive the hit data back for all of the sites.
Resource URL
- http://domain/api/affiliate/hits
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Paremeters can be sent as url encoded params. See examples below.
- loginid: The affiliate ID. This parameter is required.
- type: integer
- required
- siteid: The siteid you wish to grab hit data for. If not supplied, NATS will grab hit data for all sites.
- type: integer
- optional
- start_date: The beginning date for the data you wish to see. Date will be parsed by the PHP strtotime function. A valid date can be YYYY-MM-DD.
- optional
- end_date: The ending date for the data you wish to see. Date will be parsed by the PHP strtotime function. A valid date can be YYYY-MM-DD.
- optional
Example Request
GET
http://domain.com/api/affiliate/hits
- Response:
{ "raw": 118, "unique": 19, "qualified": 0, "join_hits": 190, "join_submits": 63 }
Example Code
PHP
<?php $curl = curl_init(); $data = array( 'loginid' => 1, 'siteid' => 1, 'start_date' => '2006-06-06', 'end_date' => '2015-03-15' ); $data_string = http_build_query($data); $url = 'http://domain/api/affiliate/hits?'.$data_string; $headers = array( 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: tmm1phrvezsbu' ); 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 var_dump(json_decode($resp, true)); // Close request to clear up some resources curl_close($curl); ?>
Python
- This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests url = 'domain/api/affiliate/hits' params = { 'loginid': 1, 'siteid': 1, 'start_date': '2006-06-06', 'end_date': '2015-03-15' } headers = { 'api-key': '44b5498dbcb481a0d00b404c0169af62', 'api-username': 'tmm1phrvezsbu' } res = requests.get(url, params=params, headers=headers) print res.json()
node.js
- This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request'); var options = { url: 'http://domain/api/affiliate/hits', method: 'GET', qs: { 'loginid': 1, 'siteid': 1, 'start_date': '2006-06-06', 'end_date': '2015-03-15' }, json: true, headers: { 'api-key': '44b5498dbcb481a0d00b404c0169af62', 'api-username': 'tmm1phrvezsbu' } }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } else{ console.log(body); } } request(options, callback);
Curl
curl -X GET 'http://domainm/api/affiliate/hits?loginid=1&siteid=1&start_date=2006-06-06&end_date=2015-03-15' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"