F100327-04
API Documentation
6
3.0 Export Footfall Data to Retailer System
3.1 Pull Data via API from counter
The camera automatically collects the traffic data and builds them into a convenient JSON/XML data file that can be retrieved easily via a web
service API call, hence allowing seamless integration of the camera into any existing solution. Through an API call, the data file will be extracted
from FootfallCam portal to the business intelligence system for further data processing in order to generate the management report.
3.1.1 Counter API Terminology and Parameters
For counter data we use following terminology and parameters:
Parameter
Default
Description
Value
Sample
data_type
json
Type of the data
json, xml
data_type=xml
data_format
Hour
Format of the data
hour, minute, second
data_format=second
date_start
Yesterday’s
date
Start Date of the data
YYYMMDD
date_start=20181231
date_end
-
End Date of the data
YYYYMMDD
date_end=20190228
resolution_min
1
The minutes data’s
resolution (Minutes data
only)
1, 5, 10, 15, 30, 60
resolution_min=15
resolution_sec
10
The second data’s
resolution (Only available
for counter running firmware
version 3.2.0)
1, 5, 10, 15, 30, 60
resolution_sec=1
time_start
1 day [0:00]
To set the start time range
of the API
HHmmss
time_start=103000
time_end
1 day [23:59]
To set the end time range of
the API
HHmmss
time_end=223300
Note:
The maximum amount of data you can get from time range is 24 hours. Both time range start and end should be set.
-
time_start is set, but time_end is not = default time_end will be 1 hour after time_start
-
time_end is set, but time_start
is not = default time_start will be “000000”
