{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d454ee58-6823-438c-bdbe-13c3c7022e6c","name":"Frogmi Public API","description":"<img src=\"https://s3.amazonaws.com/neofrogmi-web-production/assets-email/logo-email-frogmi.png\" alt=\"Frogmi Developer API Documentation\">\n\nWelcome to Frogmi's API.\n\n# API Keys\n\nYou'll need your API keys, so go to `Company Setup` - `API` on [https://neo.frogmi.com](https://neo.frogmi.com) if you don't have it.\n\nThink of your token as a password:\n\n- Store it securely\n    \n- Don't share it with anyone outside of your organization.\n    \n- Don't put it in any code on your website or in a Url that someone could find.\n    \n\nThis API is using [jsonapi 1.0](http://jsonapi.org/format/1.0/) to format response.\n\n# Environments\n\n| Environment | API Base Url | Web App Url |\n| --- | --- | --- |\n| Sandbox | [https://api-staging.frogmi.com/](https://api-staging.frogmi.com/) | [https://neo-staging.frogmi.com](https://neo-staging.frogmi.com) |\n| Production | [https://api.frogmi.com/](https://api.frogmi.com/) | [https://neo.frogmi.com/](https://neo.frogmi.com/) |\n\nNotes:\n\n- Your platform will have separate API keys for each environment.\n    \n- Data created or modified in each environment will not affect the other.\n    \n- Data cannot be transfered from one environment to the other.\n    \n\n## Parameters\n\n#### Filtering\n\nAllows to delimit and/or specify the wich results are expected considering the information provided.\n\n| required | Name | Type | Description |\n| --- | --- | --- | --- |\n| yes | `period` | Hash |  |\n| yes | `period.from` | DateTime | Period from considering ISO-8601 |\n| yes | `period.to` | DateTime | Period to considering ISO-8601 |\n| no | `stores` | Array\\[String\\] | Array with activity UUID |\n| no | `users` | Array\\[String\\] | Array with user UUID |\n| no | `zones` | Array\\[String\\] | Array with zone UUID |\n| no | `brands` | Array\\[String\\] | Array with brand UUID |\n\n```\n{\n  \"filters\": {\n    \"period\": {\n      \"from\": \"2018-08-01T12:00:00-04:00\",\n      \"to\": \"2018-08-02T12:00:00-04:00\"\n    },\n    \"stores\": [\n      \"4df5b05b-3da4-4f3f-9ff3-d74841dc8f03\",\n      \"dc7d8890-e2a7-4896-8b38-1c731ed03261\"\n    ]\n  }\n}\n\n ```\n\n#### Pagination\n\nAllows to specify the how to paginate the results. Please consider as limit for `per_page`: 1000 results.\n\n| required | Name | Type | Description |\n| --- | --- | --- | --- |\n| yes | `pagination` | Hash |  |\n| yes | `pagination.page` | Integer | Current page |\n| yes | `pagination.per_page` | Integer | Amount of results per page |\n\nMost of endpoints will have a `pagination` with info about how to access to next batch info.\n\n```\n\"pagination\": {\n    \"current_page\": 1,\n    \"total\": 100,\n    \"next_uri\": \"/api/v3/store_beat/activities?page=2\",\n    \"prev_uri\": null\n}\n\n ```\n\n# Questions/Comments/Suggestions\n\nIf you have any questions or comments, please let us know at [apisupport@frogmi.com](https://mailto:apisupport@frogmi.com).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1146776","collectionId":"d454ee58-6823-438c-bdbe-13c3c7022e6c","publishedId":"RWTrPH5C","public":true,"publicUrl":"https://apidoc.frogmi.com","privateUrl":"https://go.postman.co/documentation/1146776-d454ee58-6823-438c-bdbe-13c3c7022e6c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-10-04T19:37:38.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"API V3","id":"2658282e-74d4-4720-a377-ac3712a8b62f","owner":"1146776","values":[{"key":"API_HOST","value":"https://api.frogmi.com","enabled":true},{"key":"company_uuid","value":"","enabled":true},{"key":"auth_token","value":"","enabled":true},{"key":"postman_api","value":"","enabled":true},{"key":"event_uuid","value":"","enabled":true},{"key":"activity_uuid","value":"uuid","enabled":true},{"key":"tag_uuid","value":"","enabled":true},{"key":"place_uuid","value":"","enabled":true},{"key":"user_uuid","value":"","enabled":true},{"key":"routine_uuid","value":"","enabled":true},{"key":"question_uuid","value":"","enabled":true},{"key":"store_uuid","value":"","enabled":true},{"key":"CS_HOST","value":"","enabled":false},{"key":"time","value":"","enabled":true},{"key":"frogmi_username","value":"","enabled":true},{"key":"frogmi_password","value":"","enabled":true},{"key":"frogmi_server","value":"","enabled":true},{"key":"ticket_from","value":"","enabled":true},{"key":"ticket_to","value":"","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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://frogmi.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":"API V3","value":"1146776-2658282e-74d4-4720-a377-ac3712a8b62f"}],"canonicalUrl":"https://apidoc.frogmi.com/view/metadata/RWTrPH5C"}