1.1 Email

Please refer the step1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1136 - Data Export as the Job Type.

After click on the Create button, it will bring you to the Settings Page. Please fill in the necessary details required for the export, and do not leave blank for the mandatory field. To export data via email, you must select 'Email' for the Export Mode field.

Category	Field	Description
Data Extraction	1. Data	The available data that you can export.
	2. Entity Level	Entity level of the data to be exported. Available entity level: - Site - Site Group - Area - Area Group - Device
	3. Entity	Specifies the entity to be exported, dependent on the Entity Level selected. You must input the 'Entity Level' field before you can select the entity, and multiple selection is supported.
	4. Time Granularity	Specifies the time granularity of the data to be exported. Availability may varies based on the 'Entity Level' field, available selection: - Daily - Hourly - Minute
	5.Metrics	Specifies the metrics to be used for export, default selecting all available metrics.
	6. Export Mode	Specifies how the export mode. Please select 'Email'.
	7. File Format	Specifies the file extension of the output file. Available format: - Excel - CSV - Text
	8. 1 Row Per Metric	To make the metrics display in rows instead of columns.
	9. Customization  of File	If want to customize your file name and the file column, please tick this checkbox, and the Customization of File section will appear. Please refer to the description below for an explanation of its features and how to configure them.
	10. Recipient(s)	Specifies the recipient group(s) that will receive the exported output file. To setup recipient group, please refer here.
Data Load	11. Mode	Specifies if the recursiveness of the data export. Available data load mode: - One-off - Recurring
	Date Range	For 'One-off' export, specifies the range of the dates for the export data.
	Frequency	For 'Recurring' export, specifies the frequency of the data export. Available frequency: - Daily
	Next Running Date	For 'Recurring' export, specifies the next running date time, which need to be at least 1 hour after current time.

Customization of File

Once all required fields are filled, click on 'Create Job' button to start the job.

1.2 FTP / SFTP

Please refer the step1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1136 - Data Export as the Job Type.

After click on the Create button, it will bring you to the Settings Page. Please fill in the necessary details required for the export, and do not leave blank for the mandatory field. To export data via email, you must select 'Email' for the Export Mode field.

For the Data Extraction Section, both FTP and SFTP are the same.

Category	Field	Description
Data Extraction	1. Data	The available data that you can export.
	2. Entity Level	Entity level of the data to be exported. Available entity level: - Site - Site Group - Area - Area Group - Device
	3. Entity	Specifies the entity to be exported, dependent on the Entity Level selected. You must input the 'Entity Level' field before you can select the entity, and multiple selection is supported.
	4. Time Granularity	Specifies the time granularity of the data to be exported. Availability may varies based on the 'Entity Level' field, available selection: - Daily - Hourly - Minute
	6. Export Mode	Specifies how the export mode. Please select 'SFTP' or 'FTP'.
	7. File Format	Specifies the file extension of the output file. Available format: - Excel - CSV - Text
	8. 1 Row Per Metric	To make the metrics display in rows instead of columns.
	9. Customization  of File	If want to customize your file name and the file column, please tick this checkbox, and the Customization of File section will appear. Please refer to the description below for an explanation of its features and how to configure them.

FTP

SFTP

Once all required fields are filled, click on 'Create Job' button to start the job.

1.3 Link

Please refer the step1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1136 - Data Export as the Job Type.

After click on the Create button, it will bring you to the Settings Page. Please fill in the necessary details required for the export, and do not leave blank for the mandatory field. To export data via email, you must select 'Email' for the Export Mode field.

Category	Field	Description
Data Extraction	1. Data	The available data that you can export.
	2. Entity Level	Entity level of the data to be exported. Available entity level: - Site - Site Group - Area - Area Group - Device
	3. Entity	Specifies the entity to be exported, dependent on the Entity Level selected. You must input the 'Entity Level' field before you can select the entity, and multiple selection is supported.
	4. Time Granularity	Specifies the time granularity of the data to be exported. Availability may varies based on the 'Entity Level' field, available selection: - Daily - Hourly - Minute
	5.Metrics	Specifies the metrics to be used for export, default selecting all available metrics.
	6. Export Mode	Specifies how the export mode. Please select 'Link'.
	7. File Format	Specifies the file extension of the output file. Available format: (For Link we only have Excel) - Excel
	8. 1 Row Per Metric	To make the metrics display in rows instead of columns.
	9. Customization  of File	If want to customize your file name and the file column, please tick this checkbox, and the Customization of File section will appear. Please refer to the description below for an explanation of its features and how to configure them.
Data Load	10. Mode	Specifies if the recursiveness of the data export. Available data load mode: - One-off - Recurring
	Date Range	For 'One-off' export, specifies the range of the dates for the export data.
	Frequency	For 'Recurring' export, specifies the frequency of the data export. Available frequency: - Daily
	Next Running Date	For 'Recurring' export, specifies the next running date time, which need to be at least 1 hour after current time.

Customization of File

Once all required fields are filled, click on 'Create Job' button at the bottom right to start the job.

Download the link

Please wait until the status column shows Successful. Then click on View Details to go to the Export Job settings page.

Note: If select Link as the export mode, only the Excel file format will be available for download.

