Get Historical Position API

A heat map is a graphical representation of two-dimensional data (X, Y values) on a two-dimensional surface using colors. It represents the density of latitude and longitude points on a map. The Historical Position API uses a heat map to display the customer’s historical position (X,Y) as a blue dot, based on visible light communication (VLC) technology, during a given period of time.

METHOD:	GET
URI:	<production url>/v1/locations
SAMPLE URI:	<production url>/v1/locations/1000000106/analytics?analytic-names=HTMPXY&analytic-categories=POSITION&start-ts=1461171600000&end-ts=1461256935323

Query Parameters

Parameter	Description	Required?	Values
id	GE identifier for a location	Yes	For example, 1000000106
analytic-name	Identifies the heat map X & Y.	Yes	String, such as HTMPXY.
analytic-category	Position	Yes	String, such as POSITION.
start-ts	Start time in milliseconds.	Yes	Number, with a value, such as 1459990991343
end-ts	End time in milliseconds.	Yes	Number, with a value, such as 9458002961202

Response Parameters

Parameter	Data Type	Provided?	Description
properties	Map	Yes	Custom properties captured for this event type instance.
….x	Number	Yes	GPS coordinate for latitude (x-axis value), such as 40.
….y	Number	Yes	GPS coordinate for longitude (y-axis value), such as 454.
….z	Number	Yes	GPS coordinate for height, which is 0, meaning it is not being measured.
….weight	Number	Yes	The number of devices occupying a single position (X,Y), such as 6, which means a single device is occupying the position.
….time-stamp	Number	Yes	Actual timestamp when event occurred, expressed in seconds, such as 1461173320786.

Sample Response

{
  "analyticCategory": "POSITION",
  "analyticName": "HTMPXY",
  "properties": [
    {
      "x": 40,
      "y": 454,
      "z": 0,
      "weight": 6,
      "time-stamp": 1461173320786
    },
    {
      "x": 40,
      "y": 455,
      "z": 0,
      "weight": 9,
      "time-stamp": 1461173320786
    },
    {
      "x": 112,
      "y": 440,
      "z": 0,
      "weight": 1,
      "time-stamp": 1461175510881
    }
  ]
}