This article describes how to use the analytics API
We provide an API which can be called to retrieve data from our analytics apps. Below are details on the calls which are available. To access the API, add port 2500 to the URL (or IP address) and replace the remaining page section of the URL (ending HTML) with the API links below.
Smart Count
/getSmartCount?date=DD-MM-YYYY
- Returns Smart Count data for the date provided
/getTrolley?date=DD-MM-YYYY
- Returns Trolley data for the date provided (where Trolley option has been purchased)
/getGender?date=DD-MM-YYYY
- Returns Gender data for the date provided (where Gender option has been purchased)
Smart Zone
/getSmartZone?date=DD-MM-YYYY
- Returns Smart Zone data for the date provided
/getZoneDwellTime?date=DD-MM-YYYY&passedVal=VAL&secondVal=VAL&thirdVal=VAL&dwellType=TYPE
- Returns Dwell Time data for the date provided. Note that you also need to provide the passing, second and third times in minutes (marked as VAL) and the data type (marked as TYPE - this will be either 'percentage' or 'value')
/getZoneAlerts?date=DD-MM-YYYY
- Returns Smart Zone alert data for the date provided
/getFallAlerts?date=DD-MM-YYYY
- Returns Slip & Fall alert data for the date provided (where Slip & Fall option has been purchased)
Smart Queue
/getQueueWaitTime?date=DD-MM-YYYY
- Returns Smart Queue waiting time data for the date provided
/getQueueOccupancy?date=DD-MM-YYYY
- Returns Smart Queue occupancy data for the date provided
/getQueueAlerts?date=DD-MM-YYYY
- Returns Smart Queue alert data for the date provided
All Products
/getLiveCount
- Returns live dashboard data based on whichever products are configured
Data Format
All data is returned in JSON format containing the following information:
- Date
- Direction or Zone (as appropriate)
- Individual data pairs containing:
- Hour (or time period)
- Quantity
- Individual data pairs containing:
- Direction or Zone (as appropriate)