Scroll down the page, and you will see the File Location in the Data Load section. Click on Download File link to download the file.

1.4 Logic ERP

Please refer the step1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1136 - Data Export as the Job Type.

After click on the Create button, it will bring you to the Settings Page. Please fill in the necessary details required for the export, and do not leave blank for the mandatory field. To export data via email, you must select 'Email' for the Export Mode field.

Category	Field	Description
Data Extraction	1. Data	The available data that you can export.
	2. Entity Level	Entity level of the data to be exported. Available entity level: - Site - Site Group - Area - Area Group - Device
	3. Entity	Specifies the entity to be exported, dependent on the Entity Level selected. You must input the 'Entity Level' field before you can select the entity, and multiple selection is supported.
	4. Time Granularity	Specifies the time granularity of the data to be exported. Availability may varies based on the 'Entity Level' field, available selection: - Daily - Hourly - Minute
	5.Metrics	Specifies the metrics to be used for export, default selecting all available metrics.
	6. Export Mode	Specifies how the export mode. Please select 'Logic ERP'.
	7. 1 Row Per Metric	To make the metrics display in rows instead of columns.
	8. Customization  of File	If want to customize your file name and the file column, please tick this checkbox, and the Customization of File section will appear. Please refer to the description below for an explanation of its features and how to configure them.
Connection Settings	9. URL	Please enter the URL
	10. Username	Please enter the Username
	11. Password	Please enter the Password
Data Load	11. Mode	Specifies if the recursiveness of the data export. Available data load mode: - One-off - Recurring
	Date Range	For 'One-off' export, specifies the range of the dates for the export data.
	Frequency	For 'Recurring' export, specifies the frequency of the data export. Available frequency: - Daily
	Next Running Date	For 'Recurring' export, specifies the next running date time, which need to be at least 1 hour after current time.

Customization of File

Once all required fields are filled, click on 'Create Job' button to start the job.

1.5 Power BI Application

Please refer to this guideline link and follow the steps to get the data by using Power BI.

1.6 REST API

This section requires an API client such as Postman. You may get Postman here. The steps that are described in this section will be done via Postman, but you may utilize other API clients to perform the requests as well.

1.6.1 Generate an Access Token (AToken)

Access Token is required to verify the identification of the user and the data accessible. 

Step 1 - Set Request Method to POST.

Step 2 - Insert "https://v9.footfallcam.com/account/GenerateAccessToken" to the URL field.

Step 3 - Click on the 'Body' tab below the URL field. Select "raw" at the option below the tabs. You will need the parameters "email", "password", and "expiration". Consult your administrator for a valid credential to access.

Below is a sample of the three parameters. You might need to edit the expiration parameter to prevent immediate expiration of the Token.

{
     "email": "test@test.com",
     "password": "test!12345",
     "expiration": "2024-03-15"
}

Step 4 - Click on Send.

Step 5 - The Access Token (AToken) will be generated and displayed at the output tab at the bottom of the application. Copy this token key as you will be using it for the next requests.

1.6.2 Get Site Details

Optional Step - You may open a new tab to create a new request. If not, you may reuse your current tab but you will be replacing fields in your request.

Step 1 - Set Request Method to GET.

Step 2 - Insert "https://data.footfallcam.com/api/Sites" to the URL field.

Step 3 - Move to the Headers tab.

Step 4 - There will be a table under the tab. Put in 'AToken' under the 'Key' column, and paste in the copied token key that was generated previously into the 'Value' column.

Step 5 - Click on Send.

Step 6 - The list of Sites and their details will be displayed in the output tab. For each Site there will be a "BranchId", "BranchName" and "BranchCode". Find the branch that matches your company's Branch Name or Branch Code. Once located, copy the respective "branchId".

1.6.3 Export Data via API

Step 1 - Select Request Method to POST.

Step 2 - Insert "https://cube.footfallcam.com/API/v1/load" into the URL field.

Step 3 - Move to the Headers Tab. Put in 'AToken' under the 'Key' column and paste in the copied atoken key that was generated previously into the 'Value' column.

Step 4 - Move to the Body tab. Select "raw" and select "JSON".

Step 5 - Copy and paste the following content as the Body. Please refer to here to get the example of the body. 

Step 6 - Within the Body, look for the "filters" section. Inside the section contains "member", "operator", and "values", this section aims to filter the result based on the site Id. Replace the value with the site ID that you have copied in the previous query (Section 1.6.2).

Step 7 - Click on Send. The output of the query will be long. Look for the "data" section within the output. Details regarding the company name and ID, site name and ID, along with the associated metrics will be shown. Above is a sample output.

Step 8 - There are 2 ways to save the output:

1. On the right side of the output panel, click on "Save Response" to save the result. This allows you to save the output of the query into a JSON file for future usage.
2. Alternatively, you may click on the Copy icon right below the "Save Response" text to copy the output into the clipboard.

For the list of Cube available, kindly refer to Appendix: List of Cube.

For a list of Metrics that are available in Cube, kindly refer to Appendix: Metric Documentation V2.

1.7 SQL

This section requires a database administration tool such as DBeaver. You may get DBeaver here. The queries that are described in this section will be done via DBeaver, but you may utilize other tools to execute the queries as well.

The following guide will show how to set up the cube in DBeaver to allow the user to proceed with query data.

