Get Historical Path API

The Historical Path API identifies a historical path of the device through known or defined zones. It computes the path taken by each device or user during the given period of time and constructs a list containing the zone name and the weight, or time, in seconds.

Path zone analysis for the device helps to understand space usage and behaviors. This data can provide insights regarding customer or staff behavior, augmented user engagements, staff efficiencies, navigation, waypoint finding, and indoor analytics.

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

Query Parameters

Parameter	Description	Required?	Values
id	GE identifier for a location.	Yes	For example, 1000000106
analytic-name	Path device	Yes	String such as PTHDVCE.
analytic-category	Path	Yes	String such as PATH.
start-ts	Start time in milliseconds.	Yes	Number with a value, such as 1457935501860.
end-ts	End time in milliseconds.	Yes	Number with a value such as 1457935810571.

Response Parameters

Parameter	Data Type	Required?	Description
properties	Map	No	Custom properties captured for this event type instance.
….device-id	String	Yes	Unique ID for the device used for this event, such as P_8.
….session-id	String	Yes	Unique ID to identify this event defined at the system source, such as 92111662-d561-4e02-b926-bb7e6cd1feb0.
….session-start	Number	Yes	Event start time recorded in milliseconds and UTC format, such as 1461175225473.
….session-stop	Number	Yes	Event stop time recorded in milliseconds and UTC format, such as 1461175235474.
….path-weight	String, followed by Number	Yes	Zones occupied within the store, followed by the time (seconds) spent in that zone. For example, Zone-2: 114, where "Zone-2" is the name of a zone and "114" is the number of seconds spent in that zone.

Sample Response

{
  {
  "analyticCategory": "PATH",
  "analyticName": "PTHDVCE",
  "properties": [
    {
      "device-id": "P_8",
      "session-id": "92111662-d561-4e02-b926-bb7e6cd1feb0",
      "sesion-start": 1461175225473,
      "session-end": 1461175235474,
      "path-weight": {
        "Entry-Exit": 3
      }
    },
    {
      "device-id": "P_8",
      "session-id": "a3787d86-12d7-43a2-a3c6-f9ff4262c4ce",
      "sesion-start": 1461173320795,
      "session-end": 1461174825795,
      "path-weight": {
        "Entry-Exit": 1,
        "": 118,
        "Zone-2": 114,
        "Zone-1": 66
      }
    }
  ]
}