{"info":{"_postman_id":"d3366357-8d5d-431b-90c9-a149523c7dcd","name":"PartySquasher_Pro_Fetch_API","description":"

Revision History

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Revision\n	Date\n	Author\n	Description of change\n
V100.5\n	30 April 2018\n	BlueZoo Staff\n	Update.\n
V100.7\n	29 Dec 2020\n	BlueZoo Staff\n	Added two new API methods:\n \n get_location_core_realtime_snapshot\n get_location_core_realtime_snapshot_array\n \n \n
V100.8\n	18 April 2021\n	BlueZoo Staff\n	API Calls reduced to Party Squasher Pro Use Cases.\n

\n\n

Overview

The Party Squasher Fetch API allows application and service developers to gain access to real-time data, historical data and configuration information about specific locations. Using the API, real-time count information can easily be embedded into third-party applications and services. Party Squasher customers must contact BlueZoo Customer Success Team to enable API access.

Changes in This Release

Reduced API set to match Party Squasher Pro Use Cases.

Service Summary

Information 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.

The full API includes the following main services:

Get location information (e.g. location name, max occupancy count)
Get the real-time occupancy count at a given location
Get the occupancy count history at given location (e.g. for last 2 days)
Get the real-time occupancy load (e.g. High & Low load)
Get the real-time cumulative count (i.e. visit counter)
Change a location’s max occupancy count threshold

Access Credentials

Access to the Party Squasher Fetch API is controlled by authentication credentials composed of an access token and a secret token. There are two types of authentication credentials:

location-level credentials
account-level credentials

Each type has separate authentication credentials.

In both cases the access and secret token strings are formatted as follows:

ACCESS-07DDA579-CE6B-418C-927F-8D2B9A56A91C

SECRET-2946727A-E8DB-4A79-B598-7F28A2D3182B

Separate access credential tokens for each sensor and each account are available from the BlueZoo Fetch API Management Console. Party Squasher customers must contact BlueZoo Customer Success Team to enable Management Console access.

\n\n \n \n \n \n \n \n \n \n \n \n

Product\n	Management Console Access\n
Party Squasher\n	http://apollo-psq.bluefoxengage.com/login\n

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Index	Party Squasher Fetch API Definitions
1	ping
2	get_account_info
3	get_location_info
4	get_location_realtime_occupancy_count
5	get_location_historical_occupancy_counts
6	get_location_realtime_occupancy_load
7	get_location_realtime_cumulative_count
8	update_location_max_occupancy_count
9	update_account_metadata
10	get_account_metadata
11	delete_account_metadata
12	update_location_metadata
13	get_location_metadata
14	delete_location_metadata
15	get_location_core_realtime_snapshot
16	get_location_core_realtime_snapshot_array

Party Squasher Fetch API Use

The Party Squasher Fetch API is accessible via a specific base URL. That base URL varies based on the geographic location your customer account was created at.

\n\n \n \n \n \n \n \n \n \n \n \n

Region\n	API Base URL\n
Party Squasher)\n	https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100\n

\n\n\n

To form the full request URL for a given endpoint (see available endpoints below), simply append the endpoint name to the base URL.

Example:

[Base API URL]

https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100

[Full Request URL]

https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100/get_location_realtime_occupancy_count

Each 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
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Revision History","slug":"revision-history"},{"content":"Overview","slug":"overview"},{"content":"Service Summary","slug":"service-summary"},{"content":"Party Squasher Fetch API Use","slug":"party-squasher-fetch-api-use"}],"owner":"14323059","collectionId":"d3366357-8d5d-431b-90c9-a149523c7dcd","publishedId":"TzRLmAae","public":true,"customColor":{"top-bar":"399EBF","right-sidebar":"FFF","highlight":"EE2979"},"publishDate":"2021-05-03T21:12:57.000Z"},"item":[{"name":"Account API Calls","item":[{"name":"2. get_account_info","id":"dd5c079c-ef1a-43e4-8328-fcf7544d7ccd","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":"

get_account_info

This endpoint returns information about the locations under the account. Account-level credentials are needed.

Note: 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 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_account_info\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the account\n
\n x-api-secret-token\n	\n Request header used for account authentication\n

\n\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n	\n No required parameters. Set the JSON request body as an empty hash (i.e. {} )\n

\n\n

Result

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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 account_info\n	\n Hash structure holding information fields about the account\n
\n account_uuid\n	\n Unique ID of the account\n
\n locations\n	\n Array of location details\n
\n location_uuid\n	\n Unique ID of the location\n
\n nickname\n	\n Name of the location\n
\n access_enabled\n	\n Integer value (0 or 1) indicating whether or not the account owner have given access to the location.\n
\n access_token\n	\n Access token identifying the location\n
\n secret_token\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\n

Example Response

{\"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        }}\n

","urlObject":{"path":["get_account_info"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd5c079c-ef1a-43e4-8328-fcf7544d7ccd"},{"name":"10. update_account_metadata","id":"07f500c2-f497-44db-9505-7ed6eb76a3af","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":"{\n \"keyspace\": \"dashboard_view\",\n \"metadata\": \"{ \\\"theme_name\\\": \\\"ATLANTIS\\\" }\"\n}"},"url":"{{base_url}}/update_account_metadata","description":"

update_account_metadata

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 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n update_account_metadata\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the account.\n
\n x-api-secret-token\n	\n Request header used for account authentication. \n

\n\n \n \n \n \n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n keyspace\n	\n String used to label the metadata\n
\n metadata\n	\n Arbitrary string of characters\n

\n**Result**\n\n \n \n \n \n \n \n \n \n

\n Fields\n

\n Description\n

\n status\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

","urlObject":{"path":["update_account_metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7465f221-2992-4f38-95aa-a46c82e32c69","name":"Example - update_account_metadata","originalRequest":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{account_secret_token}}","description":"Account Secret Token","type":"text"},{"key":"x-api-access-token","value":"{{account_access_token}}","description":"Account Access Token","type":"text"},{"key":"Content-Type","value":"application/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n \"keyspace\": \"dashboard_view\",\n \"metadata\": \"{ \\\"theme_name\\\": \\\"ATLANTIS\\\" }\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/update_account_metadata"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 03:19:55 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/\"0c776997933eb60833b37beaf43814c8\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=VDQ2U2J1UVplTU5RS09nYXhrdDBOSEZmK3Fac1UveFE1NEJiVUtrQmtqSlBwWkVnVzRjblN1TVB2YWtCeEVESkNWbk5kb3dpWFBNWkZySUU5Z3E3MGc9PS0tTWJnK0NCL1A2aUU2TXZEMG5pWm8xdz09--44dbd68696257d3df96a3df86817822adfcded1b; path=/; HttpOnly"},{"key":"X-Request-Id","value":"b734b879-e34f-445e-80a4-5c95eaf37236"},{"key":"X-Runtime","value":"0.025591"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"07f500c2-f497-44db-9505-7ed6eb76a3af"},{"name":"11. get_account_metadata","id":"892c72bf-31cd-4ca4-afbd-0235a19af36b","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":"{\n \"keyspace\": \"dashboard_view\"\n}"},"url":"{{base_url}}/get_account_metadata","description":"