For a list of Cube available, kindly refer to Appendix: List of Cube.https://www.footfallcam.com/people-counting/knowledge-base/v9-server-api/

For a list of Metrics that are available in Cube, kindly refer to Appendix: Metric Documentation V2.

Sample 1 - How to get Area Footfall Count IN and OUT daily data by Site
Description	To retrieve Area Footfall Count IN and OUT daily data by Site.
Function Name	area_1d_summary
Sample SQL	SELECT Time, A01, A02, AreaName FROM area_1d_summary WHERE BranchId = 'xxx' and Time BETWEEN '2023-09-21' and '2023-09-26' ORDER BY Time
Sample Result

​

Sample 2 - How to get Site Footfall Count IN and OUT hourly data by Site Group
Description	To retrieve Site Footfall Count IN and OUT hourly data by Site Group.
Function Name	site_1h_summary
Sample SQL	SELECT Time, A01, A02, , BranchName as SiteName FROM site_1h_summary where SiteGroupID = 'xxx' and Time BETWEEN '2023-09-21 10:00:00' and '2023-09-26 16:00:00' ORDER BY Time
Sample Result

Sample 3 - How to get Area Footfall Count IN and OUT minute data by selected Area
Description	To retrieve Area Footfall Count IN and OUT minute data by selected Area.
Function Name	area_1m_summary
Sample SQL	SELECT Time, A01, A02, AreaName FROM area_1m_summary where AreaId = 'xxx' and Time BETWEEN '2023-09-21 13:00:00' and '2023-09-21 14:00:00' ORDER BY Time
Sample Result

​

Sample 4 - How to get Live Area Footfall Count IN and OUT data by Site Group
Description	To retrieve Live Area Footfall Count IN and OUT data by Site Group.
Function Name	site_live_summary
Sample SQL	SELECT A01, A02, AreaName FROM site_live_summary where SiteGroupId = 'xxx'
Sample Result

The post Chapter 1: Export Data from Server appeared first on FootfallCam.

2.1 MQTT

Step 1 - Once logged in to the device, on the home page click on settings to head to the settings page.

Step 2 - On Settings page. Open up the Advanced IT Settings dropdown.

Step 3 - Head Towards the MQTT Module and click on Enable MQTT.

Step 4 - Fill in the necessary field and click 'Save' on Save Changes below.

Example Configuration 

2.2 REST API

Step 1 - Generate URL: http://[insert Internal IP]/cgi-bin/access_token.cgi?username=[insert Username] &password=[insert Password]

Video link on how to generate access tokens:

Step 2 - Run the URL and the access token received will be shown below.

URL	Output
http://192.168.2.123/cgi-bin/access_token.cgi?username=admin&password=[password]

Step 3 - Retrieve data using access token received. Generate URL with the selected parameter listed as below: http://[insert Internal IP]/cgi-bin/apiCount_cgi?data_type=[insert Data Type]&data_format=[insert Data Format]&resolution_min=[insert Resolution Minutes]&date_start=[insert Date Start]&date_end=[insert Date End]&time_start=[insert Time Start]&time_end= [insert Time End]&access_token=[insert Token]

Sample 1 - Counting Data in Second
http://192.168.2.123/cgi-bin/apiCount.cgi?data_type=json&data_format=second&resolution_sec=30&date_start=20181231&date_end=20190131&time_start=083000&time_end=183000&access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IkFkbWluIiwic2VyaWFsIjoiTnpVd01EQXdNREl3WkRnM05qUmpadz09IiwicGFzc3dvcmQiOiIxMjM0NTYifQ.0fhypDovKDrEG3WIRNnXqlT9CArFPSsuZbi0R1RRvGw

Sample 2 - Counting Data in Minute
http://192.168.2.123/cgi-bin/apiCount.cgi?data_type=json&data_format=minute&resolution_min=1&date_start=20181231&date_end=20190131&time_start=083000&time_end=183000&access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IkFkbWluIiwic2VyaWFsIjoiTnpVd01EQXdNREl3WkRnM05qUmpadz09IiwicGFzc3dvcmQiOiIxMjM0NTYifQ.0fhypDovKDrEG3WIRNnXqlT9CArFPSsuZbi0R1RRvGw

Sample 3 - Counting Data in Hour
http://192.168.2.123/cgi-bin/apiCount.cgi?data_type=json&data_format=hour&date_start=20181231&date_end=20190131&time_start=083000&time_end=183000&access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IkFkbWluIiwic2VyaWFsIjoiTnpVd01EQXdNREl3WkRnM05qUmpadz09IiwicGFzc3dvcmQiOiIxMjM0NTYifQ.0fhypDovKDrEG3WIRNnXqlT9CArFPSsuZbi0R1RRvGw

• The Websocket Server should receive a JSON test data with the topic 'generic-test-topic'.

2.3 Web Socket

Step 1 - In your Counter's Control Panel, navigate to the Settings tab and scroll down to find 'Websocket Module'

Step 2 - Once "Enable Websocket" is enabled, you can fill in your Websocket Address in the field provided. If Basic Authentication is enabled in your Server, you may toggle the option and fill in the details. Otherwise, this option is optional.

