Retrieve historical Geo PCL data (GET)

The GET command is used to view data the system has aggregated for a given Geo PCL definition for a specific period of time in the past using a calculation, such as a percentile, minimum, median, or average.

Additional parameters let you specify how granular the data is (either aggregated in five-minute intervals for the past 3 days, or 1 hour intervals for the past 30 days).

Command overview

Method — GET

Resource — geopcl/<geoPCLDefinitionID>/historical where <geoPCLDefinitionID> is the integer that identifies the Geo PCL definition (the Geo PCL definition ID)

Parameters

^{1 This parameter is required.}

Sample request

https://<ip>/rest/geopclapi/1.0/geoPcl/1/historical?usr=jdoe&pwd=pa55w0rd!&stat=avg&startTime=1263915600000&granularity=five_minutes&timelineEndTime=1263917900000&nbOfBuckets=1

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<status result="success"></status>
<result>
<data lastConfigChange="1263913720147">
  <min>1</min>
  <max>79294</max>
  <buckets>
   <bucket start="1263915600000" end="1263915900000">
    <zones>
     <zone id="1">
      <areas>
       <area id="1211080859" volume="128" statLatency="9" pcl="S"
       satisfiedVolume="128" toleratingVolume="0" previousVolume="230"
       previousPcl="S"/>
       <area id="1204420371" volume="42" statLatency="37" pcl="S"
       satisfiedVolume="42" toleratingVolume="0" previousVolume="18"
       previousPcl="S"/>
       <area id="1211080891" volume="36" statLatency="119" pcl="S"
       satisfiedVolume="36"toleratingVolume="0" previousVolume="64"
       previousPcl="S"/>
       <area id="1211080630" volume="17" statLatency="9" pcl="S"
       satisfiedVolume="17" toleratingVolume="0" previousVolume="28"
       previousPcl="S"/>
      </areas>
     </zone>
    </zones>
   </bucket>
  </buckets>
</data>
</result>
</response>