get_account_metadata

This endpoint can be used to retrieve client-side data that has been previously attached to the account under a specific keyspace.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_account_metadata\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the account.\n
\n x-api-secret-token\n	\n Request header used for account authentication. \n

\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n keyspace\n	\n String identifying which metadata is to be retrieved\n

\n\n

Result

\n\n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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","urlObject":{"path":["get_account_metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"63cc554e-fe95-42ee-bd1a-7861d79f2ef9","name":"Example - get_account_metadata","originalRequest":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{account_secret_token}}","description":"Account Secret Token","type":"text"},{"key":"x-api-access-token","value":"{{account_access_token}}","description":"Account Access Token","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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 03:33:18 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/\"b80a5f8ab65c7c35060242aae650babd\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=d2VwdEVTaGxRZ3MxQWJ6M284Wlc0TlZzR2JFU3hHWGh3MkowVDlXeDcxQmh1Mklxamxkc3pkMjBmbVhNeGRpcjBoSXVPNkVxTHFDUHFhTDFUdHA3VVE9PS0tNENQY2IvaEVkd081eXY4bktSL1JPUT09--08f7f1fe7ff1fadbbe04799b1228c1971d1c7204; path=/; HttpOnly"},{"key":"X-Request-Id","value":"1973907c-611c-485e-995b-9c44d68bc2c1"},{"key":"X-Runtime","value":"0.007270"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"metadata\": \"{ \\\"theme_name\\\": \\\"ATLANTIS\\\" }\"\n}"}],"_postman_id":"892c72bf-31cd-4ca4-afbd-0235a19af36b"},{"name":"12. delete_account_metadata","id":"47413b46-70ff-4282-99f9-ba0a953d1ba5","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

delete_account_metadata

This endpoint can be used to retrieve client-side data that has been previously attached to the account under a specific keyspace.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_account_metadata\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the account.\n
\n x-api-secret-token\n	\n Request header used for account authentication. \n

\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n keyspace\n	\n String identifying which metadata is to be deleted\n

\n\n

Result

\n\n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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","urlObject":{"path":["delete_account_metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"01398f7f-cdb3-489c-84af-ae5f8386e021","name":"Example - delete_account_metadata","originalRequest":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{account_secret_token}}","description":"Account Secret Token","type":"text"},{"key":"x-api-access-token","value":"{{account_access_token}}","description":"Account Access Token","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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 03:28:59 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/\"0c776997933eb60833b37beaf43814c8\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=ZzQwR2gyMnJKY0pFQ0RTTjgxbzlDVEF0ZndVOEZXU0VacG1aMndNZlJrWUJwV0dqQVc1bmp4Wk04Q1hUbkVUOS9mZDBQMUVyT0pwMGxJN3M5OHhCS0E9PS0tb3lxc2hmaHFRSkN1aytvektxTzV3dz09--da96c1a39c7ddb70133e06d1628b53ac9230bb55; path=/; HttpOnly"},{"key":"X-Request-Id","value":"c217ca46-c1c1-4180-8ea4-609557d093b0"},{"key":"X-Runtime","value":"0.022568"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"47413b46-70ff-4282-99f9-ba0a953d1ba5"}],"id":"28cb3261-e3ce-4cc0-9769-fb74259fc0d2","description":"