Step 3 - Every time the setting is changed, Check Connection must be clicked before saving it to allow the Counter to test the connection.

• The Websocket Server should receive a JSON test data with the topic 'generic-test-topic'.
• The Websocket Server must return "OK".

Websocket Module: Data Explanation

2.4 BACNET

Step 1 - Connect FFC device to Bacnet Router.

Step 2 - Connect Computer to same network as FFC device.

Step 3 - Configure FFC device's ip address through counter setup wizard.

Step 4 - Connect computer/master device to Bacnet network with BAC0 protocol and Port 47808.

Example Setting to connect using YABE software

Step 5 - Get data from device's properties with device's name FFC and device's ID with last six digits of company serial.

Example display of connected device using Bacnet

Step 6 - After the device connected to Bacnet network, the counting data were inside properties. And there are two type of data which is In-C-X and Out-C-X. In-C-X and Out-C-X which represented In count and Out count, and X represented current hour - X hours. There are total 96 data which represent last 48 hours in and out count for the devices.

The post Chapter 2: Export Data from Device appeared first on FootfallCam.

Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

3.1 Sales Data

3.1.1 One-off Sales Data Import

3.1.1.1 Sales Data Import via Portal

Step 1 - Please refer here to create an import job. After select the JobType of "1089 - Data Import", click on the Create button and it will be navigated to the page below.

Noted: An error message will pop out if there are errors in the Excel file, read the error message and make changes to the uploaded file to resolve the problem.

Step 2 - Click on the Next button and go to the next page.

Step 3 - Please select One-off as the Mode and click on the Create Job button.

Step 4 - A 'Job Created' message box will pop out once the job has been created.

Step 5 - The data from the Excel file will be updated and the created import job details will be shown on the Import and Export page.

3.1.1.2 Sales Data Import via API Endpoint

Step 1 - Please refer here to import sales data via API endpoint.

3.1.2 Automate Sales Data Import

Step 1 - Please refer here to create an import job. After select the JobType of "1089 - Data Import", click on the Create button and it will be navigated to the page below. 

Note: The image above shows FTP, when SFTP is selected it will add two additional columns of fields, SSH Key File and Key File Password.

Step 2 -  Click on the Next button at the bottom, it will test the connection before go to the next page.

Step 3 - Now, please set up the frequency for the job to run. Select Recurring, Frequency, and Next Running Date. After that, click 'Create Job' and the job will be created successfully and import the sales data automatically based on the frequency and interval selected.

3.1.2.1 Parser Type: Default (Site Sales Data) - Automate the import of site sales data

Step 1 - To import Site Sales Data, select 'Default (Site Sales Data)' for the parser type.

Below is the sample file template for Site Sales Data. Ensure the imported file matches the provided Site Sales Data template format exactly.

3.1.2.2 Parser Type: Area Sales Data - Automate the import of area sales data

Step 1 - To import Area Sales Data, select 'Area Sales Data' for the parser type.

Below is the sample file template for Area Sales Data. Ensure the imported file matches the provided Area Sales Data template format exactly.

3.1.2.3 Parser Type: V8 Sales Data - Automate the import of V8 Site sales data

Step 1 - To import V8 Site Sales Data, select 'V8 Sales Data' for the parser type.

Below is the sample file template for V8 Site Sales Data. Ensure the imported file matches the provided V8 Site Sales Data template format exactly.

3.2 Third-Party Device Historical Data

3.2.1 Registering the Third-Party Device as a Virtual Device

Before a third-party device can be accessed in FootfallCam V9™, it must be registered as a Virtual Device.

Step 1 - Go to Settings > Device > click "+ New Device".

Step 2 - Select the site to which the virtual device is allocated.

Step 3 - Select the type of virtual device. The third-party devices supported as of 2025 are Brickstream, V-Count, Xovis and Vivotech. 

Step 4 - Key in the serial and the name of the virtual device.

Step 5 - Click "Submit" and return to the Device List.

Step 6 - Search for the virtual device in the Device List to confirm its existence.

3.2.1.1 Preparing a Brickstream Device

After registering a Brickstream Device as a Virtual Device, it must be configured to upload its counting data to the FootfallCam V9™ server.

Step 1 - Enter the "Configuration Page" of a Brickstream Device.

Step 2 - Navigate to the "FTP Settings" page.

Step 3 - Update the settings as such:

3.2.2 One-off Counting Data Import

All steps remain consistent with those outlined in section 3.2.2, 'Automate the Import of Counting Data,' with the exception of the final step, Step 12, which differs. Initially, the user must select the one-off option and then specify the desired date range before proceeding with the remaining steps.

3.2.3 Automate Counting Data Import

Step 1 - Please refer the step1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - After click on the Create button, it will bring you to the Settings Page. Please fill in the necessary details required for the export, and do not leave blank for the mandatory field. 

For the Data Extraction Section, both FTP and SFTP are the same:

FTP

SFTP

Data Load (One-Off or Recurring)

3.3 Marketing Data

Stay tuned! The new feature will be ready soon.

3.4 Site Settings Data

3.4.1 New Sites Creation

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - To import New Site Creation Data, select 'New Site Creation' for Data. Then, select 'Microsoft Excel' for the data source and 'Site' for the parser type.

Below are the fields found in the page:

