Pedestrian Planning

There are three ways to retrieve near real-time data:
  • By AssetUid
  • By Locations
  • By LocationUid
There are three ways to retrieve historical data:
  • By AssetUid
  • By Locations
  • By LocationUid

LocationUid is configured to identify a single walkway when used for pedestrian planning. The node will capture pedestrian movement in both directions, as defined in the measures "direction" and "counter_direction", and displays the direction, pedestrian count, and speed of pedestrian movement. See the parameter "measures - weighted average direction" definition in this section.

Note: The node provides a maximum of 1 response / per second for both directions.
Note: The timestamp returned is the end of the averaging interval; for pedestrian data, this interval begins 15 seconds earlier. For example, if you are trying to capture pedestrian data on March 27th as of 12:02:00, you will need to include data from the beginning of the interval at 12:01:45.

Near Real-Time Data

The WebSocket URL provides a link to near-real-time data for Pedestrian events. You must use a WebSocket client to retrieve this data.

Retrieve Near-Real-Time Data by AssetUid

WebSocket URL wss://<production url>/events
JSON Request Parameters {“assetUid":"<assetUID>","eventTypes":["<eventType1>”]}
Sample JSON Request {“assetUid":"CAMERA-HYP1083-CAM-L","eventTypes":["PEDEVT”]}

JSON Request Parameters

Parameter Description Required? Filter Values
assetUid GE identifier for the device. Yes Value such as "CAMERA-HYP1083-CAM-L".
eventTypes Filter for pedestrian events. Yes Insert PEDEVT to receive a list of pedestrians by count, direction, and speed within the monitored boundary.

Retrieve Near Real-Time Data by Locations

WebSocket URL wss://<production url>/events
JSON Request Parameters {"bbox":"<lat1:long1>,<lat2:long2>","eventTypes":[“ <eventType1>”]}
Sample JSON Request {"bbox":"32.715675:-117.161230,32.708498:-117.151681","eventTypes":[“PEDEVT”]}

JSON Request Parameters

Parameter Description Required? Filter Values
bbox GPS location of the asset Yes Value such as "32.715675:-117.161230,32.708498:-117.151681".
eventTypes Filter for pedestrian events. Yes Insert PEDEVT to receive a list of pedestrians by count, direction, and speed within the monitored boundary.

Retrieve Near Real-Time Data by LocationUid