Sensor Account Credentials Required

The access and secret token strings are formatted as follows:

ACCESS-07DDA579-CE6B-418C-927F-8D2B9A56A91C\nSECRET-2946727A-E8DB-4A79-B598-7F28A2D3182B

\n","_postman_id":"28cb3261-e3ce-4cc0-9769-fb74259fc0d2"},{"name":"Sensor Location API Calls","item":[{"name":"Real Time Visitor","item":[{"name":"Now","item":[{"name":"3. get_location_info","id":"50edc260-39ac-4134-8736-1e6f51d015fb","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_info","description":"

get_location_info

This endpoint returns basic information about a location identified by its access token.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_location_info\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication. \n

\n\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n	\n There are currently no required parameters. Set the JSON request body as an empty hash (i.e. {} )\n

\n\n\n

Result:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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 location_info\n	\n Hash structure holding the information fields about the location\n
\n location_uuid\n	\n Unique ID of the location\n
\n nickname\n	\n Name of the location\n
\n timezone_name\n	\n Name of the time zone\n
\n occupancy_count_flooring_enabled\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 floor_occupancy_count\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 max_occupancy_count\n	\n Maximum occupancy threshold defined for that location\n
\n occupancy_count_alert_enabled\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 sensor_last_connected_at\n	\n Timestamp (in UTC) indicating when the associated sensor sent data to the server for the last time\n
\n subscription_valid_until\n	\n Timestamp (in UTC) indicating until when the sensor subscription is valid\n

