{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"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**\nThe 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.\n\n## **Changes in This Release**\nReduced API set to match Party Squasher Pro Use Cases.\n\n# Service Summary\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.\n\nThe full API includes the following main services:\n*\tGet location information (e.g. location name, max occupancy count)\n*\tGet the real-time occupancy count at a given location\n*\tGet the occupancy count history at given location (e.g. for last 2 days)\n*\tGet the real-time occupancy load (e.g. High & Low load)\n*\tGet the real-time cumulative count (i.e. visit counter)\n*\tChange a location’s max occupancy count threshold\n\n## **Access Credentials**\nAccess 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:\n\n* location-level credentials\n* account-level credentials\n\nEach type has separate authentication credentials.\n\nIn both cases the access and secret token strings are formatted as follows:\n\nACCESS-07DDA579-CE6B-418C-927F-8D2B9A56A91C\n\nSECRET-2946727A-E8DB-4A79-B598-7F28A2D3182B\n\nSeparate 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 \n
Product\n Management Console Access\n
Party Squasher\n http://apollo-psq.bluefoxengage.com/login\n
\n\n|Index|Party Squasher Fetch API Definitions |\n|-----|---------------------------------------------------------------------|\n|1 |ping |\n|2 |get_account_info |\n|3 |get_location_info |\n|4 |get_location_realtime_occupancy_count |\n|5 |get_location_historical_occupancy_counts |\n|6 |get_location_realtime_occupancy_load |\n|7 |get_location_realtime_cumulative_count |\n|8 |update_location_max_occupancy_count |\n|9 |update_account_metadata |\n|10 |get_account_metadata |\n|11 |delete_account_metadata |\n|12 |update_location_metadata |\n|13 |get_location_metadata |\n|14 |delete_location_metadata |\n|15 |get_location_core_realtime_snapshot |\n|16 |get_location_core_realtime_snapshot_array |\n\n# Party Squasher Fetch API Use\n\nThe 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 \n
Region\n API Base URL\n
Party Squasher)\n https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100\n
\n\n\nTo form the full request URL for a given endpoint (see available endpoints below), simply append the endpoint name to the base URL.\n\nExample:\n\n[Base API URL]\n\n[https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100](https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100)\n\n[Full Request URL]\n\n [https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100/get_location_realtime_occupancy_count](https://apollo-psq.bluefoxengage.com/third_party_fetch_api/v100/get_location_realtime_occupancy_count)\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
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14323059","team":1619545,"collectionId":"d3366357-8d5d-431b-90c9-a149523c7dcd","publishedId":"TzRLmAae","public":true,"publicUrl":"https://api.partysquasher.com","privateUrl":"https://go.postman.co/documentation/14323059-d3366357-8d5d-431b-90c9-a149523c7dcd","customColor":{"top-bar":"399EBF","right-sidebar":"FFF","highlight":"EE2979"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-05-03T21:12:57.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/cb49d14a4bc9f36556ac3812175e91b92101671f35f99b5ee6b4c040b170901b","favicon":"https://res.cloudinary.com/postman/image/upload/v1614973903/team/xuwhaycpke6rmy6mtiyo.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.partysquasher.com/view/metadata/TzRLmAae"}