Step 3 - A sample template for New Site Creation data can be downloaded via the hyperlink. After downloading the template, edit the data in the Excel file based on the provided format.

Below shows the available columns found in the template:

Step 4 - Upload the New Site Creation Excel file by clicking on 'Browse' and selecting your Excel file. If the file upload is successful, there will be an indicator stating that the file is uploaded.

Step 5 - Click on 'Next', set up the data load to One-off. Then click on 'Create Job' to begin the import process.

Step 6 - A popup message would appear indicating that the job has been successfully created.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.4.2 Standard Operating Hours Update

There are two steps to bulk update the site operating hours: first, export the current operating hours to an Excel file and make the necessary changes; then, import the updated file back into the portal to apply the new operating hours across the selected sites.

3.4.2.1 Standard Operating Hours Export

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1136 - Data Export as the Job Type.

Step 2 - To retrieve current Standard Operating Hours, select 'Operating Hours' for Data and select 'site/area' for entity level depends on your requirement. Then, select the site you want to export the current Operating Hours for the Entity. Select 'Link ' for Export Mode and select 'Excel' for File Format. Next, click on the "Create Job" to create the export job.

Step 3 - Go back to the job you created and wait for a few minutes for the job to run. 

Step 4 - Refresh the page, and when the Status shows "Successful", click 'View Details'.

Step 5 - After open the page and click the download link to download the Excel file.

Step 6 - Open the excel file that you have downloaded and edit your operating hours.

Step 7 - For the column that is marked 1 in the screenshot below, change to either Open or Closed to indicate if the day is operating or not operating. For the columns that are marked as 2 is the starting and ending of the operating hours.

Step 8 - Proceed to 3.4.2.2 to import your updated operating hours.

3.4.2.2 Standard Operating Hours Import

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and now please select 1089 - Data Import as the Job Type.

Step 2 - To upload Standard Operating Hours, select 'Standard Operating Hours' for Data and select 'Microsoft Excel' for the Data Source. For Parser Type, you can select either 'Site Operating Hour' or 'Area Operating Hour'. 

Below are the fields found in the page:

Below are the available options for Entity Level:

Step 3 - Both Entity Levels have their own sample Excel template that can be downloaded via their hyperlinks. Edit the data in the Excel file based on the provided format.

Below shows the available columns found in the template:

Step 4 - Once ready for upload, click on 'Browse' and select the Excel file to upload. If file upload is successful, there will be an indicator stating that the file is uploaded.

Step 5 - Click on 'Next', set up the data load to One-off, and Click on 'Create Job' to begin the import process.

Step 6 - A popup message would appear indicating that the job has been successfully created.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.4.3 Custom Operating Hours Update

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and now please select 1089 - Data Import as the Job Type.

Step 2 - To import Custom Operating Hours Data, select 'Custom Operating Hours' for Data and select 'Microsoft Excel' for Data Source. Then, select 'Site Custom Operating Hour' for Parser Type.

Below are the fields found in the page:

Step 3 - A sample template for Custom Operating Hours data can be downloaded via the hyperlink. After downloading the template, edit the data in the Excel file based on the provided format.

Below shows the available columns found in the template:

Step 4 - Once ready for upload, click on 'Browse' and select the Excel file to upload. If file upload is successful, there will be an indicator stating that the file is uploaded.

Step 5 - Click on 'Next', set up the data load to One-off, and Click on 'Create Job' to begin the import process.

Step 7 - A popup message would appear indicating that the job has been successfully created.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.5 Area Settings Data

3.5.1 Bulk Area Creation

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - To import New Area Data, select 'Area Data' for Data. Then, select 'Microsoft Excel' for Data Source and select 'Area Data' for Parser Type.

Below are the fields found in the page:

Step 3 - A sample template for Area Data can be downloaded via the hyperlink. After downloading the template, edit the data in the Excel file based on the provided format.

Below shows the available columns found in the template:

Step 4 - Upload the Area Data Excel file by clicking on 'Browse' and selecting your Excel file. If file upload is successful, there will be an indicator stating that the file is uploaded.

Step 5 - Click on 'Next', set up the data load to One-off, and Click on 'Create Job' to begin the import process.

Step 6 - A popup message will shown if the job is created successfully. Otherwise, an error message will be shown.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.6 User Settings Data

Stay tuned! The new feature will be ready soon.

3.7 Time Table Import (Movie, Class, Church)

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - To import Timetable Data, select 'Session Data' for Data and select 'Microsoft Excel' for Data Source. Then, select 'Session Data' for Parser Type.

Below are the fields found in the page:

Step 3 - A sample template for Session Data can be downloaded via the hyperlink. After downloading the template, edit the data in the Excel file based on the provided format.

Below shows the available columns found in the template:

Step 4 - Once ready for upload, click on 'Browse' and select the Excel file to upload. If file upload is successful, there will be an indicator stating that the file is uploaded.

Step 5 - Click on 'Next', set up the data load to One-off, and click on 'Create Job' to begin the import process.

Step 7 - A popup message would appear indicating that the job has been successfully created.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.8 Staff Data

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - To import Staff Data, select 'Staff Data' for Data and select 'Microsoft Excel' for Data Source. Then, select 'Staff Data' for Parser Type.