\n\n","urlObject":{"path":["get_location_info"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"86135ee0-1d0c-4385-94ee-a7c2ba553ac3","name":"Example - get_location_info","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_info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 02:55:36 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/\"f6cc56b1aefff17b469b4404bfd09d57\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=T3NDMXpnY3kzVi9OUmplK0YrT0Zmd2pCd0dla2M2OXhtVVBMcmFRUEYrWWVCeXdDd3U4Zi9BTk8xRkkwQ2FIOTdtR1o3WDNUZVhiK3JSS3lscElMV0E9PS0tMDVkNitjWUEyclhmcGJ5V3phZEVVQT09--4f7b63c2189715962b4284902110a3c7a2e176a7; path=/; HttpOnly"},{"key":"X-Request-Id","value":"e3ac6aa4-60f3-492f-8844-b3bf0bea61ac"},{"key":"X-Runtime","value":"0.022405"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"location_info\": {\n \"location_uuid\": \"49045C0A-8F62-4F4D-80F5-C53A01C75DD7\",\n \"nickname\": \"L4-Morpheus\",\n \"timezone_name\": \"America/Los_Angeles\",\n \"max_occupancy_count\": 20,\n \"occupancy_count_flooring_enabled\": 0,\n \"floor_occupancy_count\": 0,\n \"occupancy_count_alert_enabled\": 1,\n \"sensor_last_connected_at\": 1614480932,\n \"subscription_valid_until\": 1872860937\n }\n}"}],"_postman_id":"50edc260-39ac-4134-8736-1e6f51d015fb"},{"name":"15. get_location_core_realtime_snapshot","id":"2beaab7b-eb90-4ee5-b527-d2b3a5960e7c","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_core_realtime_snapshot","description":"

get_location_core_realtime_snapshot

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 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_location_core_realtime_snapshot\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication. \n

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n None\n	\n No required parameters. Set the JSON request body as an empty hash (i.e. {} )\n
\n metadata_info_array\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 metadata_info\n	\n Hash defining which keyspace is to be retrieved.\n

\n\n

JSON request examples:

{} (Empty Body)

JSON response example:

{ \"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}}

JSON request example:

{\"metadata_info_array\": [{ \"keyspace\": \"mine\"} ]}

JSON 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}}

Result

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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 location_core_realtime_snapshot\n	\n Hash containing the attributes that form the snapshot\n
\n \n\n location_uuid\n \n \n	\n Unique ID of the location\n
\n \n\n nickname\n \n \n	\n Name of the location\n
\n \n\n timezone_name\n \n \n	\n Name of the time zone\n
\n \n\n max_occupancy_count\n \n \n	\n Maximum occupancy threshold defined for that location\n
\n \n\n occupancy_count_flooring_enabled\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 floor_occupancy_count\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 occupancy_count_alert_enabled\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 subscription_valid_until\n \n \n	\n Timestamp (in UTC) indicating until when the sensor subscription is valid\n
\n \n\n sensor_last_connected_at\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 occupancy_count\n \n \n	\n Real-time occupancy count without flooring compensation\n
\n \n\n metadata_result_array\n \n \n	\n Array of metadata result elements\n
metadata_result\n	\n Hash providing the metadata value corresponding to the specified keyspace\n

\n\n\n","urlObject":{"path":["get_location_core_realtime_snapshot"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6f430978-2a3d-45ba-a202-f76a0be176e0","name":"Example 2 - get_location_core_realtime_snapshot","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":"{\"metadata_info_array\": [{ \"keyspace\": \"timeline_view\"} ]}"},"url":"{{base_url}}/get_location_core_realtime_snapshot"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 08:41:43 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/\"d6d2037a20ccb2ea7ab31da6cc4dfe5b\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=dzRET29SUHpVZThFV2JmaTlqMXdLTEsyU2liZkZhV0RaaE1KeGRxekZsTmFNMkUyRTkvUnZCd3pBMm0vUkh0OXM5NlN6cEdnR0R4b2g3b0VmSW9PZXc9PS0tcXRGM3JObG5NVGM3YU91TTllVEp0Zz09--4a31c204b61dcb5cc1ad7bc0f731c75a59d889ed; path=/; HttpOnly"},{"key":"X-Request-Id","value":"7da4f2d6-b907-48c6-abaa-57f0756cf888"},{"key":"X-Runtime","value":"0.018920"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"location_core_realtime_snapshot\": {\n \"location_uuid\": \"49045C0A-8F62-4F4D-80F5-C53A01C75DD7\",\n \"nickname\": \"L4-Morpheus\",\n \"timezone_name\": \"America/Los_Angeles\",\n \"max_occupancy_count\": 20,\n \"occupancy_count_flooring_enabled\": 0,\n \"floor_occupancy_count\": 0,\n \"occupancy_count_alert_enabled\": 1,\n \"subscription_valid_until\": 1872860937,\n \"sensor_last_connected_at\": 1614501702,\n \"occupancy_count\": 12,\n \"metadata_result_array\": [\n {\n \"keyspace\": \"timeline_view\",\n \"metadata\": \"{ \\\"start_time\\\": \\\"8:00AM\\\", \\\"stop_time\\\": \\\"6:00PM\\\", \\\"color\\\": \\\"blue\\\" }\"\n }\n ]\n }\n}"},{"id":"79a2eac8-7575-4096-b0a5-9b2577590439","name":"Example 1 - get_location_core_realtime_snapshot","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_core_realtime_snapshot"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 08:37:02 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/\"9666cf53db8a21f4047ce91c3bffee83\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=NmZ3ZHFmeHdMV1IrNlQ3L2pDaW1zUjdPQ0R6NEZNNHArNmo1cjl5RStzQ1UyMHpNbnNvQ3paN1I5NWZjYkk4QldBOEFWZUw1QmV2NHRWYUcrSnFHS0E9PS0tT0lWQXFxdU5BSWFkUVRpZ2ZtRTZNQT09--593ba5d783eb9c6b9a2787ded8975ec24e3b8cfb; path=/; HttpOnly"},{"key":"X-Request-Id","value":"eeff47f9-7f35-46d5-a0a4-8780bf4e8dd5"},{"key":"X-Runtime","value":"0.018667"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"location_core_realtime_snapshot\": {\n \"location_uuid\": \"49045C0A-8F62-4F4D-80F5-C53A01C75DD7\",\n \"nickname\": \"L4-Morpheus\",\n \"timezone_name\": \"America/Los_Angeles\",\n \"max_occupancy_count\": 20,\n \"occupancy_count_flooring_enabled\": 0,\n \"floor_occupancy_count\": 0,\n \"occupancy_count_alert_enabled\": 1,\n \"subscription_valid_until\": 1872860937,\n \"sensor_last_connected_at\": 1614501417,\n \"occupancy_count\": 11,\n \"metadata_result_array\": []\n }\n}"}],"_postman_id":"2beaab7b-eb90-4ee5-b527-d2b3a5960e7c"},{"name":"16. get_location_core_realtime_snapshot_array","id":"a9697ad9-f7ec-47bb-895a-54d6dcb4118a","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_core_realtime_snapshot_array","description":"

get_location_core_realtime_snapshot_array

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:

get_location_info,\n get_location_realtime_occupancy_count, and\n Get_location_metadata.

Note: The request supports returning the data for as many as 16 locations corresponding to the location authorization tokens.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_location_core_realtime_snapshot_array\n
\n Content-Type\n	\n application/plain\n

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n location_stipulation_array\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 location_stipulation\n	\n Hash identifying the attributes of each location to be retrieved\n
\n access_token\n	\n String identifying the location\n
\n secret_token\n	\n String needed to authenticate the access right\n
\n metadata_info_array\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 metadata_info\n	\n Hash defining which keyspace is to be retrieved.\n

\n\n

JSON request example:

        { \"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        }\n

JSON response example:

        { \"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        }\n

Result

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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 location_result_array\n	\n Array of location result elements\n
\n location_result\n	Hash 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

","urlObject":{"path":["get_location_core_realtime_snapshot_array"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9697ad9-f7ec-47bb-895a-54d6dcb4118a"},{"name":"4. get_location_realtime_occupancy_count","id":"a66a3c0c-9581-427c-bb5d-22a714a85504","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":"

get_location_realtime_occupancy_count

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 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_location_realtime_occupancy_count\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication. \n

\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n	\n No required parameters. Set the JSON request body as an empty hash (i.e. {} )\n

**Result**\n\n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
status\n	Request 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 occupancy_count\n	\n Real-time occupancy count without flooring compensation\n
\n occupancy_count_flooring_enabled\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 floor_occupancy_count\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 sensor_last_connected_at\n	\n Timestamp (in UTC) indicating when the associated sensor sent data to the server for the last time\n

","urlObject":{"path":["get_location_realtime_occupancy_count"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3d9ddfcd-106c-44b8-aca6-a6bae47e6b78","name":"Example - get_location_realtime_occupancy_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_occupancy_count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 03:32:44 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/\"0efa9975b183225765d2fc01c56abc5b\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"ab301de9-0a7e-48b1-a47a-dc4162a2cc8b"},{"key":"X-Runtime","value":"0.031764"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"occupancy_count\": 15,\n \"occupancy_count_flooring_enabled\": 0,\n \"floor_occupancy_count\": 0,\n \"sensor_last_connected_at\": 1614310362\n}"}],"_postman_id":"a66a3c0c-9581-427c-bb5d-22a714a85504"},{"name":"6. get_location_realtime_occupancy_load","id":"3f1eefd9-fea9-4aa9-972f-24d7f6097ba3","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_load","description":"

get_location_realtime_occupancy_load

This 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 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_location_realtime_occupancy_load\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication. \n

\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n	\n No required parameters. Set the JSON request body as an empty hash (i.e. {} )\n

\n\n

Result

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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 occupancy_load\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 sensor_last_connected_at\n	\n Timestamp (in UTC) indicating when the associated sensor sent data to the server for the last time\n

","urlObject":{"path":["get_location_realtime_occupancy_load"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"26d2dbc6-10e9-4c7d-a343-2123b42ac2c9","name":"Example - get_location_realtime_occupancy_load","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_occupancy_load"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 Feb 2021 23:45:51 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/\"7edd48b50d3d121c81f854e01026a13e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"9802ca12-cd9a-4390-b07c-b14a274a4921"},{"key":"X-Runtime","value":"0.021821"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"occupancy_load\": \"LOW\",\n \"sensor_last_connected_at\": 1614469547\n}"}],"_postman_id":"3f1eefd9-fea9-4aa9-972f-24d7f6097ba3"},{"name":"7. get_location_realtime_cumulative_count","id":"d08ab4b2-2762-46cd-a01c-75275f9aa34d","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_cumulative_count","urlObject":{"path":["get_location_realtime_cumulative_count"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7baa7c33-38fa-464c-8128-8e8da7317767","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":"d08ab4b2-2762-46cd-a01c-75275f9aa34d"}],"id":"2dcc8141-b83e-42c8-9009-42231371d2f2","_postman_id":"2dcc8141-b83e-42c8-9009-42231371d2f2","description":""},{"name":"Occupancy History","item":[{"name":"5. get_location_historical_occupancy_counts","id":"7ca3f0ee-adfe-415b-a764-619e98931a22","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":"

get_location_historical_occupancy_counts

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\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\nRequest\n	\nDescription\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_location_historical_occupancy_counts\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication.\n

\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n day_span\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

Results

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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 occupancy_count_flooring_enabled\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 floor_occupancy_count\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 occupancy_count_slots\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 actual_day_span\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","urlObject":{"path":["get_location_historical_occupancy_counts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"734ef419-38aa-4915-8af5-dba83464c475","name":"Example - get_location_historical_occupancy_counts","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":"{\"day_span\": 0}"},"url":"{{base_url}}/get_location_historical_occupancy_counts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 Feb 2021 23:50:03 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/\"5ca16c4ad9ce1dc15b7a5d776a8761c5\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"82ebfea1-bd8e-4cdb-8322-d580738a9eab"},{"key":"X-Runtime","value":"0.023743"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"occupancy_count_flooring_enabled\": 0,\n \"floor_occupancy_count\": 0,\n \"occupancy_count_slots\": [\n [\n 1614412800,\n 1614413699,\n 10,\n 14\n ],\n [\n 1614413700,\n 1614414599,\n 10,\n 14\n ],\n [\n 1614414600,\n 1614415499,\n 8,\n 13\n ],\n [\n 1614415500,\n 1614416399,\n 9,\n 13\n ],\n [\n 1614416400,\n 1614417299,\n 8,\n 14\n ],\n [\n 1614417300,\n 1614418199,\n 8,\n 16\n ],\n [\n 1614418200,\n 1614419099,\n 9,\n 15\n ],\n [\n 1614419100,\n 1614419999,\n 12,\n 15\n ],\n [\n 1614420000,\n 1614420899,\n 9,\n 14\n ],\n [\n 1614420900,\n 1614421799,\n 10,\n 14\n ],\n [\n 1614421800,\n 1614422699,\n 12,\n 14\n ],\n [\n 1614422700,\n 1614423599,\n 11,\n 17\n ],\n [\n 1614423600,\n 1614424499,\n 8,\n 13\n ],\n [\n 1614424500,\n 1614425399,\n 10,\n 12\n ],\n [\n 1614425400,\n 1614426299,\n 8,\n 12\n ],\n [\n 1614426300,\n 1614427199,\n 7,\n 11\n ],\n [\n 1614427200,\n 1614428099,\n 7,\n 12\n ],\n [\n 1614428100,\n 1614428999,\n 9,\n 12\n ],\n [\n 1614429000,\n 1614429899,\n 9,\n 15\n ],\n [\n 1614429900,\n 1614430799,\n 8,\n 15\n ],\n [\n 1614430800,\n 1614431699,\n 8,\n 14\n ],\n [\n 1614431700,\n 1614432599,\n 10,\n 13\n ],\n [\n 1614432600,\n 1614433499,\n 11,\n 14\n ],\n [\n 1614433500,\n 1614434399,\n 9,\n 14\n ],\n [\n 1614434400,\n 1614435299,\n 10,\n 13\n ],\n [\n 1614435300,\n 1614436199,\n 11,\n 14\n ],\n [\n 1614436200,\n 1614437099,\n 12,\n 16\n ],\n [\n 1614437100,\n 1614437999,\n 10,\n 14\n ],\n [\n 1614438000,\n 1614438899,\n 11,\n 15\n ],\n [\n 1614438900,\n 1614439799,\n 11,\n 16\n ],\n [\n 1614439800,\n 1614440699,\n 9,\n 13\n ],\n [\n 1614440700,\n 1614441599,\n 11,\n 15\n ],\n [\n 1614441600,\n 1614442499,\n 12,\n 17\n ],\n [\n 1614442500,\n 1614443399,\n 10,\n 14\n ],\n [\n 1614443400,\n 1614444299,\n 12,\n 19\n ],\n [\n 1614444300,\n 1614445199,\n 12,\n 18\n ],\n [\n 1614445200,\n 1614446099,\n 15,\n 21\n ],\n [\n 1614446100,\n 1614446999,\n 9,\n 17\n ],\n [\n 1614447000,\n 1614447899,\n 10,\n 13\n ],\n [\n 1614447900,\n 1614448799,\n 11,\n 15\n ],\n [\n 1614448800,\n 1614449699,\n 11,\n 16\n ],\n [\n 1614449700,\n 1614450599,\n 11,\n 17\n ],\n [\n 1614450600,\n 1614451499,\n 9,\n 16\n ],\n [\n 1614451500,\n 1614452399,\n 11,\n 15\n ],\n [\n 1614452400,\n 1614453299,\n 10,\n 15\n ],\n [\n 1614453300,\n 1614454199,\n 12,\n 16\n ],\n [\n 1614454200,\n 1614455099,\n 12,\n 17\n ],\n [\n 1614455100,\n 1614455999,\n 12,\n 15\n ],\n [\n 1614456000,\n 1614456899,\n 10,\n 14\n ],\n [\n 1614456900,\n 1614457799,\n 10,\n 13\n ],\n [\n 1614457800,\n 1614458699,\n 9,\n 13\n ],\n [\n 1614458700,\n 1614459599,\n 10,\n 15\n ],\n [\n 1614459600,\n 1614460499,\n 7,\n 12\n ],\n [\n 1614460500,\n 1614461399,\n 6,\n 11\n ],\n [\n 1614461400,\n 1614462299,\n 8,\n 12\n ],\n [\n 1614462300,\n 1614463199,\n 7,\n 10\n ],\n [\n 1614463200,\n 1614464099,\n 7,\n 16\n ],\n [\n 1614464100,\n 1614464999,\n 8,\n 12\n ],\n [\n 1614465000,\n 1614465899,\n 8,\n 13\n ],\n [\n 1614465900,\n 1614466799,\n 7,\n 11\n ],\n [\n 1614466800,\n 1614467699,\n 9,\n 13\n ],\n [\n 1614467700,\n 1614468599,\n 9,\n 16\n ],\n [\n 1614468600,\n 1614469499,\n 13,\n 18\n ],\n [\n 1614469500,\n 1614470399,\n 12,\n 13\n ]\n ],\n \"actual_day_span\": 0\n}"}],"_postman_id":"7ca3f0ee-adfe-415b-a764-619e98931a22"}],"id":"2c2ea044-1e28-490b-9fc4-365a8696b36a","_postman_id":"2c2ea044-1e28-490b-9fc4-365a8696b36a","description":""},{"name":"Settings","item":[{"name":"8. update_location_max_occupancy_count","id":"805ab76e-f263-471b-bd84-cfb618c263a3","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}}/update_location_max_occupancy_count","description":"

update_location_max_occupancy_count

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\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\nRequest\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n update_location_max_occupancy_count\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication. \n

\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n max_occupancy_count\n	\n Integer value representing the new maximum occupancy count threshold to be used for that location. \n

\n\n

Result

\n\n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
status\n	Request 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","urlObject":{"path":["update_location_max_occupancy_count"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"09c8a1ee-30eb-47bb-a162-be6e736d79be","name":"Example - update_location_max_occupancy_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":"{\"max_occupancy_count\": 20}"},"url":"{{base_url}}/update_location_max_occupancy_count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 01:21:56 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/\"0c776997933eb60833b37beaf43814c8\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"bf8b120b-b43a-4b65-9248-7f42bb195b59"},{"key":"X-Runtime","value":"0.068753"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"805ab76e-f263-471b-bd84-cfb618c263a3"}],"id":"460226bc-3e9c-47f8-bc83-3780211e426e","_postman_id":"460226bc-3e9c-47f8-bc83-3780211e426e","description":""}],"id":"78164d83-b015-4649-b76b-dd4988b4e16e","_postman_id":"78164d83-b015-4649-b76b-dd4988b4e16e","description":""},{"name":"Location Metadata","item":[{"name":"12. update_location_metadata","id":"9aee8354-bba9-44ef-b062-8e6fe4010ae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"

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":"

update_location_metadata

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.

The maximum number of keyspaces is currently limited to 32.

The maximum length of each metadata string is currently limited to 5KB.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n update_location_metadata\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication. \n

\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n keyspace\n	\n String used to label the metadata\n
\n metadata\n	\n Arbitrary string of characters\n

\n\n

Result

\n\n \n \n \n \n \n \n \n \n

\n Fields\n

\n Description\n

\n status\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

","urlObject":{"path":["update_location_metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6a088ebd-0865-43ee-9429-3a72ed60a0d4","name":"Examplle - update_location_metadata","originalRequest":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"Account Secret Token","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Account Access Token","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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 06:13:03 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/\"0c776997933eb60833b37beaf43814c8\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=a3ZNQmI5OUlTclowSTRUUmZaQmk1VFhYcUxNek91My91QnhHcUl4eWZZejNlbzFaM2pTclp5OUpiLytGR2ROeWlMUEhxUHdHemU3T3ZFMkwvaWdHZ3c9PS0tQ2s5TmJYMHhvdGdkV05wN2V1NnE1Zz09--ce14750b727e7ff21c31f4f1fa79d489d5c4f2a3; path=/; HttpOnly"},{"key":"X-Request-Id","value":"233ab6a4-1501-4f89-9e4d-d76bb2b21c2a"},{"key":"X-Runtime","value":"0.018768"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"9aee8354-bba9-44ef-b062-8e6fe4010ae1"},{"name":"13. get_location_metadata","id":"6db45eb0-e50b-4bb3-ae92-acad40f97cda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"

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":"

get_location_metadata

This endpoint can be used to retrieve client-side data that has been previously attached to the location under a specific keyspace.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_location_metadata\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication. \n

\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n keyspace\n	\n String identifying which metadata is to be retrieved\n

\n\n

Result

\n\n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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

","urlObject":{"path":["get_location_metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"34d733ce-d59e-401f-a6c5-f6a0d4acba92","name":"Example - get_location_metadata","originalRequest":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"Account Secret Token","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Account Access Token","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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 06:18:46 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/\"1d994aa6d81c388bd8daf3fe6be9f826\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=WkY5R1czTE1XcjhKdWNkc0prRmQzNVI4S2FFaEptREJVd0NEZVc2ZVVpRzl5dENyWUxid2xvYkRyNUlXeEJqcFN5eWIrMjJzUExIcDVWb1d5WG9rUUE9PS0tbitucEphemxVQlVBOG9CczdVRW04dz09--0ef7a62ba629bf13362db08c49731f708fed63c6; path=/; HttpOnly"},{"key":"X-Request-Id","value":"dba0bd07-bb25-4e20-81bc-222aae2ab1e0"},{"key":"X-Runtime","value":"0.010104"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"metadata\": \"{ \\\"start_time\\\": \\\"8:00AM\\\", \\\"stop_time\\\": \\\"6:00PM\\\", \\\"color\\\": \\\"blue\\\" }\"\n}"}],"_postman_id":"6db45eb0-e50b-4bb3-ae92-acad40f97cda"},{"name":"14. delete_location_metadata","id":"a29e18a6-6e81-4468-b29c-96696c11716c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"

Account Secret Token

\n","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"

Account Access Token

delete_location_metadata

This endpoint can be used to retrieve client-side data that has been previously attached to the location under a specific keyspace.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n POST\n
\n Endpoint\n	\n get_location_metadata\n
\n Content-Type\n	\n application/plain\n
\n x-api-access-token\n	\n Request header used to identify the location.\n
\n x-api-secret-token\n	\n Request header used for location authentication. \n

\n\n \n \n \n \n \n \n \n \n

\n JSON Request Body\n	\n Description\n
\n keyspace\n	\n String identifying which metadata is to be deleted.\n

\n\n

Result

\n\n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\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","urlObject":{"path":["delete_location_metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3abdcbeb-1df0-4e85-ad46-e85a3f4a1dab","name":"Example - delete_location_metadata","originalRequest":{"method":"POST","header":[{"key":"x-api-secret-token","value":"{{secret_token}}","description":"Account Secret Token","type":"text"},{"key":"x-api-access-token","value":"{{access_token}}","description":"Account Access Token","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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 06:21:05 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/\"0c776997933eb60833b37beaf43814c8\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_athena_cloud_session=M0p5M1c4bnQ5M2VBWTZsV3NwUmRaZnBKN0pJNHJVZGFrd2N6T1ZGS2NWV1A0Y0llL3ovbzZaSDNiT3h4S2ZsSVVuNDd5VElxNURKdDNsa1V5bDg3c3c9PS0talQ3S2hMUEpDbkdVRVdoaWdDZDRYUT09--14397a9fa6557a69a2c071a1959013acfa1cd0c9; path=/; HttpOnly"},{"key":"X-Request-Id","value":"c268f288-7f94-4584-b9e1-0cf9d5969c08"},{"key":"X-Runtime","value":"0.016521"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"a29e18a6-6e81-4468-b29c-96696c11716c"}],"id":"963271fd-fab6-4b6a-8b5a-a2106bc5ca2f","_postman_id":"963271fd-fab6-4b6a-8b5a-a2106bc5ca2f","description":""}],"id":"50219cfd-fdfc-469d-8485-95da1d4489c7","description":"