WebSocket URL wss://<production url>/events
JSON Request Parameters {“locationUid":"<location-UID>","eventTypes":[" <eventType1>"]}
Sample JSON Request {“locationUid":"LOCATION-282","eventTypes":["PEDEVT"]}

Query Parameters

Parameter Description Required? Filter Values
locationUid The identifier assigned to this location   Value such as "LOCATION-282"
eventTypes Filter for pedestrian events. Yes Insert PEDEVT to receive a list of pedestrians by count, direction, and speed within the monitored boundary.

Retrieve Historical Data by AssetUid

METHOD GET
URI <production url>/v2/assets/{assetUid}/events?eventTypes=PEDEVT&{startTime,endTime}
Sample Request URI <production url>/v2/assets/CAMERA-HYP1039-CAM-F/events?eventTypes=PEDEVT&startTime=1473897230802&endTime=1473898239338

Query Parameters

Parameter Description Required? Filter Values
assetUid GE identifier for the device. Yes Value such as CAMERA-HYP1039-CAM-F
events? Query for historical data   eventTypes
eventTypes Filter for pedestrian events. Yes Insert PEDEVT to receive a list of pedestrians by count, direction, and speed within the monitored boundary.
startTime Start time (timestamp) recorded in EPOCH format. Yes Numerical value, such as 1453766605577.
Note: If you use the same timestamp for startTime and endTime, a single result will be returned.
endTime End time (timestamp) recorded in EPOCH format. Yes Numerical value, such as 1453772603879.

Retrieve Historical Data by Locations

METHOD GET
URI <production url>/v2/locations/events?eventTypes=PEDEVT&bbox={lat1:long1,lat2:long2}&locationType=WALKWAY&{startTime,endTime}
Sample Request URI <production url>/v2/locations/events?eventTypes=PEDEVT&bbox=32.715675:-117.161230,32.708498:-117.151681&locationType=WALKWAY&startTime=1473897230802&endTime=1473898239338

Query Parameters

Parameter Description Required? Filter Values
bbox The GPS-defined area containing the asset Yes Value such as 32.715675:-117.161230,32.708498:-117.151681.
events? Query for historical data   eventTypes
eventTypes Filter for pedestrian events. Yes Insert PEDEVT to receive a list of pedestrians by count, direction, and speed within the monitored boundary.
startTime Start time (timestamp) recorded in EPOCH format. Yes Numerical value, such as 1453766605577.
Note: If you use the same timestamp for startTime and endTime, a single result will be returned.
endTime End time (timestamp) recorded in EPOCH format. Yes Numerical value, such as 1453772603879.

Retrieve Historical Data by LocationUid

METHOD GET
URI <production url>/v2/locations/{locationUID}/events?eventTypes=PEDEVT&{startTime,endTime}
Sample Request URI <production url>/v2/locations/LOCATION-30-1039-2-S/events?eventTypes=PEDEVT&startTime=1473897230802&endTime=1473898239338

Query Parameters

Parameter Description Required? Filter Values
locationUid The specific location within the bounding box Yes Value such as LOCATION-30-1039-2-S
events Query for historical data   eventTypes
eventTypes Filter for pedestrian events. Yes Insert PEDEVT to receive a list of pedestrians by count, direction, and speed within the monitored boundary.
startTime Start time (timestamp) recorded in EPOCH format. Yes Numerical value, such as 1453766605577.
Note: If you use the same timestamp for startTime and endTime, a single result will be returned.
endTime End time (timestamp) recorded in EPOCH format. Yes Numerical value, such as 1453772603879.

Response Parameters

Parameter Data Type Description
locationUid String Unique, customer-defined identifier, for a specific location within the monitored area.
assetUid String The customer-defined identifier for a specific asset at this location.
eventTypes String Identifies this kind of event:
PEDEVT
Insert PEDEVT to receive a list of pedestrians by count, direction, and speed within the monitored boundary.
timestamp Number Actual timestamp when event occurred. Timestamps are in EPOCH format.
properties Map Properties of the event
directionUnit
unit = DEGREE
DEGREE represents the direction of travel for any pedestrian(s).
See the Degree Range and Direction Value diagram below.
speedUnit
METERS_PER_SEC is the average speed of any pedestrian(s) in meters-per-second (m/s).
measures String Pedestrian properties being tracked by the device.
weighted average direction
value = from 0 to 360
Weighted average direction calculates the average direction of pedestrians.
The node will display pedestrian movement in opposite directions as two different values. For example, if a given walkway is oriented North/South, (North =0; South=180), and you run the API call for the Northern direction of travel, direction output will display:
“direction”: 0.
When you run the API for the Southern direction of travel, direction output will display:
“direction”: 180.
See the Degree Range and Direction Value diagram below.
counter_direction
Counter-direction defined by degree(s).
See weighted average direction (above) for general description.
weighted average speed
value = X, unit = meters per second (METERS_PER_SEC)
Weighted average speed calculates the average speed of pedestrians in a specific direction.
counter_direction_speed
value = X, unit = meters per second (METERS_PER_SEC)
pedestrianCount
value = count, unit = number
Pedestrian count calculates the total number of pedestrians traveling in a specific direction.
counter_direction_pedestrianCount
value = count, unit = number
Pedestrian count calculates the total number of pedestrians traveling in a specific direction.
Degree Range and Direction Value

Sample Response


{
            "locationUid": "LOC-ATL-0001-W1",
            "assetUid": "CAM-ATL-0001-1",
            "eventType": "PEDEVT",
            "timestamp": 1508389403853,
            "properties": {
                "directionUnit": "DEGREE",
                "speedUnit": "METERS_PER_SEC",
            },
            "measures": {
                "counter_direction": 188,
                "counter_direction_pedestrianCount": 33,
                "counter_direction_speed": 3.6666667,
                "direction": 8,
                "pedestrianCount": 0,
                "speed": 0
            }
  }