Difference between revisions of "NATS5 REST API Service GET stats-breakdowns"
From TMM Wiki
Jump to navigationJump to searchLine 1: | Line 1: | ||
{{NATS5 Manual | {{NATS5 Manual | ||
− | | | + | | show_api_admin_service_section = true |
}} | }} | ||
== '''GET /service/stats-breakdowns''' == | == '''GET /service/stats-breakdowns''' == |
Latest revision as of 16:01, 9 August 2019
GET /service/stats-breakdowns
Description
- Get a list of NATS stats breakdowns
Resource URL
- http://domain/api/service/stats-breakdowns
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/service/stats-breakdowns
Response:
{ "success": true, "breakdowns": [ { "value": 0, "name": "date" }, { "value": 1, "name": "site" }, { "value": 2, "name": "tour" }, { "value": 3, "name": "program" }, { "value": 4, "name": "campaign" }, { "value": 5, "name": "country" }, { "value": 6, "name": "refurl" }, { "value": 7, "name": "adtool" } ] }
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(); $request = Array( 'method' => 'GET', 'path' => 'v1/service/stats-breakdowns', '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); ?>