Below are the fields found in the page:

Step 3 - A sample template for Staff data can be downloaded via the hyperlink. After downloading the template, edit the data in the Excel file based on the provided format. Do note that there are 3 sheets within the template.

Below shows the available columns found in the template:

Step 4 - Once ready for upload, click on 'Browse' and select the Excel file to upload. If file upload is successful, there will be an indicator stating that the file is uploaded.

Step 5 - Click on 'Next', and set up the data load to One-off, and click on 'Create Job' to begin the import process.

Step 6 - A popup message would appear indicating that the job has been successfully created.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.9 Bus Route

Stay tuned! The new feature will be ready soon.

3.10 ESL Product

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - To create a new import job for ESL Product, select 'ESL Product' as the Data and select 'Microsoft Excel' as the Data Source. Then, select 'ESL Product' for Parser Type.

Step 3 - A sample template for the ESL data can be downloaded via the hyperlink. After downloading the template, edit the data in the Excel file based on the provided format. Do note that there are 2 sheets within the template.

Below are the available columns found in the template:

Step 4 - Once the file is ready for upload, click on 'Browse' and select the Excel file to upload.

Step 5 - Once the file is uploaded successfully, click on 'Next' button and select 'Default Transformation'. The mode of Data will be on 'One-off' as default, click on 'Create Job' to begin the import process.

Step 6 - A popup message would appear indicating that the job has been successfully created.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.11 Area Session Data

3.11.1 Bulk Area Session Creation

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - To import New Area Session Data, select 'Area Session Data' for Data. Then, select 'Microsoft Excel' for Data Source and select 'Area Session Data' for Parser Type.

Below are the fields found in the page:

Step 3 - A sample template for Area Session Data can be downloaded via the hyperlink. After downloading the template, edit the data in the Excel file based on the provided format.

Below shows the available columns found in the template:

Step 4 - Upload the Area Session Data Excel file by clicking on 'Browse' and selecting your Excel file. If file upload is successful, there will be an indicator stating that the file is uploaded.

Step 5 - Click on 'Next', set up the data load to One-off, and Click on 'Create Job' to begin the import process.

Step 6 - A popup message will shown if the job is created successfully. Otherwise, an error message will be shown.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.12 Session Data

3.12.1 Bulk Session Creation

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - To import New Area Session Data, select 'Session Data' for Data. Then, select 'Microsoft Excel' for Data Source and select 'Session Data' for Parser Type.

Below are the fields found in the page:

Step 3 - A sample template for Session Data can be downloaded via the hyperlink. After downloading the template, edit the data in the Excel file based on the provided format.

Below shows the available columns found in the template:

Step 4 - Upload the Session Data Excel file by clicking on 'Browse' and selecting your Excel file. If file upload is successful, there will be an indicator stating that the file is uploaded.

Step 5 - Click on 'Next', set up the data load to One-off, and Click on 'Create Job' to begin the import process.

Step 6 - A popup message will shown if the job is created successfully. Otherwise, an error message will be shown.

Noted: If there are issues in the import process, a popup will appear with the error message. Read the error message and rectify the errors if needed. Below is an example of an error message.

3.13 Floorplan Data

Floorplan Data Export and Import feature enable users to export a desired floorplan from one site and import it into another environment (such as a different company, server, or site) without manually redrawing or recreating the floorplan.

The import process involves three main steps:

1. Export: Export the selected site's floorplan(s) to a downloadable JSON file.
2. Import: Upload the exported JSON file back into the portal to apply the same floorplan across the selected site.
3. Link Areas and Devices: After importing, navigate to the Floorplan page to link the corresponding areas and devices to ensure proper mapping and functionality.

This process streamlines floorplan replication across environments, saves time, and ensures consistency while allowing for easy reconfiguration of area and device associations.

3.13.1 Floorplan Data Export

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1136 - Data Export as the Job Type.

Step 2 - To retrieve site floorplan data, select 'Floorplan Data' for Data. Then, select the site for Entity and floorplan(s) for the Floorplans. Select 'Link' for Export Mode and select 'Json' for File Format. Next, click on the "Create Job" to create the export job.

Step 3 - Go back to the job you created and wait for a few minutes for the job to run. Refresh the page, and when the Status shows "Successful", click 'View'.

Step 4 - After opening the page, click the download link to download the JSON file.

The downloaded file is in JSON format and contains all the data required to recreate the floorplan during import. Each { ... } block in the file represents one floorplan record and includes details such as:

• Floorplan name and image
• Scale and actual distance
• Layout and plotted data
• Site and company information
• Plotted devices and areas (if available)

Example of exported JSON structure:

Step 5 - Proceed to 3.13.2 to import the floorplan data.

3.13.2 Floorplan Data Import

Step 1 - Please refer to step 1 to step 3 of Chapter 3.3 Data Import and Export to create a job and select 1089 - Data Import as the Job Type.

Step 2 - To upload floorplan data, select 'Floorplan Data' for Data and select 'Json' for the Data Source. Then, select one site that you want to import floorplan data to and select 'Floorplan Data' for Parser Type. Click on 'Browse' and select the exported JSON file to upload. If file upload is successful, there will be an indicator stating that the file is uploaded.

