Command | Description | Parameters |
---|---|---|
GET /api/ping |
Returns "pong", indicating that the server is running. | None |
GET /api/totalcount |
Returns the total count of people ever detected by CrowdCount. | None |
GET /api/check_user |
Checks if a user exists and returns their online status. |
|
GET /api/connection_status |
Returns the connection status of a specified user. |
|
GET /api/check_password |
Checks if the provided password for a specified user is correct. |
|
GET /api/currentcount |
Returns the current count for a specified user. |
|
POST /api/currentcount |
Updates the current count for a specified user. |
|
GET /api/get_user_days |
Returns a list of days for which the user has count data. |
|
GET /api/check_if_user_has_day |
Checks if the user has data for a specific day. |
|
GET /api/get_day_data |
Returns data for a specific day for the user. An example of this api call is provided below. |
|
GET /api/get_average_day_data |
Returns the average data for a specific day for the user. The average is calculated based on data from the same weekday over the previous 8 weeks, provided there is enough data. A minimum of 2 weeks of data is required. |
|
GET /api/get_week_data |
Returns data for a specific week for the user. To select a week, input any day of that week and it will provide the data from the previous Monday to the next Sunday |
|
GET /api/get_average_week_data |
Returns the average data for a specific week for the user. The average is calculated based on weekly weekday data over the previous 4 weeks, provided there is enough data. |
|
GET /api/export_csv |
Exports CSV data for a specified user and date. If no date is provided, all data is exported in a zip file. |
|