The BlueZoo Data Warehouse API allows application and service developers to gain access to historical data about locations managed by a given Bluefox Cluster for their accounts. Using the API, the historical information can easily be ingested and integrated into customer built applications, custom services, and data visualization products.
\nThese API endpoints allow users to retrieve the most recent occupancy (visitor) and visit data from sensor locations. All requests require authorization using the data warehouse access key in the Authorization header.
The BlueZoo Fetch API is deprecated and replaced by the Real-time API. The Fetch API service will be discontinued on December 31, 2025.
\nThe BlueZoo Fetch API allows application and service developers to gain access to real-time data, historical data and configuration information about specific locations managed by a given Bluefox Cluster. Using the API, real-time count information can easily be embedded into third-party applications and services.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"BlueZoo Data Warehouse API","slug":"bluezoo-data-warehouse-api"},{"content":"BlueZoo Real-time API","slug":"bluezoo-real-time-api"},{"content":"BlueZoo Fetch API","slug":"bluezoo-fetch-api"}],"owner":"14323059","collectionId":"0d282c33-faf6-4c0e-9d75-fad56654a51a","publishedId":"TWDfDDRS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-07-27T20:47:29.000Z"},"item":[{"name":"BlueZoo Data Warehouse API","item":[{"name":"List Tables","id":"86908bf1-058b-4d8d-a64c-5cf22de778ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"AccessKey{{key}}","description":"The User's API Key for the Account
\n","type":"text"}],"url":"{{base_url}}/list_tables","description":"This endpoint returns a list of the tables available under the account, for a user to query.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n GET\n | \n
| \n Endpoint\n | \n\n list_tables\n | \n
| \n Authorization\n | \n\n Request header used for account authentication\n | \n
Result
\n| \n Fields\n | \n\n Description\n | \n
| \n HTTP status code\n | \n\n Request status code, possible values are:\n 200\n 400\n 403\n | \n
| \n HTTP status message\n | \n\n Request status message, possible values are:\n \"BAD_TOKEN\"\n \"RESTRICTED_ACCESS\"\n | \n
| \n Body\n | \n\n Array of JSON structure holding information fields about the table names\n | \n
[\n {\n \"table_name\": \"sensor_visits\"\n },\n {\n \"table_name\": \"group_flow_duration\"\n },\n {\n \"table_name\": \"group_flow_transition\"\n },\n {\n \"table_name\": \"group_flow_segmentation\"\n },\n {\n \"table_name\": \"sensor_visitors\"\n },\n {\n \"table_name\": \"sensor_dwell\"\n },\n {\n \"table_name\": \"group_uv_daily\"\n },\n {\n \"table_name\": \"group_convert\"\n },\n {\n \"table_name\": \"group_dwell\"\n },\n {\n \"table_name\": \"group_uv_weekly\"\n },\n {\n \"table_name\": \"group_uv_monthly\"\n },\n {\n \"table_name\": \"group_uv_custom\"\n },\n {\n \"table_name\": \"group_flow_correlation\"\n },\n {\n \"table_name\": \"sensor_pulses\"\n }\n]\nThe User's API Key for the Account
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table_name\": \"sensor_visitors\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/desc_table","description":"This endpoint returns a description of the requested table (Columns and Datatypes) available under the account, for a user to query. Detailed column descriptions for each individual table is provided at the end of this documentation.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n desc_table\n | \n
| \n Authorization\n | \n\n Request header used for account authentication\n | \n
| \n Content-Type\n | \n\n application/json\n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n table_name\n | \n\n Table name\n | \n
Result
\n| \n Fields\n | \n\n Description\n | \n
| \n HTTP status code\n | \n\n Request status code, possible values are:\n 200\n 400\n 403\n | \n
| \n HTTP status message\n | \n\n Request status message, possible values are:\n “BAD_TOKEN”\n “RESTRICTED_ACCESS”\n | \n
| \n Body\n | \n\n Array of JSON structure holding information column names and datatypes in the table\n | \n
[\n {\n \"column_name\": \"sensor_id\",\n \"data_type\": \"INT64\"\n },\n {\n \"column_name\": \"sensor_name\",\n \"data_type\": \"STRING\"\n },\n {\n \"column_name\": \"sensor_mac\",\n \"data_type\": \"STRING\"\n },\n {\n \"column_name\": \"sensor_address\",\n \"data_type\": \"STRING\"\n },\n {\n \"column_name\": \"sensor_latitude\",\n \"data_type\": \"FLOAT64\"\n },\n {\n \"column_name\": \"sensor_longitude\",\n \"data_type\": \"FLOAT64\"\n },\n {\n \"column_name\": \"timestamp\",\n \"data_type\": \"TIMESTAMP\"\n },\n {\n \"column_name\": \"minimum_visitors_inner\",\n \"data_type\": \"FLOAT64\"\n },\n {\n \"column_name\": \"maximum_visitors_inner\",\n \"data_type\": \"FLOAT64\"\n },\n {\n \"column_name\": \"average_visitors_inner\",\n \"data_type\": \"FLOAT64\"\n },\n {\n \"column_name\": \"minimum_visitors_outer\",\n \"data_type\": \"FLOAT64\"\n },\n {\n \"column_name\": \"maximum_visitors_outer\",\n \"data_type\": \"FLOAT64\"\n },\n {\n \"column_name\": \"average_visitors_outer\",\n \"data_type\": \"FLOAT64\"\n }\n]\nThe User's API Key for the Account
\n","type":"text"}],"body":{"mode":"raw","raw":"select * from sensor_visitors limit 1"},"url":"{{base_url}}/run_query","description":"This endpoint returns the result of a SELECT query. A Complex JOIN-based query is also possible. No DML, DDL queries allowed.
\nRequest | Description |
HTTP Method | POST |
Endpoint | run_query |
Authorization | Request header used for account authentication |
Text Request Body | Description |
string | A SQL SELECT query string |
Result
\nFields | Description |
HTTP status code | Request status code, possible values are: 200 400 403 |
HTTP status message | Request status message, possible values are: “BAD_TOKEN” “RESTRICTED_ACCESS” |
Body | Array of JSON structure holding result of the query. |
[\n{\n\"sensor_id\":319,\n\"sensor_name\":\"2\",\n\"sensor_mac\":\"E4:95:6E:41:07:5C\",\n\"sensor_address\":\"\",\n\"sensor_latitude\":null,\n\"sensor_longitude\":null,\n\"timestamp\":\"2021-11-08T00:15:00.000+00:00\",\n\"minimum_visitors_inner\":15.857809066772461,\n\"maximum_visitors_inner\":27.8795166015625,\n\"average_visitors_inner\":21.50176040057478,\n\"minimum_visitors_outer\":15.857809066772461,\n\"maximum_visitors_outer\":27.8795166015625,\n\"average_visitors_outer\":21.50176040057478,\n\"valid\":true,\n\"time_offset\":null\n}\n]\n\nThe User's API Key for the Account
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table_name\": \"sensor_visits\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/desc_table","description":"This request returns a description of the sensor_visits table (Columns and Datatypes). Sensor Visits measure the number of devices seen within the inner detection range of a sensor, also known as impressions. This table also returns the sensor_visits for the outer detection range as specified in the column descriptions below. The maximum resolution for the historical data is 1⁄4-hour grain (15 minute slots).
\nColumn names and datatypes in the table
\n| \n Fields\n | \n\n Data Type\n | \n\n Comments\n | \n
| \n sensor_id\n | \n\n INT64\n | \n\nInteger value of a sensor location id. Change in the sensor_name wouldn’t affect the sensor_id as long as the sensor location is not deleted from the system\n | \n
| \n sensor_name\n | \n\n STRING\n | \n\nName defined by the user to identify a location.\n | \n
| \n sensor_mac\n | \n\n STRING\n | \n\nStatic sensor identifier which remains the same even when a location is deleted from the system and re-added. \n | \n
| \nsensor_address\n | \n\nSTRING\n | \n\nPhysical address of the sensor as can be added by the user in BlueZoo dashboard\n | \n
| \nsensor_latitude\n | \n\nFLOAT64\n | \n\nPhysical coordinates of a sensor location\n | \n
| \nsensor_longitude\n | \n\nFLOAT64\n | \n\nPhysical coordinates of a sensor location\n | \n
| \ntimestamp\n | \n\nTIMESTAMP\n | \n\nTimestamp (in UTC) \n | \n
| \nincoming_inner_count\n | \n\nFLOAT64\n | \n\nNumber of visits/impressions recorded within a sensor’s defined inner detection range\n | \n
| \nincoming_outer_count\n | \n\nFLOAT64\n | \n\nNumber of visits/impressions recorded within a sensor’s outer detection range. Set at maximum by default, i.e., about 100 meters in an open environment, if not configured\n | \n
| \noutgoing_inner_count\n | \n\nFLOAT64\n | \n\nNumber of visits ending (closing) within the sensor’s inner detection range.\n | \n
| \noutgoing_outer_count\n | \n\nFLOAT64\n | \n\nNumber of visits ending within the sensor’s outer detection range.\n | \n
The User's API Key for the Account
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table_name\": \"sensor_visitors\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/desc_table","description":"This request returns a description of the sensor_visitors table (Columns and Datatypes). Sensor visitors is the number of visitors/occupancy to a sensor given by min, average, and max for a 15-minute period.
\nColumn names and datatypes in the table
\n| \n Fields\n | \n\n Data Type\n | \n\n Comments\n | \n
| \n sensor_id\n | \n\n INT64\n | \n\nInteger value of a sensor location id. Change in the sensor_name wouldn’t affect the sensor_id as long as the sensor location is not deleted from the system\n | \n
| \n sensor_name\n | \n\n STRING\n | \n\nName defined by the user to identify a location.\n | \n
| \n sensor_mac\n | \n\n STRING\n | \n\nStatic sensor identifier which remains the same even when a location is deleted from the system and re-added. \n | \n
| \nsensor_address\n | \n\nSTRING\n | \n\nPhysical address of the sensor as can be added by the user in BlueZoo dashboard\n | \n
| \nsensor_latitude\n | \n\nFLOAT64\n | \n\nPhysical coordinates of a sensor location\n | \n
| \nsensor_longitude\n | \n\nFLOAT64\n | \n\nPhysical coordinates of a sensor location\n | \n
| \ntimestamp\n | \n\nTIMESTAMP\n | \n\nTimestamp (in UTC) \n | \n
| \nminimum_visitors_inner\n | \n\nFLOAT64\n | \n\nMinimum number of visitors measured within a sensor’s defined inner detection range over a time span. Maximum resolution is 1⁄4-hour grain\n | \n
| \nmaximum_visitors_inner\n | \n\nFLOAT64\n | \n\nHighest visitor count measured within a sensor’s inner detection range\n | \n
| \naverage_visitors_inner\n | \n\nFLOAT64\n | \n\nAverage visitors within the sensor's inner range over a time span.\n | \n
| \nminimum_visitors_outer\n | \n\nFLOAT64\n | \n\nLowest visitor count measured within the sensor’s outer detection range. Set at maximum by default, i.e., about 100 meters in an open environment, if not configured\n | \n
| \nmaximum_visitors_outer\n | \n\nFLOAT64\n | \n\nHighest visitor count measured within a sensor’s outer detection range\n | \n
| \naverage_visitors_outer\n | \n\nFLOAT64\n | \n\nAverage visitors within the sensor's outer range over a time span.\n | \n
The User's API Key for the Account
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table_name\": \"sensor_visitors_per_minute\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/desc_table","description":"This request returns a description of the sensor_visitors_per_minute table (Columns and Datatypes). The table reports the number of visitors present during each 1-minute period. Each row reports visitors for both the inner and outer detection zones. This table is populated only if the “Per-Minute” option has been configured for the sensor; this table is not populated by default.
\nColumn names and datatypes in the sensor_visitors_per_minute
\nFields | Data Type | Comments |
sensor_id | INT64 | Integer value of a sensor location id. (primary sensor location identifier) |
sensor_name | STRING | Name defined by the user to identify a location. |
sensor_mac | STRING | Sensor hardware identifier |
sensor_address | STRING | Physical address of the sensor as can be added by the user in BlueZoo dashboard |
sensor_latitude | FLOAT64 | Physical coordinates of a sensor location |
sensor_longitude | FLOAT64 | Physical coordinates of a sensor location |
timestamp | TIMESTAMP | Timestamp (in UTC) |
time_offset | STRING | Time offset between UTC (GMT) at which times are stored in the data warehouse and the selected time zone of the sensor location |
visitors_inner | FLOAT64 | Number of visitors measured within a sensor’s defined inner detection range |
visitors_outer | FLOAT64 | Number of visitors measured within a sensor’s outer detection range. Set at maximum by default, i.e., about 100 meters in an open environment, if not configured |
The User's API Key for the Account
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table_name\": \"sensor_dwell\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/desc_table","description":"This request returns a description of the sensor_dwell table (Columns and Datatypes). Dwell time is a distribution of visit durations per 15-minute slots over a specified period of time. The visit duration represents the amount of time that was spent inside the inner detection range of the sensor.
\nColumn names and datatypes in the table
\n| \n Fields\n | \n\n Data Type\n | \n\n Comments\n | \n
| \n sensor_id\n | \n\n INT64\n | \n\nInteger value of a sensor location id. Change in the sensor_name wouldn’t affect the sensor_id as long as the sensor location is not deleted from the system\n | \n
| \n sensor_name\n | \n\n STRING\n | \n\nName defined by the user to identify a location.\n | \n
| \n sensor_mac\n | \n\n STRING\n | \n\nStatic sensor identifier which remains the same even when a location is deleted from the system and re-added. \n | \n
| \nsensor_address\n | \n\nSTRING\n | \n\nPhysical address of the sensor as can be added by the user in BlueZoo dashboard\n | \n
| \nsensor_latitude\n | \n\nFLOAT64\n | \n\nPhysical coordinates of a sensor location\n | \n
| \nsensor_longitude\n | \n\nFLOAT64\n | \n\nPhysical coordinates of a sensor location\n | \n
| \ntimestamp\n | \n\nTIMESTAMP\n | \n\nAn array of 15 minute time slots (in UTC). Each slot is defined by a start_timestamp. \n\n Visit duration information is for the visits that ended in that slot’s timespan. \n | \n
| \ntotal_visits\n | \n\nFLOAT64\n | \n\nTotal number of visits/impressions that ended in the given time slot\n | \n
| \ndistribution_bin_0000_to_0001\n.\n.\n.\ndistribution_bin_2400_to_beyond\n | \n\nFLOAT64\n | \n\nAn array of bin descriptions described by a “start” time and a “stop” time. Each duration bin consists of float values representing the percentage of visits that lasted for the bin’s duration.\ni.e., % of visits that lasted for 0-1 min\n.\n.\n.\n% of visits that lasted for 24 hours and beyond\n\n\n | \n
The User's API Key for the Account
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table_name\": \"group_uv_daily\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/desc_table","description":"This request returns a description of the group_UV tables, i.e., Unique Visitors over a day, a week, month and/or custom time filters. \nMonthly UV filter resets and begins on the 1st day of month. Weekly resets and begins each Monday.
\nColumn names and datatypes in the table
\n| \n Fields\n | \n\n Data Type\n | \n\n Comments\n | \n
| \n group_id\n | \n\n INT64\n | \n\nInteger value of a UV group id\n | \n
| \n group_name\n | \n\n STRING\n | \n\nName defined by the user to identify a group.\n | \n
| \n date\n | \n\n DATE\n | \n\nDate over which the unique visitors are measured\n | \n
| \ncuv_freq_10\n.\n.\n.\ncuv_freq_1\n | \n\nFLOAT64\n | \n\nNumber of Unique Visitors seen 10 times or more during the duration of the time interval\n.\n.\n.\nNumber of Unique Visitors seen once\n | \n
| \ncuv\n | \n\nFLOAT64\n | \n\nTotal number of Unique Visitors for the duration of the filter\n | \n
| \noutgoing_inner_visits\n | \n\nFLOAT64\n | \n\n Number of visits ending within the sensor’s inner detection range for the duration\n | \n
The User's API Key for the Account
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table_name\": \"group_flow_transition\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/desc_table","description":"This request returns a description of the traffic flow related tables (Columns and Datatypes). The measurements reported by flow are captured in the following four tables-
\nColumn names and datatypes in the table group_flow_transition
\n| \n Fields\n | \n\n Data Type\n | \n\n Comments\n | \n
| \n campaign_id\n | \n\n INT64\n | \n\nInteger value of the traffic flow campaign id.\n | \n
| \n campaign_name\n | \n\n STRING\n | \n\nName of the campaign being retrieved\n | \n
| \n group_source_id\n | \n\n INT64\n | \n\nInteger value of the source group id, which is an origin group where all journeys begin\n | \n
| \ngroup_source_name\n | \n\nSTRING\n | \n\nName defined for the origin group\n | \n
| \ngroup_destination_id\n | \n\nINT64\n | \n\nInteger value of the destination group id, where the mobile phones are seen later\n | \n
| \ngroup_destination_name\n | \n\nSTRING\n | \n\nName defined for the destination group\n | \n
| \ndate\n | \n\nDATE\n | \n\nDate of measured data\n | \n
| \ntransition_inner_count\n | \n\nINT64\n | \n\nNumber of journeys that transition from source to destination group\n | \n
| \ntransition_total_inner_count\n | \n\nINT64\n | \n\nTotal number of Journeys\n\n | \n
Column names and datatypes in the table group_flow_correlation
\n| \n Fields\n | \n\n Data Type\n | \n\n Comments\n | \n
| \n correlation_inner_count\n | \n\n INT64\n | \n\nNumber of common journeys between the two groups (A and B)\n | \n
| \n correlation_total_inner_count\n | \n\n INT64\n | \n\nTotal number of journeys at group A and B\n \n | \n
Column names and datatypes in the table group_flow_duration
\n| \n Fields\n | \n\n Data Type\n | \n\n Comments\n | \n
| \n number_of_groups_visited\n | \n\n INT64\n | \n\nThe integer values range from 1 to the number of groups in the group set\n | \n
| \n total_journey_count\n | \n\n INT64\n | \n\nTotal number of visitor journeys (One visitor can have multiple journeys per day)\n | \n
| \n average_journey_duration\n | \n\n INT64\n | \n\nAverage Journey duration measured in seconds\n \n | \n
Column names and datatypes in the table group_flow_segmentation
\n| \n Fields\n | \n\n Data Type\n | \n\n Comments\n | \n
| \n shoppers_count\n | \n\n INT64\n | \n\nTotal number of journeys within the inner range of the sensor that lasts less than the defined long time.\n | \n
| \n window_shoppers_count\n | \n\n INT64\n | \n\nTotal number of journeys only within the outer range that lasts longer than the defined short time and less than the long time\n | \n
| \n passersby_count\n | \n\n INT64\n | \n\nTotal number of journeys within the outer range that lasts for the shortest variable time\n | \n
| \n employees_count\n | \n\n INT64\n | \n\nTotal number of journeys within the outer range that lasts for longer than the defined long time\n \n | \n
The User's API Key for the Account
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table_name\": \"sensor_pulses\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/desc_table","description":"The sensor_pulses table provides telemetry and diagnostic data from BlueZoo sensors. It is primarily useful for sensor health monitoring, connectivity analysis, network quality analysis (Wi-Fi / cellular), MAC sampling volume tracking (Global vs Local), RF environment diagnostics, pulse delivery validation, rather than foot-traffic or visitor analytics.
\nColumn names and datatypes in the table sensor_pulses
\nFields | Data Type | Comments |
sensor_id | INT64 | Unique internal ID of the sensor |
sensor_name | STRING | Name of the sensor as defined by the user |
sensor_mac | STRING | MAC address of the sensor |
sensor_address | STRING | Physical address of the sensor location |
sensor_latitude | FLOAT | Latitude coordinate of the sensor |
sensor_longitude | FLOAT | Longitude coordinate of the sensor |
account_id | STRING | Unique account identifier |
account_name | STRING | Account name |
timestamp | TIMESTAMP | Timestamp of the pulse event |
expected_pulse_count | INT64 | Expected number of pulses for the reporting interval |
pulse_count | INT64 | Actual number of pulses received |
time_offset | STRING | Local time offset from UTC |
time_zone | STRING | Time zone of the sensor |
pulse_rssi_distribution | RECORD | Distribution of RSSI values captured during pulses |
mac_count_global | INT64 | Total MAC Global addresses detected |
mac_count_local | INT64 | Local MAC addresses detected |
mac_count_global_whitelisted | INT64 | Global MACs that passed whitelisting |
rssi_cellular_avg | FLOAT | Average cellular signal strength (RSSI) |
rssi_wifi_avg | FLOAT | Average Wi-Fi signal strength (RSSI) |
The BlueZoo Data Warehouse API allows application and service developers to gain access to historical data about locations managed by a given BlueZoo Cluster for their accounts. Using the API, the historical information can easily be ingested and integrated into customer built applications, custom services, and data visualization products.
\nHTTP POST or HTTP GET requests are used to retrieve the data. The request body contains the request’s parameters expressed in JSON or Text format. All responses are JSON format.
\nThe API includes the following services:
\nGet the list of tables available (e.g. group unique visits, dwell times, etc.)
\nGet the table description, providing columns to query in the table.
\nGet the results to a SQL query.
\nAccess Key
\nCustomers can access historical data in the data warehouse by using the RUN QUERY endpoint with the Customer-specific account “Access Key” found in the BlueZoo dashboard’s Profile screen.
\nThe BlueZoo Data Warehouse API is accessible via a specific base URL.
\nTo form the full request URL for a given endpoint (see available endpoints below), simply append the endpoint name to the base URL.
\n[Base API URL]
\nhttps://hermes.apollo.bluezoo.io/v2/dwh
\nExample:
\n[Full Request URL]
\nhttps://hermes.apollo.bluezoo.io/v2/dwh/list_tables
\nEach successful HTTP request should return 200 as HTTP Status Code.
\n","_postman_id":"89e2277d-43ef-424b-b4d6-6f473538f108"},{"name":"BlueZoo Real-time API","item":[{"name":"Get_occupancy_count","id":"37d85347-52e8-4853-b7e5-3818300e384b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"AccessKey af42d7dd-6b7a-4fb3-8df6-ad2c724d84d6","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://hermes.apollo.bluezoo.io/v2/get_occupancy_count?id=753","description":"This endpoint returns the momentary visitor count (i.e., momentary occupancy) for a specified sensor location at the beginning of the current minute.
\nRequired Parameter:
\nid: The sensor location IDThis endpoint returns the number of inner and outer visits measured for the last eight full 15-minute periods for a specified sensor location.
\nRequired Parameter:
\nid: The sensor location IDThe BlueZoo Real-time API allows application and service developers to gain access to the most recent visitor count (occupancy) and visit data from sensor locations in their accounts.
\nHTTP GET requests are used to retrieve the data. The request body contains the request’s parameters expressed in JSON or Text format. All responses are JSON format.
\nThe API includes the following services:
\nAccess Key
\nCustomers can access data from these endpoints by using their account-specific \"Access Key,\" available in the Profile section of the BlueZoo dashboard, for authentication.
\nThe BlueZoo Reall-time API is accessible via a specific base URL.
\nhttps://hermes.apollo.bluezoo.io/v2To form the full request URL for a given endpoint (see available endpoints below), simply append the endpoint name to the base URL.
\nExample:
\n[Base API URL]
\nhttps://hermes.apollo.bluezoo.io/v2[Full Request URL]
\nhttps://hermes.apollo.bluezoo.io/v2/get_occupancy_count?id={id}
\nWhere, id= the unique sensor location id
\nA sensor ID can be obtained from the \"Sensor locations> Properties\" section in the BlueZoo dashboard, or by querying the sensor and account-related tables through the BlueZoo Datawarehouse API.
\nEach successful HTTP request should return 200 as HTTP Status Code.
\n","_postman_id":"82cbf3e9-b227-4038-8b39-9c239a7fb00f"},{"name":"BlueZoo Fetch API","item":[{"name":"Account API Calls","item":[{"name":"2. get_account_info","id":"a1902c8c-3e77-45be-8c7f-d8ebeb22309c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{account_secret_token}}","description":"Account Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{account_access_token}}","description":"Account Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_account_info","description":"This endpoint returns information about the locations under the account. Account-level credentials are needed.
\nNote: location secret tokens are only provided in the response if the account owner has enabled third party fetch API access to that location.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_account_info\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the account\n | \n
| \n x-api-secret-token\n | \n\n Request header used for account authentication\n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n | \n\n No required parameters. Set the JSON request body as an empty hash (i.e. {} )\n | \n
Result
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_ACCOUNT_ERROR”\n “INVALID_ACCOUNT_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
| \n account_info\n | \n\n Hash structure holding information fields about the account\n | \n
| \n account_uuid\n | \n\n Unique ID of the account\n | \n
| \n locations\n | \n\n Array of location details\n | \n
| \n location_uuid\n | \n\n Unique ID of the location\n | \n
| \n nickname\n | \n\n Name of the location\n | \n
| \n access_enabled\n | \n\n Integer value (0 or 1) indicating whether or not the account owner have given access to the location.\n | \n
| \n access_token\n | \n\n Access token identifying the location\n | \n
| \n secret_token\n | \n\n Secret token used for authentication. The value is ‘null’ if API access has not been enabled by the account owner for that location\n | \n
{\"status\": \"OK\",\n\"account_info\": {\n \"account_uuid\": \"512C09CB-7DE4-4646-BF3D-37C9E1BB68A8\",\n \"locations\": [\n {\n \"location_uuid\": \"49045C0A-8F62-4F4D-80F5-C53A01C75DD7\",\n \"nickname\": \"Location 1\",\n \"access_enabled\": 1,\n \"access_token\": \"ACCESS-FA1FFF02-6C76-43DE-B503-C6489C0E3XXX\",\n \"secret_token\": \"SECRET-4A9F53A0-F605-4025-A85E-F0205279DXXX\"\n }}\nAccount Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{account_access_token}}","description":"Account Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n \"keyspace\": \"dashboard_view\",\n \"metadata\": \"{ \\\"theme_name\\\": \\\"ATLANTIS\\\" }\"\n}"},"url":"{{base_url}}/update_account_metadata","description":"This endpoint can be used to store client-side data that is to be attached to the account. The metadata is a character string that can be saved and retrieved under a keyspace. \nThe maximum number of keyspaces is currently limited to 32.\nThe maximum length of each metadata string is currently limited to 5KB.\nAccount authorization tokens are needed for account related calls.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n update_account_metadata\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the account.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for account authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n keyspace\n | \n\n String used to label the metadata\n | \n
| \n metadata\n | \n\n Arbitrary string of characters\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INVALID_PARAMETER_ERROR”\n “ACCOUNT_METADATA_CREATION_ERROR”\n “ACCOUNT_METADATA_UPDATE_ERROR”\n “TOO_MANY_METADATA_KEYSPACES_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_ACCOUNT_ERROR”\n “INVALID_ACCOUNT_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
Account Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{account_access_token}}","description":"Account Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n \"keyspace\": \"dashboard_view\"\n}"},"url":"{{base_url}}/get_account_metadata","description":"This endpoint can be used to retrieve client-side data that has been previously attached to the account under a specific keyspace.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_account_metadata\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the account.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for account authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n keyspace\n | \n\n String identifying which metadata is to be retrieved\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INVALID_PARAMETER_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_ACCOUNT_ERROR”\n “INVALID_ACCOUNT_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
Account Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{account_access_token}}","description":"Account Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n \"keyspace\": \"dashboard_view\"\n}"},"url":"{{base_url}}/delete_account_metadata","description":"This endpoint can be used to retrieve client-side data that has been previously attached to the account under a specific keyspace.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_account_metadata\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the account.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for account authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n keyspace\n | \n\n String identifying which metadata is to be deleted\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INVALID_PARAMETER_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_ACCOUNT_ERROR”\n “INVALID_ACCOUNT_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
Sensor Account Credentials Required
\nThe location and account level tokens can be retrieved by logging on to https://apollo-psq.bluefoxengage.com/login with the user account credentials: Make sure to enable the API access at both the account level and location level.
\nThe access and secret token strings are formatted as follows:
\nACCESS-07DDA579-CE6B-418C-927F-8D2B9A56A91C
SECRET-2946727A-E8DB-4A79-B598-7F28A2D3182B
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_location_info","description":"This endpoint returns basic information about a location identified by its access token.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_info\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n | \n\n There are currently no required parameters. Set the JSON request body as an empty hash (i.e. {} )\n | \n
Result:
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\nRequest status, possible values are:\n“OK”\n“TOKEN_AUTHENTICATION_ERROR”\n“INACTIVE_API_ACCESS_ERROR”\n“API_ACCESS_DISABLED”\n“INACTIVE_LOCATION_ERROR”\n“INVALID_LOCATION_ERROR”\n“JSON_PARSE_ERROR”\n“HEADER_ERROR”\n | \n
| \n location_info\n | \n\n Hash structure holding the information fields about the location\n | \n
| \n location_uuid\n | \n\n Unique ID of the location\n | \n
| \n nickname\n | \n\n Name of the location\n | \n
| \n timezone_name\n | \n\n Name of the time zone\n | \n
| \n occupancy_count_flooring_enabled\n | \n\n Integer value (0 or 1) indicating whether or not the location is set to use the count adjustment mechanism called ‘flooring compensation’. When enabled, this feature can help reduce the effect of a constant count offset (see floor_occupancy_count)\n | \n
| \n floor_occupancy_count\n | \n\n Integer value representing the constant count offset to remove (if any). It is only applicable if occupancy_count_flooring_enabled is set to 1 and can be used to offset devices in the count which are always detected.\n | \n
| \n max_occupancy_count\n | \n\n Maximum occupancy threshold defined for that location\n | \n
| \n occupancy_count_alert_enabled\n | \n\n Integer value (0 or 1) indicating whether or not an occupancy count alert will be generated when the real-time occupancy count after flooring removal (if enabled) exceeds the set threshold\n | \n
| \n sensor_last_connected_at\n | \n\n Timestamp (in UTC) indicating when the associated sensor sent data to the server for the last time\n | \n
| \n subscription_valid_until\n | \n\n Timestamp (in UTC) indicating until when the sensor subscription is valid\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_location_core_realtime_snapshot","description":"The get_location_core_realtime_snapshot endpoint is a convenience/performance endpoint that fetches into one call the combined result of these individual endpoints: \nget_location_info, \nget_location_realtime_occupancy_count, and \nget_location_metadata.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_core_realtime_snapshot\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n None\n | \n\n No required parameters. Set the JSON request body as an empty hash (i.e. {} )\n | \n
| \n metadata_info_array\n | \n\n(Optional) Array of metadata_info elements identifying which metadata is to be retrieved. There is a limit on the number of metadata keyspaces that can be retrieved (currently up to 4)\n | \n
| \n metadata_info\n | \n\n Hash defining which keyspace is to be retrieved.\n | \n
JSON request examples:
\n{} (Empty Body)
\nJSON response example:
\n{ \"status\": \"OK\",\n\"location_core_realtime_snapshot\": \n{\"location_uuid\": \"0B1C9B2B-6364-453B-8809-8DB5613AD777\",\n\"nickname\": \"Lake\",\n\"timezone_name\": \"America/Los_Angeles\",\n\"max_occupancy_count\": 999,\n\"occupancy_count_flooring_enabled\": 0,\n\"floor_occupancy_count\": 0,\n\"occupancy_count_alert_enabled\": 0,\n\"subscription_valid_until\": 1910993490,\n\"sensor_last_connected_at\": 1609278990,\n\"occupancy_count\": 13,\n\"metadata_result_array\": []\n}}
\nJSON request example:
\n{\"metadata_info_array\": [{ \"keyspace\": \"mine\"} ]}
\nJSON response example:\n{\"location_uuid\": \"0B1C9B2B-6364-453B-8809-8DB5613AD777\",\n\"nickname\": \"Lake\",\n\"timezone_name\": \"America/Los_Angeles\",\n\"max_occupancy_count\": 999,\n\"occupancy_count_flooring_enabled\": 0,\n\"floor_occupancy_count\": 0,\n\"occupancy_count_alert_enabled\": 0,\n\"subscription_valid_until\": 1910993490,\n\"sensor_last_connected_at\": 1609278990,\n\"occupancy_count\": 13,\n\"metadata_result_array\": [{\"keyspace\": \"mine\", \"metadata\": \"theData\"}]\n}}
\nResult
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INVALID_PARAMETER_ERROR”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n “SENSOR_SUBSCRIPTION_VALIDITY_ERROR”\n “UNCALIBRATED_LOCATION_ERROR”\n \"TOO_MANY_METADATA_KEYSPACES_ERROR\"\n | \n
| \n location_core_realtime_snapshot\n | \n\n Hash containing the attributes that form the snapshot\n | \n
\n
| \n \n Unique ID of the location\n | \n
\n
| \n \n Name of the location\n | \n
\n
| \n \n Name of the time zone\n | \n
\n
| \n \n Maximum occupancy threshold defined for that location\n | \n
\n
| \n \n Integer value (0 or 1) indicating whether or not the location is set to use the count adjustment mechanism called ‘flooring compensation’. When enabled, this feature can help reduce the effect of a constant count offset (see floor_occupancy_count)\n | \n
\n
| \n \n Integer value representing the constant count offset to remove (if any). It is only applicable if occupancy_count_flooring_enabled is set to 1 and can be used to offset devices in the count which are always detected.\n | \n
\n
| \n \n Integer value (0 or 1) indicating whether or not an occupancy count alert will be generated when the real-time occupancy count after flooring removal (if enabled) exceeds the set threshold\n | \n
\n
| \n \n Timestamp (in UTC) indicating until when the sensor subscription is valid\n | \n
\n
| \n \n Timestamp (in UTC) indicating when the associated sensor sent data to the server for the last time\n | \n
\n
| \n \n Real-time occupancy count without flooring compensation\n | \n
\n
| \n \n Array of metadata result elements\n | \n
| metadata_result\n | \n\n Hash providing the metadata value corresponding to the specified keyspace\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_location_core_realtime_snapshot_array","description":"The get_location_core_realtime_snapshot_array endpoint is a convenience/performance endpoint that fetches into one call the combined result of these individual endpoints:
\nget_location_info,\n get_location_realtime_occupancy_count, and\n Get_location_metadata.
\nNote: The request supports returning the data for as many as 16 locations corresponding to the location authorization tokens.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_core_realtime_snapshot_array\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n location_stipulation_array\n | \n\n Array of location_stipulation elements. The number of elements is limited (currently up to 16 locations can be fetched at once)\n | \n
| \n location_stipulation\n | \n\n Hash identifying the attributes of each location to be retrieved\n | \n
| \n access_token\n | \n\n String identifying the location\n | \n
| \n secret_token\n | \n\n String needed to authenticate the access right\n | \n
| \n metadata_info_array\n | \n\n (Optional) Array of metadata_info elements identifying which metadata is to be retrieved. There is a limit on the number of metadata keyspaces that can be retrieved (currently up to 4)\n | \n
| \n metadata_info\n | \n\n Hash defining which keyspace is to be retrieved.\n | \n
JSON request example:
\n { \"location_stipulation_array\":\n [\n { \"access_token\": \"ACCESS-8BC856C0-F767-461E-AEDE-498EEC3665A6\",\n \"secret_token\": \"SECRET-03C13AED-66B5-48E5-BE3B-4EAE300F1398\",\n \"metadata_info_array\": [\n { \"keyspace\": \"my_custom_attributes\"\n },\n { ...\n } ]\n },\n { …\n } ]\n }\nJSON response example:
\n { \"status\":\n \"OK\",\n \"location_result_array\": [\n { \"access_token\": \"ACCESS-8BC856C0-F767-461E-AEDE-498EEC3665A6\",\n \"response\": { \"status\": \"OK\",\n \"location_core_realtime_snapshot\": { \"location_uuid\": \"D650F753-1579-4816-83AF-A5E1B3744AFF\",\n \"nickname\": \"Sunnyvale\",\n \"timezone_name\": \"America/Denver\",\n \"max_occupancy_count\": 5,\n \"occupancy_count_flooring_enabled\": 1,\n \"floor_occupancy_count\": 1,\n \"occupancy_count_alert_enabled\": 1,\n \"subscription_valid_until\": 1640386872,\n \"sensor_last_connected_at\": 1608794790,\n \"occupancy_count\": 0,\n \"metadata_result_array\": [\n { \"keyspace\": \"my_custom_attributes\",\n \"metadata\": \"{ \\\"color\\\": \\\"blue\\\" }\"\n },\n { ...\n } ]\n } } },\n { … \n } ]\n }\nResult
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INVALID_PARAMETER_ERROR”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n “SENSOR_SUBSCRIPTION_VALIDITY_ERROR”\n “UNCALIBRATED_LOCATION_ERROR”\n \"TOO_MANY_METADATA_KEYSPACES_ERROR\"\n \"TOO_MANY_LOCATIONS_ERROR\"\n | \n
| \n location_result_array\n | \n\n Array of location result elements\n | \n
| \n location_result\n | \nHash containing the “access_token” of the location for which the result is returned and provided in the “response” field. For details about the response, please refer to the get_location_core_realtime_snapshot endpoint (above)\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_location_realtime_occupancy_count","description":"This endpoint returns the real-time occupancy count which is an estimation of the number of WIFI devices currently detected at the specified location.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_realtime_occupancy_count\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n | \n\n No required parameters. Set the JSON request body as an empty hash (i.e. {} )\n | \n
| \n Fields\n | \n\n Description\n | \n
| status\n | \nRequest status, possible values are: \"OK\" \"TOKEN_AUTHENTICATION_ERROR\" \"INACTIVE_API_ACCESS_ERROR\" \"API_ACCESS_DISABLED\" \"INACTIVE_LOCATION_ERROR\" \"INVALID_LOCATION_ERROR\" \"JSON_PARSE_ERROR\" \"HEADER_ERROR\" \"SENSOR_SUBSCRIPTION_VALIDITY_ERROR\" \"UNCALIBRATED_LOCATION_ERROR\" \n | \n
| \n occupancy_count\n | \n\n Real-time occupancy count without flooring compensation\n | \n
| \n occupancy_count_flooring_enabled\n | \n\n Integer value (0 or 1) indicating whether or not the location is set to use the count adjustment mechanism called ‘flooring’. When enabled, this feature can help reduce the effect of a constant count offset (see floor_occupancy_count)\n | \n
| \n floor_occupancy_count\n | \n\n Integer value representing the constant count offset to remove (if any). It is only applicable if occupancy_count_flooring_enabled is set to 1 and can be used to offset devices in the count which are always detected.\n | \n
| \n sensor_last_connected_at\n | \n\n Timestamp (in UTC) indicating when the associated sensor sent data to the server for the last time\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_location_realtime_occupancy_load","description":"get_location_realtime_occupancy_load
\nThis endpoint returns the real-time occupancy load at the specified location. The load is expressed as a string. Load determination is based by comparing the real-time occupancy count with the maximum allowed occupancy count accounting for flooring compensation if needed.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_realtime_occupancy_load\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n | \n\n No required parameters. Set the JSON request body as an empty hash (i.e. {} )\n | \n
Result
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n “SENSOR_SUBSCRIPTION_VALIDITY_ERROR”\n “UNCALIBRATED_LOCATION_ERROR”\n | \n
| \n occupancy_load\n | \n\n Real-time occupancy load determined by comparing the real-time occupancy count with the maximum allowed occupancy count for that location and accounting for flooring compensation if needed.\n Possible values: “LOW” and “HIGH”\n | \n
| \n sensor_last_connected_at\n | \n\n Timestamp (in UTC) indicating when the associated sensor sent data to the server for the last time\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_location_realtime_cumulative_count","urlObject":{"path":["get_location_realtime_cumulative_count"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2ad02be5-7f65-4535-8708-aa0d5b40565b","name":"Example - get_location_realtime_cumulative_count","originalRequest":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"Sensor Secret Token","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_location_realtime_cumulative_count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 00:12:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"ETag","value":"W/\"ae99438c41c5dbc12d2cfad1812cdd69\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"a90d7eb0-b29f-43b8-8280-25c506b97f3d"},{"key":"X-Runtime","value":"0.020454"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"cumulative_count\": 565588,\n \"sensor_last_connected_at\": 1614471167\n}"}],"_postman_id":"fbc6f370-63c0-4cd1-aa23-864a10f89fe4"}],"id":"e6256401-d448-415f-9a12-c4610218ac8f","_postman_id":"e6256401-d448-415f-9a12-c4610218ac8f","description":""},{"name":"Occupancy History","item":[{"name":"5. get_location_historical_occupancy_counts","id":"2274a278-a8e3-47ab-9b8b-ccc60c606f1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\"day_span\": 0}"},"url":"{{base_url}}/get_location_historical_occupancy_counts","description":"This endpoint returns the last historical values of the occupancy count aggregated by time intervals (slots). A parameter (day_span) sets the scope of the request. Time slots are typically 15 minutes long.
\n| \nRequest\n | \n\nDescription\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_historical_occupancy_counts\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication.\n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n day_span\n | \n\nInteger representing the number of full days for which to retrieve historical data since current time.\n For the value 0, time slots from the beginning of the current (i.e. midnight interpreted in the location’s time zone) to current time are returned.\n For other values (e.g. 1, 2, 7), it adds 1, 2 and 7 full days of data respectively.\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n “SENSOR_SUBSCRIPTION_VALIDITY_ERROR”\n “UNCALIBRATED_LOCATION_ERROR”\n | \n
| \n occupancy_count_flooring_enabled\n | \n\n Integer value (0 or 1) indicating whether or not the location is set to use the count adjustment mechanism called ‘flooring’. When enabled, this feature can help reduce the effect of a constant count offset (see floor_occupancy_count)\n | \n
| \n floor_occupancy_count\n | \n\n Integer value representing the constant count offset to remove (if any). It is only applicable if occupancy_count_flooring_enabled is set to 1 and can be used to offset devices in the count which are always detected.\n | \n
| \n occupancy_count_slots\n | \n\n Array structure holding the historical time slots.\n Note: the array may contain time gaps.\n Each time slot is represented by an array of four values defined as follows:\n [\n <start_timestamp>,\n <stop_timestamp>,\n <low_occupancy_count>,\n <high_occupancy_count>\n ]\n Low and high occupancy count values are values without flooring compensation applied.\n | \n
| \n actual_day_span\n | \n\n Integer value corresponding to the actual day span being retrieved. The maximum day_span is limited based on account types and subscription levels.\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/update_location_max_occupancy_count","description":"This endpoint can be used to change the maximum occupancy count threshold of the location. When the location’s real-time occupancy count exceeds that new threshold, an alert may be triggered. That new threshold value is also used to determine the occupancy load.
\n| \nRequest\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n update_location_max_occupancy_count\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n max_occupancy_count\n | \n\n Integer value representing the new maximum occupancy count threshold to be used for that location. \n | \n
Result
\n| \n Fields\n | \n\n Description\n | \n
| status\n | \nRequest status, possible values are: \"OK\" \"TOKEN_AUTHENTICATION_ERROR\" \"INACTIVE_API_ACCESS_ERROR\" \"API_ACCESS_DISABLED\" \"INACTIVE_LOCATION_ERROR\" \"INVALID_LOCATION_ERROR\" \"JSON_PARSE_ERROR\" \"HEADER_ERROR\" \"SENSOR_SUBSCRIPTION_VALIDITY_ERROR\" \"UNCALIBRATED_LOCATION_ERROR\" \n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\"day_span\": 0}"},"url":"{{base_url}}/get_location_historical_cumulative_counts","description":"This endpoint returns the last historical values of the occupancy count aggregated by time intervals (slots). A parameter (day_span) sets the scope of the request. Time slots are typically 15 minutes long.
\n| \nRequest\n | \n\nDescription\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_historical_cumulative_counts\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication.\n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n day_span\n | \n\nInteger representing the number of full days for which to retrieve historical data since current time.\n For the value 0, time slots from the beginning of the current (i.e. midnight interpreted in the location’s time zone) to current time are returned.\n For other values (e.g. 1, 2, 7), it adds 1, 2 and 7 full days of data respectively.\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
| \n cumulative_count_slots\n | \n\n Array structure holding the historical time slots. \n Note: the array may contain time gaps. \n Each time slot is represented by an array of four values defined as follows:\n[\n start_timestamp>, \n stop_timestamp>, \n initial_cumulative_count>,\n final_cumulative_count>\n]\n | \n
| \n actual_day_span\n | \n\n Integer value corresponding to the actual day span being retrieved. The maximum day_span is limited based on account types and subscription levels.\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\"start_timestamp\": 1612166400,\n\"stop_timestamp\": 1614585599}"},"url":"{{base_url}}/get_location_historical_cumulative_count_difference","description":"This endpoint returns the number of visits seen between two dates detected at the specified location. The best granularity we have is 15 minutes for historical data. If a smaller interval is called then the endpoint will return a distribution based on the 15 minute interval. For example, if the endpoint is asked to return 15 consecutive 1 minute intervals each minute will not reflect that minutes count but the average for the 15 minute interval.
\nA Real-Time endpoint (Get_Location_Realtime_Cumulative_Count) must be called to return the cumulative value for the smaller time slice. The difference is then achieved by subtracting the prior cumulative value for the time interval. For example, at 7:00 the call returns 1234 and at 7:01 it is 1237. The number of visits between 7:00 and 7:01 is 1237 - 1234 = 3.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_historical_cumulative_count_difference\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n start_timestamp\n | \n\n Timestamp (in UTC) indicating the beginning of the period\n | \n
| \n stop_timestamp\n | \n\n Timestamp (in UTC) indicating the end of the period\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n “SENSOR_SUBSCRIPTION_VALIDITY_ERROR”\n “UNCALIBRATED_LOCATION_ERROR”\n | \n
| \n cumulative_count_difference\n | \n\n The number of total visits observed at the location during the indicated period. Note: A single visitor may contribute to one or more visits. \n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n\"start_timestamp\": 1614240000,\n\"stop_timestamp\": 1614412799,\n\"aggregation_method\":\"DAY\",\n\"aggregation_parameters\": \n{ \n\"aggregation_start_time\":\"08:00\",\n\"aggregation_stop_time\":\"21:00\"\n}\n}"},"url":"{{base_url}}/get_location_historical_aggregated_ending_visit_count_between_epochs","description":"This endpoint is used to retrieve the number of ending visits (or closed visits) aggregated over a specific timespan and a specific aggregation period. It provides visit count information for a given location that has occurred within the sensor’s inner zone as well as within the sensor’s outer zone.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\nget_location_historical_aggregated_ending_visit_count_between_epochs\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n start_timestamp\n | \n\n Start timestamp of the desired timespan \n | \n
| \n stop_timestamp\n | \n\n Stop timestamp of the desired timespan minus one second\n | \n
| \n aggregation_method\n | \n\n Method to use. The values ‘DAY’ and ‘DURATION’ are currently supported.\n | \n
| \n aggregation_parameters\n | \n\n The parameters that are required for chosen aggregation method expressed as a JSON Hash\n\n In the case of a ‘DURATION’ aggregation_method, the hash must provide the field ‘aggregation_duration’. It is an Integer field representing the duration expressed in seconds. It must be a multiple of 900 (i.e. multiple of 15 minutes). \nExample: { “aggregation_duration”: 3600 } \nIn the case of a ‘DAY’ aggregation_method, the hash must provide the fields ‘aggregation_start_time’ and aggregation_stop_time‘ which are used to specify a restricted scope within the day (e.g. opening hours, morning hours). The valid format is “HH:MM” were HH can range from 00 to 24 and were MM can be 00, 15, 30 or 45. \nExample: { “‘aggregation_start_time’ ”: “08:00”, “aggregation_stop_time: “21:00” }\n | \n
Result
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INVALID_PARAMETER_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n “INVALID_AGGREGATION_METHOD_ERROR”\n “SENSOR_SUBSCRIPTION_VALIDITY_ERROR”\n “UNCALIBRATED_LOCATION_ERROR”\n “INVALID_TIMESTAMP_RANGE_ERROR”\n “INVALID_AGGREGATION_DURATION_ERROR”\n “INVALID_START_TIMESTAMP_ERROR”\n “INVALID_STOP_TIMESTAMP_ERROR”\n | \n
| \n start_timestamp\n | \n\n Same value that was passed in the request\n | \n
| \n stop_timestamp\n | \n\n Same value that was passed in the request\n | \n
| \n aggregated_ending_visit_count_slots\n | \n\n An array of aggregated slots where each slot contains the following elements:\n The start timestamp of the slot\n The stop timestamp of the slot\n The number of seconds for which the system received sensor data during that period\n The number of visits ending within the slot period that entered the inner zone\n The number of visits ending within the slot period that entered the outer zone\n The window conversion ratio (in percent) computed as the inner count value (element #4) divided by the outer count value (element #5)\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n\"start_timestamp\": 1614326400,\n\"stop_timestamp\": 1614412799\n}"},"url":"{{base_url}}/get_location_historical_cumulative_counts_between_epochs","description":"This endpoint returns the last historical values of the occupancy count aggregated by time intervals (slots). A parameter (day_span) sets the scope of the request. Time slots are typically 15 minutes long.
\n| \nRequest\n | \n\nDescription\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_historical_cumulative_counts\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication.\n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n day_span\n | \n\nInteger representing the number of full days for which to retrieve historical data since current time.\n For the value 0, time slots from the beginning of the current (i.e. midnight interpreted in the location’s time zone) to current time are returned.\n For other values (e.g. 1, 2, 7), it adds 1, 2 and 7 full days of data respectively.\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
| \n cumulative_count_slots\n | \n\n Array structure holding the historical time slots. \n Note: the array may contain time gaps. \n Each time slot is represented by an array of four values defined as follows:\n[\n start_timestamp>, \n stop_timestamp>, \n initial_cumulative_count>,\n final_cumulative_count>\n]\n | \n
| \n actual_day_span\n | \n\n Integer value corresponding to the actual day span being retrieved. The maximum day_span is limited based on account types and subscription levels.\n | \n
Account Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Account Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n\"keyspace\": \"timeline_view\",\n\"metadata\": \"{ \\\"start_time\\\": \\\"8:00AM\\\", \\\"stop_time\\\": \\\"6:00PM\\\", \\\"color\\\": \\\"blue\\\" }\"\n}"},"url":"{{base_url}}/update_location_metadata","description":"This endpoint can be used to store client-side data that is to be attached to a given location. The metadata is a character string that can be saved and retrieved under a keyspace.
\nThe maximum number of keyspaces is currently limited to 32.
\nThe maximum length of each metadata string is currently limited to 5KB.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n update_location_metadata\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n keyspace\n | \n\n String used to label the metadata\n | \n
| \n metadata\n | \n\n Arbitrary string of characters\n | \n
Result
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INVALID_PARAMETER_ERROR”\n “LOCATION_METADATA_CREATION_ERROR”\n “LOCATION_METADATA_UPDATE_ERROR”\n “TOO_MANY_METADATA_KEYSPACES_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
Account Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Account Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n\"keyspace\": \"timeline_view\"\n}"},"url":"{{base_url}}/get_location_metadata","description":"This endpoint can be used to retrieve client-side data that has been previously attached to the location under a specific keyspace.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_metadata\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n keyspace\n | \n\n String identifying which metadata is to be retrieved\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INVALID_PARAMETER_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
Account Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Account Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n\"keyspace\": \"timeline_view\"\n}"},"url":"{{base_url}}/delete_location_metadata","description":"This endpoint can be used to retrieve client-side data that has been previously attached to the location under a specific keyspace.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_metadata\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n keyspace\n | \n\n String identifying which metadata is to be deleted.\n | \n
| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n “OK”\n “TOKEN_AUTHENTICATION_ERROR”\n “INVALID_PARAMETER_ERROR”\n “INACTIVE_API_ACCESS_ERROR”\n “API_ACCESS_DISABLED”\n “INACTIVE_LOCATION_ERROR”\n “INVALID_LOCATION_ERROR”\n “JSON_PARSE_ERROR”\n “HEADER_ERROR”\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n\"start_timestamp\": 1622505600,\n\"stop_timestamp\": 1622506500\n}"},"url":"{{base_url}}/get_location_historical_dwell_time_slots_between_epochs","description":"This endpoint is used to retrieve the distribution of visit durations per 15-minute slots over a specified period of time. The visit duration represents the amount of time that was spent inside the inner zone. The duration distribution that is provided is high resolution to accommodate a variety of use cases. The bin granularity is high for shorter durations and becomes progressively lower for longer duration.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_historical_dwell_time_slots_between_epochs\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n start_timestamp\n | \n\n Start timestamp of the desired timespan \n | \n
| \n stop_timestamp\n | \n\n Stop timestamp of the desired timespan minus one second\n | \n
Note that the following constraints must be satisfied:
\nResult
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n\n | \n
| \n dwell_time_distribution_array_layout\n | \n\n An array of bin descriptions described by a “start” time and a “stop” time using format <hour>:<minute>:<second>.\n\n | \n
| \n dwell_time_slots\n | \n\n An array of 15 minute time slots. Each slot is defined by a start_timestamp, a stop_timestamp and a dwell_time_distribution_array that provides visit duration information for the visits that ended in that slot’s timespan. \n\n | \n
| \n dwell_time_distribution_array\n | \n\n An array of float values representing the percentage of visits for each duration bin.\n | \n
Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n\"start_timestamp\": 1614326400,\n\"stop_timestamp\": 1614412799\n}"},"url":"{{base_url}}/get_location_historical_dwell_time_slots_consolidation_between_epochs","description":"This endpoint is used to retrieve the distribution of visit durations over a specified period of time. The visit duration represents the amount of time that was spent inside the inner zone. The duration distribution that is provided is high resolution to accommodate a variety of use cases. The bin granularity is high for shorter durations and becomes progressively lower for longer duration.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n POST\n | \n
| \n Endpoint\n | \n\n get_location_historical_dwell_time_slots_consolidation_between_epochs\n | \n
| \n Content-Type\n | \n\n application/plain\n | \n
| \n x-api-access-token\n | \n\n Request header used to identify the location.\n | \n
| \n x-api-secret-token\n | \n\n Request header used for location authentication. \n | \n
| \n JSON Request Body\n | \n\n Description\n | \n
| \n start_timestamp\n | \n\n Start timestamp of the desired timespan \n | \n
| \n stop_timestamp\n | \n\n Stop timestamp of the desired timespan minus one second\n | \n
Note that the following constraints must be satisfied:
\nResult
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\n Request status, possible values are:\n\n | \n
| \n dwell_time_distribution_array_layout\n | \nAn array of bin descriptions described by a “start” time and a “stop” time using format <hour>:<minute>:<second>.\n\n | \n
| \n dwell_time_distribution_array\n | \nAn array of float values representing the percentage of visits for each duration bin.\n | \n
| \n average_dwell_time_duration\n | \n\n The average dwell time duration\n | \n
| \n median_dwell_time_duration\n | \n\n The median dwell time duration\n | \n
Sensor Location Credentials Required
\nThe access and secret token strings are formatted as follows:
\nACCESS-07DDA579-CE6B-418C-927F-8D2B9A56A91C\nSECRET-2946727A-E8DB-4A79-B598-7F28A2D3182B
\n","_postman_id":"8564cd95-eb35-492d-8554-e25e2beb4eeb"},{"name":"Server Status","item":[{"name":"1. Ping","id":"ebb1ae0b-9096-4e9a-83b9-70f9854ddc6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"Sensor Secret Token
\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Sensor Access Token
\n","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"{{base_url}}/get_location_realtime_occupancy_count","description":"This endpoint can be used to check the availability of the Bluefox Fetch API.
\n| \n Request\n | \n\n Description\n | \n
| \n HTTP Method\n | \n\n GET\n | \n
| \n Endpoint\n | \n\n ping\n | \n
Result
\n| \n Fields\n | \n\n Description\n | \n
| \n status\n | \n\nRequest status, possible values are:\n“OK”\n“API_ACCESS_DISABLED”\n | \n
The BlueZoo Fetch API is deprecated and replaced by the Real-time API. The Fetch API service will be discontinued on December 31, 2025.
\nThe BlueZoo Fetch API allows application and service developers to gain access to real-time data, historical data and configuration information about specific locations managed by a given BlueZoo Cluster. Using the API, real-time count information can easily be embedded into third-party applications and services.
\nWe have added methods to better return real time sensor data and configuration information.
\nThe get_location_core_realtime_snapshot endpoint is a convenience/performance endpoint that fetches into one call the combined result of these individual endpoints:
\nget_location_info,
\nget_location_realtime_occupancy_count, and
\nget_location_metadata.
\nThe get_location_core_realtime_snapshot_array endpoint is a convenience/performance endpoint that allows you to fetch the above core real time snapshot for multiple locations at once. The number of fetchable locations is limited to 16 locations.
\nInformation retrieval is performed via HTTP POST or HTTP GET requests where the request body contains the request’s parameters expressed in JSON format. Each request provides a result expressed in JSON format.
\nThe full API includes the following main services:
\nGet location information (e.g. location name, max occupancy count)
\nGet the real-time occupancy count at a given location
\nGet the occupancy count history at given location (e.g. for last 2 days)
\nGet the real-time occupancy load (e.g. High & Low load)
\nGet the real-time cumulative count (i.e. visit counter)
\nGet the cumulative count history
\nChange a location’s max occupancy count threshold
\nGet visit dwell time information
\nAccess to the BlueZoo Fetch API is controlled by authentication credentials composed of an access token and a secret token. There are two types of authentication credentials:
\nlocation-level credentials
\naccount-level credentials
\nEach type has separate authentication credentials.
\nIn both cases the access and secret token strings are formatted as follows:
\nACCESS-07DDA579-CE6B-418C-927F-8D2B9A56A91C
\nSECRET-2946727A-E8DB-4A79-B598-7F28A2D3182B
\nSeparate access credential tokens for each sensor and each account are available from the Bluefox Fetch API Management Console.
\nRegion | Management Console Access |
Global | http://apollo-psq.bluefoxengage.com/login |
The BlueZoo Fetch API is accessible via a specific base URL. That base URL varies based on the geographic location your customer account was created at.
\nRegion | API Base URL |
Global (Includes India) | https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100 |
Asia-Pacific | https://artemis-psq.bluefoxengage.com/third_party_fetch_api/v100 |
To form the full request URL for a given endpoint (see available endpoints below), simply append the endpoint name to the base URL.
\nExample:
\n[Base API URL]
\nhttps://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100
\n[Full Request URL]
\n\nEach successful HTTP request should return 200 as HTTP Status Code. When requests are made too frequently to the API, code 429 may be returned as HTTP Status Code.
\n","_postman_id":"5023743c-5f18-4549-b725-5e4c2fbc40c4"}],"variable":[{"key":"af42d7dd-6b7a-4fb3-8df6-ad2c724d84d6","value":"af42d7dd-6b7a-4fb3-8df6-ad2c724d84d6"},{"key":"Key","value":"af42d7dd-6b7a-4fb3-8df6-ad2c724d84d6"},{"key":"id","value":"753"},{"key":"AccessKey","value":"AccessKey af42d7dd-6b7a-4fb3-8df6-ad2c724d84d6"}]}