Step 3 - Click on 'Next', set up the data load to One-off, and click on 'Create Job' to begin the import process.

Step 4 - A popup message will shown if the job is created successfully. Otherwise, an error message will be shown.

3.13.3 Link Areas and Devices

Once the floorplan data import job has run successfully, follow these steps to link the corresponding areas and devices:

Step 1 - Go to Settings > Floorplan to access the list of available floorplans.

Step 2 - The imported floorplan will appear in the list.

• The Floor Plan Name will match the one selected during the data export.
• The Site will correspond to the site selected during the data import.

Step 3 - Locate the imported floorplan you want to update. Scroll to the right and click 'Edit'. You will be redirected to the Floor Plan Design Tool page.

Step 4 - In the Floorplan Design Tool, link the plotted devices and areas as needed.

The post Chapter 3: Data Import appeared first on FootfallCam.

Module - Footfall Counting and WiFi Analytics

A01 - Footfall Count IN

A02 - Footfall Count OUT

A03 - Occupancy

CA03 - Average Occupancy with Configuration

Latest_A03 - Latest Occupancy

Understaff_A03 - Understaffed

Overstaff_A03 - Overstaffed

Optimalstaff_A03 - Optimal Staffing

A04 - Average Dwell Time / Visit Duration

A05 - Outside Traffic

A12 - Returning Customer (1)

A13 - Returning Customer (2)

A14 - Unique Visitor

A17 - Space In Used Duration

B23 - Space In Used Rate

A18 - Children Footfall IN

A30 - Group Size Distribution 1

A31 - Group Size Distribution 2

A32 - Group Size Distribution 3

A61 - All Day Outside Traffic

A71 - Unique Visitor Count

B01 - Turn In Rate

Module - Sales Conversions

A15 - Total Transaction Count

A16 - Total Sales Revenue

Module - Visitors Engagement

A20 - Total Number of Engaged Customers

A21 - Total Number of Passerby

A22 - Average Engaged Duration

B07 - Engagement Rate

A54 - Average Serving Time

A55 -Average Queue Wait Time

A56, A57, A58, A59, A60 - Queue Wait Time Distribution

A76 - No. of Active Areas (Throughput)

A77 - Active Duration (Throughput)

A78 - Occupied Duration

A82 - Queue Outflow / Throughput

A84 - Queue Serve Time Using In Out Count

A85 - Active and Occupied Duration

B27 - Queue Serve Rate

B67 - Utilisation Rate (During Active Duration)

Module - Demographics

B13 - Children Percentage

B14 - Teenagers Percentage

B15 - Young Adults Percentage

B16 - Middle-Aged Adults Percentage

B17 - Elderly Percentage

B18 - Percentage of People with Neutral Emotion

B19 - Percentage of People with Positive Emotion

B20 - Percentage of People with Negative Emotion

B21 - Percentage of Male

B22 - Percentage of Female

Module - Device Health Check

H10 - Total Memory Usage

H11 - Average Memory Usage

H12 - Total Main Storage Usage

H13 - Average Main Storage Usage

H14 - Total D Storage Usage

H15 - Average D Drive Storage Usage

H16 - Maximum Device Temperature

H17 - Total Raspicam Run Count

H18 - Total Raspicam No Run Count

Module - AI Prediction

P01 - Predicted Visitors In

P22 - Predicted Waiting Time

P23 - Predicted Uplift of Visitors In Due To Event

P25 - Predicted Uplift of Visitors In Due To Weather

Module - Others

J01 - Completed Patrols

J02 - Missed Patrols

B34 - Patrol Compliance Rate

The post Appendix C – Metrics Definition V2 appeared first on FootfallCam.

Please refer to REST API and SQL API Example below for an example on how to send an API

REST API Example

SQL API Example

This section describes how to obtain data from V9 server using SQL API. Popular applications such as PowerBI and Dbeaver use this method. The example below shows how to obtain total daily visitors in count from site_summary cube with branch name dimension from 1 October 2024 to 25 October 2024. It also limits the number of returned rows to 10000.

The post V9 Server API appeared first on FootfallCam.

Setting Up Data Push via Websocket Connection

1. On device control panel, go to "Config" tab, under "Data Push", click on "New Data Push" button. See Figure 1.1

Figure 1.1: Add New Data Push

2. Configure the data push settings, choose "WebSocket" as the export mode, and select the time granularity for the level of data aggregation (i.e. every minute, every 15min, hourly, per event) and frequency for the data sending interval (i.e. every 15min, hourly, daily). Make sure the Active field is checked, so that the data pushing can take effect upon completing the configuration. See Figure 2.1 (Note: for "per event" time granularity, data will be pushed whenever there is In/Out count registered)

Figure 2.1: Configure WebSocket Data Push

3. Fill in the connection settings, namely the WebSocket server URL and the Auth token. Use the "Test Connection" button to verify whether the WebSocket server is reachable. The device will ping the WebSocket server and determine the connection status based on the reply from server side. (Note: we assume the WebSocket server is RFC-compliant, i.e. it will reply to a ping with a pong). Save the settings if the connection is working fine.

Footfall Data Payload Format

