{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"76d2bf0d-fd5c-6e80-1f6c-08d20f7daed7","name":"Tapway Data Public API's","description":"# Common API Parameters\n\nMost of API methods have following common parameters:\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
ParameterDescription
venue_idVenue (location) id
node_idOptional, node id
floor_idOptional, floor id
aggregateDefault 1 (yes), whether to aggregate data from multiple nodes
startStart date
endEnd date
access tokenAPI access token
\n\nThe **venue_id** id parameter is a part of the url path, for example:\n\n```json\nGET http://data.gotapway.com/data/venue/20/summary?start=2015-04-01&end=2015-04-03&access_token=xxx\n```\n\nHere `20` in `/data/venue/20` is venue id.\n\nA venue can have multiple access points (nodes), so all methods with `venue` parameter return summary data for the specified venue.\n\nAll such methods also have a optional **floor\\_id** and **node\\_id** parameters.\n\nUsing these parameters it is possible to request data for specific nodes.\nUse **floor\\_id** to get nodes belonging to this floor only, for example:\n\n```json\nGET http://data.gotapway.com/data/venue/20/summary?floor_id=29&start=2015-04-01&end=2015-04-03&access_token=xxx\n```\n\nUse **node\\_id** to get single node data (it is passed in the path part of the URL, after the method name), for example:\n\n```json\nGET http://data.gotapway.com/data/venue/20/summary/33?start=2015-04-01&end=2015-04-03&access_token=xxx\n```\n\nHere `33` should be a registered WiFi node ID which belongs to the specified venue.\n\nWhen data is requested without **node\\_id** parameter, the data from multiple nodes is aggregated.\nFor example, query like this will return summary data for all venue nodes:\n\n```json\nGET http://data.gotapway.com/data/venue/20/walkby?start=2015-04-01&end=2015-04-03&access_token=xxx\n```\n\nThe result will be like this:\n\n```json\n{\n \"start\": \"2015-04-01\",\n \"end\": \"2015-04-03\",\n \"data\": {\n \"walkbys_by_day\": {\n \"2015-04-01\": 2,\n \"2015-04-02\": 2,\n \"2015-04-03\": 2\n },\n \"total_walkbys\": 6\n }\n}\n```\n\nTo get the data for each individual node, add **aggregate=0** parameter to the request:\n\n```json\nGET http://data.gotapway.com/data/venue/20/walkby?start=2015-04-01&end=2015-04-03&aggregate=0&access_token=xxx\n```\n\nThe data will look like this:\n\n```json\n{\n \"start\": \"2015-04-01\",\n \"end\": \"2015-04-03\",\n \"data\": {\n \"AMAC1\": {\n \"walkbys_by_day\": {\n \"2015-04-01\": 1,\n \"2015-04-02\": 1,\n \"2015-04-03\": 1\n },\n \"total_walkbys\": 3\n },\n \"AMAC2\": {\n \"walkbys_by_day\": {\n \"2015-04-01\": 1,\n \"2015-04-02\": 1,\n \"2015-04-03\": 1\n },\n \"total_walkbys\": 3\n }\n }\n}\n```\n\n**start** and **end** parameters specify the period of time to get the data.\nParameters accept date string in one of following formats:\n\n* Date - %Y-%m-%d, like 2015-04-05\n* Date and time - %Y-%m-%dT%H:%M:%S, like 2015-04-05T12:20:25","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"393794","team":49020,"collectionId":"76d2bf0d-fd5c-6e80-1f6c-08d20f7daed7","publishedId":"RVuAARwe","public":true,"publicUrl":"https://doc.gotapway.com","privateUrl":"https://go.postman.co/documentation/393794-76d2bf0d-fd5c-6e80-1f6c-08d20f7daed7","customColor":{"top-bar":"FFFFFF","right-sidebar":"3F51B5","highlight":"EF6C00"},"documentationLayout":"classic-double-column","version":"8.11.9","publishDate":"2018-04-16T04:44:11.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Data Backend Public Environment","id":"0dbda65e-f166-47be-a845-3dc3b892fcb2","owner":"393794","values":[{"key":"base_url","value":"data.gotapway.com","enabled":true},{"key":"access_token","value":"","enabled":true},{"key":"company_id","value":"","enabled":true},{"key":"venue_id","value":"","enabled":true},{"key":"node_id_wifi","value":"","enabled":true},{"key":"node_id_brickstream","value":"","enabled":true},{"key":"floor_id","value":"","enabled":true},{"key":"location_server","value":"","enabled":true},{"key":"username","value":"","enabled":true},{"key":"password","value":"","enabled":true},{"key":"start","value":"","enabled":true},{"key":"end","value":"","enabled":true},{"key":"aggregate","value":"","enabled":true},{"key":"authorization","value":"","enabled":true},{"key":"profile_id","value":"","enabled":true},{"key":"client_mac","value":"","enabled":true},{"key":"email","value":"","enabled":true},{"key":"phone","value":"","enabled":true},{"key":"zone_id","value":"","enabled":true},{"key":"server_id","value":"","enabled":true},{"key":"ap_mac","value":"","enabled":true},{"key":"filter_by_node_id","value":"","enabled":true},{"key":"ssid","value":"","description":"","type":"text","enabled":true},{"key":"ssid_id","value":"","description":"","type":"text","enabled":true}],"published":true}],"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/580f666fabb944486da79b0374477461c17f8b680e7750c2f383da693c41e177","favicon":"https://gotapway.com/favicon.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"},{"label":"Data Backend Public Environment","value":"393794-0dbda65e-f166-47be-a845-3dc3b892fcb2"}],"canonicalUrl":"https://doc.gotapway.com/view/metadata/RVuAARwe"}