{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7cbabdde-dd15-404b-92d5-a003dcdfd76b","name":"MobileScapes API","description":"# Version History\n\n| **Versions** | **Descriptions** |\n| --- | --- |\n| v2 | Add new report type **geofencepings** report; Add new parameter **aggregatePolygonName** to change the polygon name when aggregating geofences; In path variables, include support for the country code **us**; In the **appendSegmentation**, add **prizmpremier**, **connexions**, and **psyclepremier** for US requests. |\n| v4 (current) | New MobileScapes data and methodology. High-precision consent-based SDK data has been enhanced with geo-location data from phones on the cellular network improving the accuracy of foot traffic estimates. Removal of Worker, Worker Visit, Resident, Resident Visit, Total and Total Visit fields in output data extract. |\n\n# Overview\n\nEnvironics Analytics APIs are REST APIs that use standard HTTP authentication, verbs, and response codes. Data is usually transferred in JSON format and large output files are stored in cloud-based storage for user access.\n\n# Authentication\n\nAll Environics Analytics APIs use OpenID Connect to authorize clients. Standard `Authorization` HTTP header is used to provide JWT token to API to authenticate user requests.\n\nAll request details and output files are available only to the user that created the request.\n\n# Errors\n\nEnvironics Analytics APIs use conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the `2xx` range indicate success. Codes in the `4xx` range indicate an error that was caused by invalid request details (e.g. invalid request body or invalid request id). `5xx` range indicates an error with Environics Analytics servers or services.\n\nWhen the request returns `400 BadRequest` status code the response usually contains additional error codes to help identify what went wrong with the request.\n\nERROR CODES\n\n---\n\n01\n\nServiceUnavailable\n\n<p>This service is currently unavailable.</p>\n\n02\n\nInvalidJson\n\n<p>Request body is not a valid JSON object.</p>\n\n03\n\nMissingOrInvalidValue\n\n<p>The value is either empty or invalid.</p>\n\n04\n\nInvalidDateTimeFormat\n\n<p>DateTime field has invalid format. Please see the request details on the proper DateTime format.</p>\n\n05\n\nInvalidDate\n\n<p>DateTime field contains invalid date or time value, or the value is out of range.</p>\n\n06\n\nRequiredFieldIsMissing\n\n<p>Required field is missing in the request.</p>\n\n07\n\nInvalidPolygon\n\n<p>Polygon representation is invalid or polygon type is not supported.</p>\n\n08\n\nInvalidStringFormat\n\n<p>String field doesn't comply to the specified format.</p>\n\n09\n\nDuplicateValues\n\n<p>Duplicates found among values that are required to be unique.</p>\n\n10\n\nInvalidType\n\n<p>The field has data of invalid type.</p>\n\n11\n\nInvalidDates\n\n<p>Relation between two or more DateTime fields is invalid.</p>\n\n12\n\nGeofenceTooBig\n\n<p>Provided polygon exceeds the set limit.</p>\n\n13\n\nUnknownParameter\n\n<p>Unexpected parameter name found in the request body.</p>\n\n14\n\nArraySizeTooBig\n\n<p>Array size is too big.</p>\n\n15\n\nInvalidCombination\n\n<p>Invalid combination selected for parameter values.</p>\n\n<blockquote>&nbsp;&nbsp;<i>&gt; Combination - </i>reportType: <b>celcdl</b> and pingFilter: <b>none</b><br>The pingFilter selected is not applicable for this context.</blockquote>\n\n# Rate limits\n\nTo help maintain Environics Analytics API stability each API implements its own limits on the number of requests that can be made. Users who send many requests within a short period of time might get an error response with status code `429`. The details of the error response may vary by API.\n\n# Contact\n\nIf you have any API related questions or require technical support please contact our support team at\n\n<a href=\"mailto:support@environicsanalytics.com\">support@environicsanalytics.com</a>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17783045","team":1126699,"collectionId":"7cbabdde-dd15-404b-92d5-a003dcdfd76b","publishedId":"2s93sZ5tp6","public":true,"publicUrl":"https://developers.mobilescapes.environicsanalytics.com","privateUrl":"https://go.postman.co/documentation/17783045-7cbabdde-dd15-404b-92d5-a003dcdfd76b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-06-16T02:08:43.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/bda960d63e732741d7bc6df8ce47c1bba079c462992e120f7e245ede3a68fb82","favicon":"https://res.cloudinary.com/postman/image/upload/v1605715660/team/xuyzb8z5oitg8blzpdmp.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://developers.mobilescapes.environicsanalytics.com/view/metadata/2s93sZ5tp6"}