Time Granularity: Per Event

 {
  "UUID": "658a2443-72ba-422c-85dc-e4e10baa1288", #Unique for each message
  "DeviceSerial": "ecd5cc57d23c5c9f",
  "RoiId": 1, #Useful when there are multiple counting lines defined
  "MetricId": 1, #1 for IN, 2 for OUT
  "PeopleTypeId": 1,
  "CombineObjectTypeId": 11, #11 for visitor, 21 for staff
  "PeopleId": 1,
  "EventEndLocalTime": "2025-07-23 18:36:31",
  "EventEndTime": 1753266991,
  "EventEndUTCTime": "2025-07-23 10:36:31",
  "EventStartLocalTime": "2025-07-23 18:36:21",
  "EventStartTime": 1753266981,
  "EventStartUTCTime": "2025-07-23 10:36:21"
 }

Time Granularity: Every Minute, Frequency: every 15min

{
  "uuid": "658a2443-72ba-422c-85dc-e4e10baa1288", #Unique for each message
  "device_serial": "ecd5cc57d23c5c9f",
  "date_requested": "2025-07-23 10:15:00", #Local datetime
  "offset": "GMT +1",
  "output": [{
		"datetime": "2025-07-23 10:00:00", #Local datetime, forward-looking 
		"invalue": "4", #Aggregated IN count
		"outvalue": "5", #Aggregated OUT count
		"timestamp": 1753236000
	    },	
	    {	
		  ...
	    },
	    {
	      "datetime": "2025-07-23 10:14:00",
	      "invalue": "6",	
	      "outvalue": "3",
	      "timestamp": 1753236840
	    }]
} 

Time Granularity: Every 15 Minutes, Frequency: Hourly

{
  "uuid": "658a2443-72ba-422c-85dc-e4e10baa1288", #Unique for each message
  "device_serial": "ecd5cc57d23c5c9f",
  "date_requested": "2025-07-23 11:00:00", #Local datetime
  "offset": "GMT +1",
  "output": [{
 	"datetime": "2025-07-23 10:00:00", #Local datetime, forward-looking
 	"invalue": "23", #Aggregated IN count
 	"outvalue": "15", #Aggregated OUT count
 	"timestamp": 1753236000
 	},
 	{
 	...
 	},
 	{
 	"datetime": "2025-07-23 10:45:00",
 	"invalue": "16",
 	"outvalue": "31",
 	"timestamp": 1753238700
 	}]
 }

Time Granularity: Hourly, Frequency: Daily

{
  "uuid": "658a2443-72ba-422c-85dc-e4e10baa1288", #Unique for each message
  "device_serial": "ecd5cc57d23c5c9f",
  "date_requested": "2025-07-23 19:00:00", #Local datetime
  "offset": "GMT +1",
  "output": [{
 	"datetime": "2025-07-23 10:00:00", #Local datetime, forward-looking
 	"invalue": "203", #Aggregated IN count
 	"outvalue": "112", #Aggregated OUT count
 	"timestamp": 1753236000
 	},
 	{
 	...
 	},
 	{
 	"datetime": "2025-07-23 18:00:00",
 	"invalue": "45",
 	"outvalue": "345",
 	"timestamp": 1753238700
 	}]
 }

WebSocket Client Behaviours

1. Expected standard port 443 for WSS, and port 80 for WS
2. Detect and handle stale connection, support auto-reconnect with backoff.
3. Include keepalive messages every 30s
4. Expect ACK message for retry mechanism to work.
5. JSON format for push messages

WebSocket Server Requirement

1. Support Authorization: Bearer <token> header

2. RFC-compliant, i.e. reply to Ping frames (RFC 6455)

3. Send ACK message on data receival, like:
   { "status": "ack", "uuid": "74fd6a2e-..." }

The post [3D Pro2 2025] FootfallCam People Counter Websocket Integration Guide appeared first on FootfallCam.

Available Integration with FootfallCam

How to create App (Bot) for Integration with FootfallCam for Sending Message

Lark Guide:

1. Sending Message
   https://open.larksuite.com/document/server-docs/im-v1/message/create
2. Get App and Tenant Access Token
   https://open.larksuite.com/document/server-docs/getting-started/api-access-token/g
3. Pass the Client ID and Client Secret to FootfallCam, we will add it into our integration
4. In order for the bot to be able to interact in Group, the bot is required to be added into the respective Group.Integration Workflow

Integration Workflow

Typical process flow

1. A rule has to be enabled on FootfallCam V9 in order for event that fulfill the criteria to be triggered for an action.
2. From FootfallCam Device, it will send event data to processing pipeline and get into the rule engine for evaluation.
3. If the event fulfilled the requirement, it will then triggered the defined action and also the notification endpoint.

Configuration

1. To use Lark, configuration must first be completed. Starting from the V9 portal release on 2025-08-11, you can configure Lark by navigating to Settings > Company > Integration Connector.
2. To create a new connector, click +Add Connector. A pop-up will appear--fill in all the required details.
3. To remove an existing connector, click Remove.
4. After making changes, click Save to apply them.
5. Currently, only Live Queue Monitoring is supported for Lark alerts. Configuration can be done via Settings > Rule Settings > Live Queue Monitoring Rule (1207).
   Under Alert > Output Channel, select Lark to choose the Lark configuration set in the Company page.

The post Lark Integration appeared first on FootfallCam.