API Reference

Vhost.getAPIDailySummary

Get the daily API summary for a project for a period of time.

Syntax

mixed vhost.getAPIDailySummary ( INT vhostId, Date startDate = NULL, Date endDate = NULL, mixed summarizeBy = 3 )

Arguments

Name	Type	Required	Default value	Description
vhostId	INT	Required	none	The Id of the vhost.
startDate	Date	Optional	NULL	The start of the time period for the storage data. Format: Unix timestamp or 'YYYY-MM-DD'
endDate	Date	Optional	NULL	The number of records that you want returned.
summarizeBy	mixed	Optional	3

Response

Name	Type	Description	Possible Values
date	Date	The date for the storage value.	YYYY-mm-dd
count	INT	The total API calls for the day.	0
total_count	INT	The running total of the API calls up to the end of that date in the timeframe. It is available in each item of the results and specific to that date. (It is available as result->item->total_count)	0
totalCount	INT	The overall total of the API calls for the specified timeframe. (It is available as result->totalCount)	0

Sample Response

Code examples

PHP-RPC

$path = 'https://api.newspark.ca/services/php';

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'vhost.getAPIDailySummary',
  'vhostId' => $vhostId,
  'startDate' => $startDate,
  'endDate' => $endDate,
  'summarizeBy' => $summarizeBy
);

// http_build_query basically turns an array into a url-encoded list of variables
$url = $path .'?' . http_build_query($arguments,null,'&');

// get the contents from the specified url
$data = file_get_contents($url);

// transform it back into php data structures
$data = unserialize($data);

// the actual data is stored in $data['result']

print_r($data['result']);

PEAR XMLRPC client

// Include the client
require_once 'XML/RPC.php';

// Create the XMLRPC Client
$client = new XML_RPC_Client('/services/xmlrpc?APIKEY={YOURAPIKEY}', 'api.newspark.ca');

// PEAR's XML-RPC client requires all arguments to wrapped in a special value class
// XML_RPC_encode converts this automatically

$arguments = array(
  XML_RPC_encode($vhostId),
  XML_RPC_encode($startDate),
  XML_RPC_encode($endDate),
  XML_RPC_encode($summarizeBy)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('vhost.getAPIDailySummary',$arguments);

// Sending the message to the server
$response = $client->send($message);

// We also need to decode the response back to normal PHP types
$response = XML_RPC_decode($response);

print_r($response);

SabreTooth XMLRPC client

// Include the client
require_once 'Sabre/XMLRPC/Client.php';

// Create the XMLRPC Client
$xmlrpc = new Sabre_XMLRPC_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  $vhostId,
  $startDate,
  $endDate,
  $summarizeBy
);

$data = $xmlrpc->invoke('vhost.getAPIDailySummary',$arguments);

print_r($data);

Zend XMLRPC client

// Include the client
require_once 'Zend/XmlRpc/Client.php';

// Create the XMLRPC Client
$client = new Zend_XmlRpc_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  $vhostId,
  $startDate,
  $endDate,
  $summarizeBy
);

$data = $client->call('vhost.getAPIDailySummary',$arguments);

print_r($data);

Actionscript 2

    /*
     *     In ActionScript 2 remote service calls are done using the RemotingConnector Component.
     *     An instance of the component must exist on the stage and have an instance name.
     *
     *     Results and Faults are handled by addEventListener's and the call parameters are placed inside of an associative array
     *
     *     You must also specify the service class and method names under the appropriate property fields of the component
     */

    var gatewayURL:String = "/services/amf2";
    //Set up service call
    myRemConn_rc.gatewayUrl = gatewayURL;
    myRemConn_rc.serviceName = "vhost";
    myRemConn_rc.methodName = "getAPIDailySummary";
    myRemConn_rc.params = {vhostId:vhostId, startDate:startDate, endDate:endDate, summarizeBy:summarizeBy};
    myRemConn_rc.addEventListener("result", widgetResult);
    myRemConn_rc.addEventListener("status", widgetFault);

    //Make the call
    myRemConn_rc.trigger();

    /*
    *  Handles service result.
    */
    function widgetResult(ev:Object){
        //Do stuff
        //Data is returned inside of ev.target.results
        //(i.e. ev.traget.results.description or ev.traget.results.settings.color)
    }

    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object){
        //Display Error
        trace("Categories Error - " + ev.code + " -  " + ev.data.faultstring);
    }

Actionscript 3

    /*
     *  In ActionScript 3 remote service calls are done using the NetConnection Object.
     *  A Responder Object controls what functions handle successful or failed calls
     *  and any parameters for the call are placed in an array and passed as a parameter
     *  in the NetConnection.call() method.
     */

    var gatewayURL:String = "/services/amf2";
    var parameters:Array = new Array(vhostId, startDate, endDate, summarizeBy);

    var connection:NetConnection = new NetConnection();
    connection.connect(gatewayURL);
    connection.call("vhost.getAPIDailySummary", new Responder(widgetResult, widgetFault), parameters);


    /*
     *   Handles service result.
     */
    function widgetResult(ev:Object):void{
        //Do stuff
        //Data is returned inside of ev
        //(i.e. ev.description or ev.settings.color)
    }


    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object):void{
        //Display Error
        error.showError(parentClip, ev.code + " -  " + ev.description, "Please refresh your browser to try again.");
        error.x = (parentClip.width - error.width) / 2;
        error.y = (parentClip.height - error.height) / 2;
    }

REST service example

<%@ Page Language="vb" %>
<%


' REST gateway
dim gateway as string = "http://api.newspark.ca/services/rest/"

' Service + method we're calling.
dim method as string = "vhost/getAPIDailySummary"

dim apiKey as string = "YOURAPIKEY"

dim url as string = gateway & method & "?APIKEY=" & apiKey &  "&vhostId=" & vhostId

' HTTP Client
dim wcHTTPScrape as new System.net.WebClient()

' Opening a stream
dim objInput as System.IO.Stream = wcHTTPScrape.OpenRead(url)

dim objReader as new System.IO.StreamReader ( objInput )

' Reading the entire HTTP response and output it
Response.Write ( objReader.ReadToEnd () )


objReader.Close ()
objInput.Close ()

%>

jQuery JSON

/*
* jQuery post example
*/

function getAPIDailySummary ( vhostId, startDate, endDate, summarizeBy ) {

var params = {
    "method" :      'vhost.getAPIDailySummary',
    "vhostId" :     vhostId,
    "startDate" :   startDate,
    "endDate" :     endDate,
    "summarizeBy" : summarizeBy}

$.post('/services/json',params
,function(response){
    console.log(response);
});

Local API

// Get the Service Mapper

$mapper = Sabre_ServiceMap_Mapper::getMapper();

// Calling the method
$data = $mapper->vhost->getAPIDailySummary( $vhostId, $startDate, $endDate, $summarizeBy );

print_r($data);

0 comments

Be the first to comment on getAPIDailySummary.

Developer Documentation Portal