| Command | Description | Parameters |
|---|---|---|
GET /ping | Returns "pong", indicating that the server is running. |
|
GET /totalcount | Returns the total count of people ever detected across all devices. |
|
GET /total_entries | Returns the total entries ever recorded across all devices. |
|
GET /check_user | Checks if a device exists and returns its online/offline status. |
|
GET /connection_status | Returns the connection status of a device. |
|
GET /get_all_map_locations | Returns all public map locations with current counts, overcrowding limits, devices, and comparison data. No authentication required. |
|
GET /get_all_location_names | Returns a list of names of all public map locations. |
|
Find the location ID for a device. Use this to get the location_id needed for all history endpoints.
| Command | Description | Parameters |
|---|---|---|
POST /get_locations_for_device | Returns all locations that a device belongs to, including each location's location_id, name, current count, overcrowding limit, and member devices. |
|
POST /get_location | Returns details for a single location by ID. |
|
Retrieve historical population and entry data for a location. All endpoints require location_id plus credentials for all member devices.
Each endpoint also has an average variant that returns the historical average for the same period.
| Command | Description | Parameters |
|---|---|---|
POST /get_location_day_data | Hourly population data for a specific day. |
|
POST /get_location_average_day_data | Average hourly population for the same weekday. Calculated from historical data on matching weekdays. |
|
POST /get_location_week_data | Daily population data for a specific week. Input any day of the week to get Monday through Sunday. Supports timezone correction via tz_offset_minutes. |
|
POST /get_location_average_week_data | Average daily population for a week. Supports timezone correction via tz_offset_minutes. |
|
POST /get_location_month_data | Daily population data for a specific month. |
|
POST /get_location_average_month_data | Average daily population for a month. |
|
POST /get_location_year_data | Monthly population data for a specific year. |
|
POST /get_location_average_year_data | Average monthly population for a year. |
|
POST /get_location_entry_day_data | Hourly entry data for a specific day. |
|
POST /get_location_average_entry_day_data | Average hourly entry data for the same weekday. |
|
POST /get_location_entry_week_data | Daily entry data for a specific week. Supports timezone correction via tz_offset_minutes. |
|
POST /get_location_average_entry_week_data | Average daily entry data for a week. Supports timezone correction via tz_offset_minutes. |
|
POST /get_location_entry_month_data | Daily entry data for a specific month. |
|
POST /get_location_average_entry_month_data | Average daily entry data for a month. |
|
POST /get_location_entry_year_data | Monthly entry data for a specific year. |
|
POST /get_location_average_entry_year_data | Average monthly entry data for a year. |
|
POST /get_location_day_data_detailed | 15-minute interval data for a specific day, with averages. Returns data in local time using tz_offset_minutes. Useful for detailed CSV exports. Keys are time labels like "0:00", "0:15", ..., "23:45" (96 intervals). Response includes both data and average dicts. |
|
POST /get_location_insights_bundle | Returns all chart data (day, week, year) for both population and entries in a single response. Replaces up to 16 individual API calls. Includes averages, entry data, and optional second-day data for timezone spanning. Supports timezone-aware week data via tz_offset_minutes. |
|
POST /get_location_history_bundle | Returns chart data (day, week, year) for a single data type in one response. Replaces up to 8 individual API calls. Use data_type to choose population or entries. |
|
GET /export_csv | Exports population CSV data for a device. If no date is provided, all data is exported as a zip file. |
|
GET /export_entry_csv | Exports entry CSV data for a device. If no date is provided, all data is exported as a zip file. |
|
{"device_id", "password"} objects for all devices in the location:"credentials": [{"device_id": "T1234", "password": "password"}, {"device_id": "T5678", "password": "password"}]tz_offset_minutes to get timezone-corrected daily totals directly from the server. The value is your UTC offset in minutes, positive east — e.g. -420 for US Mountain (UTC-7), 60 for CET (UTC+1). In JavaScript: new Date().getTimezoneOffset() * -1.date2 parameter handles timezone day-boundary spanning for hourly data — pass the adjacent UTC date that overlaps your local day.tz_offset_minutes — the server handles the UTC conversion.