Sensor Location Credentials Required

The access and secret token strings are formatted as follows:

ACCESS-07DDA579-CE6B-418C-927F-8D2B9A56A91C\nSECRET-2946727A-E8DB-4A79-B598-7F28A2D3182B

\n","_postman_id":"50219cfd-fdfc-469d-8485-95da1d4489c7"},{"name":"Server Status","item":[{"name":"1. Ping","id":"76445ac9-79d3-4c50-8325-a0e65872bf36","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":"

ping

This endpoint can be used to check the availability of the Bluefox Fetch API.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n

\n Request\n	\n Description\n
\n HTTP Method\n	\n GET\n
\n Endpoint\n	\n ping\n

\n\n\n

Result

\n\n \n \n \n \n \n \n \n \n

\n Fields\n	\n Description\n
\n status\n	\nRequest status, possible values are:\n“OK”\n“API_ACCESS_DISABLED”\n

\n","urlObject":{"path":["get_location_realtime_occupancy_count"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0170c628-4750-4e6b-aadd-bc839947abe2","name":"Example - Ping","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/ping"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Feb 2021 02:09:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"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/\"0c776997933eb60833b37beaf43814c8\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"59742f6e-5716-4d4d-a730-84116cb42ee2"},{"key":"X-Runtime","value":"0.002450"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"76445ac9-79d3-4c50-8325-a0e65872bf36"}],"id":"9770b9b2-6ed6-4584-aad4-e2424e09d953","_postman_id":"9770b9b2-6ed6-4584-aad4-e2424e09d953","description":""}]}