Environics 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.
\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.
All request details and output files are available only to the user that created the request.
\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.
When the request returns 400 BadRequest status code the response usually contains additional error codes to help identify what went wrong with the request.
ERROR CODES
\n01
\nServiceUnavailable
\nThis service is currently unavailable.
\n\n02
\nInvalidJson
\nRequest body is not a valid JSON object.
\n\n03
\nMissingOrInvalidValue
\nThe value is either empty or invalid.
\n\n04
\nInvalidDateTimeFormat
\nDateTime field has invalid format. Please see the request details on the proper DateTime format.
\n\n05
\nInvalidDate
\nDateTime field contains invalid date or time value, or the value is out of range.
\n\n06
\nRequiredFieldIsMissing
\nRequired field is missing in the request.
\n\n07
\nInvalidPolygon
\nPolygon representation is invalid or polygon type is not supported.
\n\n08
\nInvalidStringFormat
\nString field doesn't comply to the specified format.
\n\n09
\nDuplicateValues
\nDuplicates found among values that are required to be unique.
\n\n10
\nInvalidType
\nThe field has data of invalid type.
\n\n11
\nInvalidDates
\nRelation between two or more DateTime fields is invalid.
\n\n12
\nGeofenceTooBig
\nProvided polygon exceeds the set limit.
\n\n13
\nUnknownParameter
\nUnexpected parameter name found in the request body.
\n\n14
\nArraySizeTooBig
\nArray size is too big.
\n\n15
\nInvalidCombination
\nInvalid combination selected for parameter values.
\n\n> Combination - reportType: celcdl and pingFilter: none\n\n
The pingFilter selected is not applicable for this context.
To 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.
If you have any API related questions or require technical support please contact our support team at
\nsupport@environicsanalytics.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Version History","slug":"version-history"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Errors","slug":"errors"},{"content":"Rate limits","slug":"rate-limits"},{"content":"Contact","slug":"contact"}],"owner":"17783045","collectionId":"7cbabdde-dd15-404b-92d5-a003dcdfd76b","publishedId":"2s93sZ5tp6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-16T02:08:43.000Z"},"item":[{"name":"v2","item":[{"name":"MobileScapes API","item":[{"name":"Submit Request","event":[{"listen":"prerequest","script":{"id":"a2e44f26-5a1d-42c2-a0dd-51a4d50a1430","exec":[""],"type":"text/javascript"}}],"id":"bc339d37-0aa6-4cf9-9096-25fee0cb56fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"startDateTime","value":"string (Required)","description":"Request start datetime (polygon local time). DateTime is represented in YYYY-MM-DD hh:mm:ss format.
\n","type":"text","disabled":true}]},"url":"https://api.environicsanalytics.com/mobilescapes/v2/:country/requests","description":"An endpoint for submitting a new MobileScapes extract request.
\nREQUEST BODY raw
\nstartDateTime
\nstring (Required)
\nRequest start datetime (polygon local time). DateTime is represented in YYYY-MM-DD hh:mm:ss format.
\n\nendDateTime
\nstring (Required)
\nRequest end datetime (polygon local time). DateTime is represented in YYYY-MM-DD hh:mm:ss format.
\n\ndataVintage
\nstring
\nSpecifies which vintage of geographies to append to output file. Default is latest available vintage.
useWeights
\nboolean
\nSpecifies whether to apply weights per device or keep them unweighted. Default is true.
aggregatePolygons
\nboolean
\nSpecifies whether to aggregate geofences or keep them separate. Default is true.
aggregatePolygonName
\nstring
\nSpecifies custom name prior to submitting extracts, applicable when aggregatePolygon is true. Default is empty.
appendSegmentation
\nstring
\nSpecifies which segmentation system to append. Segmentation license required. For Canada requests: prizm, prizmda, prizmqc, or prizmqcda; For US requests: prizmpremier, connexions, or psyclepremier
dailyTimeFilter
\narray
\nList of dayPart objects. Specifies the days and dayparts to collect pings. Each dayPart object must have at least daysOfWeek, startTime, or endTime defined.
pingFilter
\nstring
\nSpecifies whether to return all pings, first and last ping per device per day or first ping per device per day. Valid External Values: first. Valid Internal Values: first, firstlast, none.
reportType
\nstring
\nSpecifies expected report type. Valid External Values: celcdl, geofencepings. Valid Internal Values: celcdl, cl, geofencepings.
geofenceIds
\narray (Required)
\nList of EA geofence ids. Used to define area(s) of interest. Only valid for Canadian extract requests, not applicable with US requests.
\n\nwktList
\narray (Required)
\nList of wktObject objects. Used to define area(s) of interest.
geoJson
\nobject (Required)
\ngeoJson object (RFC 7946). Each geoJson Feature object must have id property to uniquely identify each area of interest. Used to define area(s) of interest. Supports Polygon or MultiPolygon Feature type.
Each request must have at least one of the following properties defined: geofenceIds, wktList, or geoJson. Note that each area of interest must have a uniquely defined id among all areas of interest submitted in the request.
dayPart object
\ndaysOfWeek
\narray
\nSpecifies which days of the week should be included in the extract. Contains standard 3-digit capitalized names of week days, e.g. Mon, Tue, etc.
startTime
\nstring
\nLocal time in 24-hour hh:mm format.
\n\nendTime
\nstring
\nLocal time in 24-hour hh:mm format.
\n\nwktObject object
\nid
\nstring (Required)
\nUnique id of a geofence. id must be unique across all polygon types (wkt, geoJson, geofenceIds) per request.
wkt
\nstring (Required)
\nWKTrepresentation of area of interest. Can be POLYGON or MULTIPOLYGON.
2-digit country code (e.g. \"ca\" for Canada, \"us\" for United States).
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"country"}]}},"response":[{"id":"edd6c007-309d-4d05-a63d-c295da231cc8","name":"EA Geofence extract request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"startDateTime\": \"2020-06-01 00:00:00\",\n \"endDateTime\": \"2020-09-30 23:59:00\",\n \"useWeights\": true,\n \"geofenceIds\": [\n 56582,\n 173525,\n 173783\n ],\n \"dailyTimeFilter\": [\n {\n \"startTime\": \"10:00\",\n \"endTime\": \"22:00\"\n }\n ],\n \"appendSegmentation\": \"prizm\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests"],"variable":[{"key":"country","value":"ca"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"47dc14efbe454b4884459ed5a61f6909\"\n}"},{"id":"3c4b08c8-2dd0-40f7-a511-212ff56c836c","name":"GeoJson extract request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDateTime\": \"2019-06-01 00:00:00\",\r\n \"endDateTime\": \"2019-09-30 23:59:00\",\r\n \"useWeights\": true,\r\n \"geoJson\": {\r\n \"type\": \"FeatureCollection\",\r\n \"features\": [\r\n {\r\n \"id\": \"Two Parks\",\r\n \"type\": \"Feature\",\r\n \"geometry\": {\r\n \"type\": \"MultiPolygon\",\r\n \"coordinates\": [\r\n [\r\n [\r\n [\r\n -79.41020965576172,\r\n 43.63831139435743\r\n ],\r\n [\r\n -79.41012382507324,\r\n 43.63767469606762\r\n ],\r\n [\r\n -79.40769910812378,\r\n 43.63767469606762\r\n ],\r\n [\r\n -79.40246343612671,\r\n 43.638156102713715\r\n ],\r\n [\r\n -79.4007682800293,\r\n 43.63896361487832\r\n ],\r\n [\r\n -79.40117597579956,\r\n 43.63994193238506\r\n ],\r\n [\r\n -79.4035792350769,\r\n 43.63977111619047\r\n ],\r\n [\r\n -79.41020965576172,\r\n 43.63831139435743\r\n ]\r\n ]\r\n ],\r\n [\r\n [\r\n [\r\n -79.40315008163452,\r\n 43.63570244147601\r\n ],\r\n [\r\n -79.40759181976318,\r\n 43.6352365451129\r\n ],\r\n [\r\n -79.41072463989258,\r\n 43.632394499077456\r\n ],\r\n [\r\n -79.41010236740112,\r\n 43.63119862532508\r\n ],\r\n [\r\n -79.40864324569702,\r\n 43.63169561470926\r\n ],\r\n [\r\n -79.4086217880249,\r\n 43.63304678382189\r\n ],\r\n [\r\n -79.40634727478027,\r\n 43.6328914785725\r\n ],\r\n [\r\n -79.40345048904419,\r\n 43.633450575591986\r\n ],\r\n [\r\n -79.40154075622559,\r\n 43.63421156039935\r\n ],\r\n [\r\n -79.40315008163452,\r\n 43.63570244147601\r\n ]\r\n ]\r\n ]\r\n ]\r\n }\r\n },\r\n {\r\n \"id\": \"City Place\",\r\n \"type\": \"Feature\",\r\n \"geometry\": { \r\n \"type\": \"Polygon\",\r\n \"coordinates\": [\r\n [\r\n [\r\n -79.39789295196533,\r\n 43.63929748692908\r\n ],\r\n [\r\n -79.39738869667053,\r\n 43.63810951514234\r\n ],\r\n [\r\n -79.39584374427795,\r\n 43.63832692349973\r\n ],\r\n [\r\n -79.39517855644226,\r\n 43.638606447374805\r\n ],\r\n [\r\n -79.39573645591736,\r\n 43.639825466850525\r\n ],\r\n [\r\n -79.39789295196533,\r\n 43.63929748692908\r\n ]\r\n ]\r\n ]\r\n }\r\n }\r\n ]\r\n },\r\n \"dailyTimeFilter\": [\r\n {\r\n \"daysOfWeek\": [\r\n \"Sat\",\r\n \"Sun\"\r\n ]\r\n }\r\n ],\r\n \"appendSegmentation\": \"prizm\",\r\n \"dataVintage\": \"2019\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests"],"variable":[{"key":"country","value":"ca","description":"2-digit country code (e.g. \"ca\" for Canada)."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"5de72484b797405bbfa62e470bc6c3ae\"\n}"},{"id":"d733bc5d-8f4b-4165-9a8e-af415055076c","name":"Wkt extract request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDateTime\": \"2020-01-01 09:00:00\",\r\n \"endDateTime\": \"2020-03-31 17:00:00\",\r\n \"useWeights\": false,\r\n \"wktList\": [\r\n {\r\n \"id\": \"City Hall\",\r\n \"wkt\": \"POLYGON ((-79.384809324999935 43.65382683100006, -79.384487459999946 43.652976823000074, -79.383462855999937 43.653015637000067, -79.383146355999941 43.652926366000031, -79.382937143999982 43.652538231000051, -79.382867405999946 43.652542112000049, -79.383489678999979 43.654114045000028, -79.384809324999935 43.65382683100006))\"\r\n },\r\n {\r\n \"id\": \"Downtown Parks\",\r\n \"wkt\": \"MULTIPOLYGON (((-79.390664 43.652408, -79.391479 43.654147, -79.393635 43.653712, -79.39297 43.651965, -79.39297 43.651973, -79.390664 43.652408)), ((-79.383457 43.640797, -79.384294 43.643266, -79.388006 43.642753, -79.386944 43.640036, -79.384144 43.640478, -79.383457 43.640797)))\"\r\n }\r\n ],\r\n \"dailyTimeFilter\": [\r\n {\r\n \"daysOfWeek\": [\r\n \"Mon\",\r\n \"Tue\",\r\n \"Wed\",\r\n \"Thu\",\r\n \"Fri\"\r\n ],\r\n \"startTime\": \"09:00\",\r\n \"endTime\": \"17:00\"\r\n }\r\n ],\r\n \"appendSegmentation\": \"prizm\",\r\n \"dataVintage\": \"2020\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests"],"variable":[{"key":"country","value":"ca","description":"2-digit country code (e.g. \"ca\" for Canada)."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"ff67453eef7d47bf8d7a7523c5a46e48\"\n}"},{"id":"997fec02-1800-4b8d-b012-0fab62223a24","name":"Ping Report request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDateTime\": \"2020-01-01 09:00:00\",\r\n \"endDateTime\": \"2020-03-31 17:00:00\",\r\n \"pingFilter\": \"none\",\r\n \"reportType\": \"geofencepings\",\r\n \"useWeights\": false,\r\n \"wktList\": [\r\n {\r\n \"id\": \"City Hall\",\r\n \"wkt\": \"POLYGON ((-79.384809324999935 43.65382683100006, -79.384487459999946 43.652976823000074, -79.383462855999937 43.653015637000067, -79.383146355999941 43.652926366000031, -79.382937143999982 43.652538231000051, -79.382867405999946 43.652542112000049, -79.383489678999979 43.654114045000028, -79.384809324999935 43.65382683100006))\"\r\n },\r\n {\r\n \"id\": \"Downtown Parks\",\r\n \"wkt\": \"MULTIPOLYGON (((-79.390664 43.652408, -79.391479 43.654147, -79.393635 43.653712, -79.39297 43.651965, -79.39297 43.651973, -79.390664 43.652408)), ((-79.383457 43.640797, -79.384294 43.643266, -79.388006 43.642753, -79.386944 43.640036, -79.384144 43.640478, -79.383457 43.640797)))\"\r\n }\r\n ],\r\n \"dailyTimeFilter\": [\r\n {\r\n \"daysOfWeek\": [\r\n \"Mon\",\r\n \"Tue\",\r\n \"Wed\",\r\n \"Thu\",\r\n \"Fri\"\r\n ],\r\n \"startTime\": \"09:00\",\r\n \"endTime\": \"17:00\"\r\n }\r\n ],\r\n \"appendSegmentation\": \"prizm\",\r\n \"dataVintage\": \"2020\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests"],"variable":[{"key":"country","value":"ca","description":"2-digit country code (e.g. \"ca\" for Canada)."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"ff67453eef7d47bf8d7a7523c5a46e48\"\n}"}],"_postman_id":"bc339d37-0aa6-4cf9-9096-25fee0cb56fd"},{"name":"Get Status Check","id":"11adb1f6-cc98-4dc8-a130-6858521c0b3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.environicsanalytics.com/mobilescapes/v2/:country/requests/:id/status","description":"An endpoint for checking the status of a request.
\nA successful response is a JSON object that contains requestStatus property which can take one of the following six states
SUBMITTED
ENQUEUED
PROCESSING
COMPLETE
FAILED
EXPIRED
Status ENQUEUED is an optional state, indicating when system is under heavier traffic, request is queued for processing.
If status is COMPLETE and request contains multiple geofences then response will also detail how many of the submitted geofences succeeded geofencesSucceeded vs failed geofencesFailed.
Status will return FAILED only if all submitted geofences within the request failed.
2-digit country code (e.g. \"ca\" for Canada, \"us\" for United States).
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"country"},{"description":{"content":"Id of the request
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"id"}]}},"response":[{"id":"55199704-8161-4049-be82-adb1e2dd8061","name":"Status check","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests/:id/status","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests",":id","status"],"variable":[{"key":"country","value":"ca"},{"key":"id","value":"d20ceb312f4a4b15b743d636c6bc69ba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestStatus\": \"COMPLETE\",\n \"geofencesSucceded\": 3,\n \"geofencesFailed\": 0\n}"}],"_postman_id":"11adb1f6-cc98-4dc8-a130-6858521c0b3b"},{"name":"Get Result Info","id":"de3bbc48-d442-4623-8567-669405bd5d54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.environicsanalytics.com/mobilescapes/v2/:country/requests/:id/resultInfo","description":"An endpoint that directs to the extract files.
\nA successful response is a JSON object that contains a blobList object, Azure storage url, a storage container name and a SAS token that grants user access to their extract file. To download the extract files, these four pieces of information will be combined using the following template {storageUrl}/{containerName}/{fileName}?{sasToken}. Alternatively, Azure Storage client library may be used.
A url that returns an enumeration of files, including fileName, inside of the result container in the cloud-based storage account.
\nA shared access signature (SAS) that provides secure delegated access to resources in the cloud-based storage account.
\nUrl of the cloud-based storage account where output files are stored.
\nName of the container that contains output files.
\nNote that SAS tokens expire within an hour. If expired, a new token will need to be generated by sending another request to this endpoint.
\nExtract files are made available in several, separate files that are zipped together.
\n","urlObject":{"path":[":country","requests",":id","resultInfo"],"host":["https://api.environicsanalytics.com/mobilescapes/v2"],"query":[],"variable":[{"description":{"content":"2-digit country code (e.g. \"ca\" for Canada, \"us\" for United States).
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"country"},{"description":{"content":"Id of request
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"id"}]}},"response":[{"id":"de5a4404-bd11-4f08-a774-15aae9c1919c","name":"Result Info","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests/:id/resultInfo","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests",":id","resultInfo"],"variable":[{"key":"country","value":"ca"},{"key":"id","value":"d20ceb312f4a4b15b743d636c6bc69ba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"blobList\": \"https://ue2mobilesdoutputstor.blob.core.windows.net/e380120d798843c68c9f338cc29cb8cb?restype=container&comp=list&sv=2020-02-10&st=2021-01-11T21%3A34%3A54Z&se=2021-01-11T22%3A39%3A54Z&sr=c&sp=rl&sig=qW24%2B3SP4zmWl%2FoXa%2BKjy6vt0ERkieKCJ%2BRRf1tho5Y%3D\",\n \"sasToken\": \"sv=2020-02-10&st=2021-01-11T21%3A34%3A54Z&se=2021-01-11T22%3A39%3A54Z&sr=c&sp=rl&sig=qW24%2B3SP4zmWl%2FoXa%2BKjy6vt0ERkieKCJ%2BRRf1tho5Y%3D\",\n \"storageUrl\": \"https://ue2mobilesdoutputstor.blob.core.windows.net\",\n \"containerName\": \"e380120d798843c68c9f338cc29cb8cb\"\n}"}],"_postman_id":"de3bbc48-d442-4623-8567-669405bd5d54"}],"id":"a4d4d8bd-75b8-40e1-93ee-ef6de1cdd10b","description":"Environics Analytics MobileScapes API provides access to the most accurate, comprehensive and up-to-date mobile movement database available for marketing and business applications. Use MobileScapes to identify who is visiting your locations, how often, and where they live and work to make informed decisions around products, program development, marketing, messaging, recovery planning and staffing levels.
\nMobileScapes API allows users to programmatically submit MobileScapes extract requests and download extract files from cloud-based storage. Users can also take advantage of EA’s segmentation systems and have segment codes assigned to extract records.
\nExtract files are stored in cloud-based storage for 8 days. Access to cloud-based storage is provided via a short-lived SAS token that is created by the user’s request.
\nAll request details and extract files are available only to the user who submitted the extract request.
\nEnvironics Analytics MobileScapes API implements two types of quotas for new MobileScapes extract requests. Each quota is replenished at 05:00 AM UTC daily.
\nEach user can submit up to 1,000 requests per day given that the daily geofences quota is not exceeded.
\nEach user can submit up to 20,000 geofences per day across multiple requests. Each request can include up to 300 geofences.
\nIt’s recommended to apply best practice to consume daily geofences quota evenly through out the day. Sending large amount of geofences in bursts will trigger programmatically calculated delay. Daily geofence quota is guaranteed even when delay is introduced.
\nValid for Canadian and US extract requests.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"df91cbce-7745-4e59-8ef3-9d8db54dec84"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f12aa4b3-35d8-472e-9aed-3919bfcedec2"}}],"_postman_id":"a4d4d8bd-75b8-40e1-93ee-ef6de1cdd10b"},{"name":"EA Geofences API","item":[{"name":"Get EA geofences","id":"19a1346a-c958-4dd4-b58c-0630e63c36f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.environicsanalytics.com/mobilescapes/v2/:country/geofences?$filter=string","description":"An endpoint to lookup EA geofence IDs from EA geofence library. Several attributes can be defined in order to filter the EA geofence library in order to return a subset of EA geofence IDs.
\nReturns a list of EA geofence IDs and names that satisfy the filter expression. If no entities satisfy the specified filter an empty list is returned.
\nPaging functionality is handled using Azure tables' built-in query pagination. A request that returns more than the 1,000 result limit returns a continuation token for performing pagination.
\n","urlObject":{"path":[":country","geofences"],"host":["https://api.environicsanalytics.com/mobilescapes/v2"],"query":[{"description":{"content":"Filter query option which conforms to the OData Protocol Specification. Returns only entities that satisfy the specified filter. If no entities satisfy the specified filter an empty list is returned.\nNote that no more than 15 discrete comparisons are permitted within a $filter string.
\n","type":"text/plain"},"key":"$filter","value":"string"},{"disabled":true,"key":"","value":""}],"variable":[{"id":"2709047d-011b-4fbe-8c37-ace089a1ee7a","description":{"content":"2-digit country code (e.g. \"ca\" for Canada).
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"country"}]}},"response":[{"id":"00a683ff-c7ef-4f25-8d81-072fcade0ffd","name":"Get EA geofences","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v2/:country/geofences?$filter=city%20eq%20'Toronto'%20and%20banner%20eq%20'Costco Wholesale'","protocol":"https","host":["api","environicsanalytics","com"],"path":["mobilescapes","v2",":country","geofences"],"query":[{"key":"$filter","value":"city%20eq%20'Toronto'%20and%20banner%20eq%20'Costco Wholesale'","description":"Get all Costco Wholesale geofences that are located in Toronto"},{"key":"","value":"","disabled":true}],"variable":[{"key":"country","value":"ca","description":"2-digit country code"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"value\": [\r\n {\r\n \"id\": 56884,\r\n \"name\": \"Costco Wholesale at RioCan Scarborough Centre (50 Thermos Rd)\"\r\n },\r\n {\r\n \"id\": 57772,\r\n \"name\": \"Costco Wholesale (50 Queen Elizabeth Blvd)\"\r\n },\r\n {\r\n \"id\": 57857,\r\n \"name\": \"Costco Wholesale (42 Overlea Blvd)\"\r\n },\r\n {\r\n \"id\": 58026,\r\n \"name\": \"Costco Wholesale (1411 Warden Ave)\"\r\n },\r\n {\r\n \"id\": 59435,\r\n \"name\": \"Costco Wholesale at SmartCentres Toronto (Downsview) (100 Billy Bishop Way)\"\r\n }\r\n ]\r\n}"}],"_postman_id":"19a1346a-c958-4dd4-b58c-0630e63c36f4"}],"id":"4335c676-fb4a-4cff-854b-aa84a2cb11f6","description":"Environics Analytics has undertaken a large-scale effort to build a continually expanding library of custom built, proprietary geofences for Canadian commercial, institutional and recreational locations. Geofences can be used for destination-based mobile movement extracts for faster analysis.
\nThis API supports $filter query options, which conform to the OData Protocol Specification. Within a $filter clause, you can use comparison operators to specify the criteria against which to filter the query results.
For all property types, the following comparison operators are supported:
\nAdditionally, the following operators are supported for Boolean properties:
\nFor more information about filter syntax, see the OData Protocol Specification.
\n","_postman_id":"4335c676-fb4a-4cff-854b-aa84a2cb11f6"}],"id":"35d3bf91-717f-4de4-a173-3faa431a79cd","description":"In this version of the MobileScapes API, a new report type called \"geofencepings\" has been added, introducing an additional level of reporting capabilities. The geofencepings report enables users to retrieve specific information related to geofence pings, providing insights into the interactions and activities within the area of interest. This new report type expands the range of data available through the MobileScapes API, empowering users with more detailed and targeted analysis of geofence-related events.
\n","_postman_id":"35d3bf91-717f-4de4-a173-3faa431a79cd"},{"name":"v4","item":[{"name":"MobileScapes API","item":[{"name":"Submit Request","event":[{"listen":"prerequest","script":{"id":"68b99389-e2e3-419f-8e11-7e7f18b63fd6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"887f57c0-2b16-48e4-a83d-cb6449a28e56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"startDateTime","value":"string (Required)","description":"Request start datetime (polygon local time). DateTime is represented in YYYY-MM-DD hh:mm:ss format.
\n","type":"text","disabled":true}]},"url":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests","description":"An endpoint for submitting a new MobileScapes extract request.
\nREQUEST BODY raw
\nstartDateTime
\nstring (Required)
\nRequest start datetime (polygon local time). DateTime is represented in YYYY-MM-DD hh:mm:ss format.
\n\nendDateTime
\nstring (Required)
\nRequest end datetime (polygon local time). DateTime is represented in YYYY-MM-DD hh:mm:ss format.
\n\ndataVintage
\nstring
\nSpecifies which vintage of geographies to append to output file. Default is latest available vintage.
useWeights
\nboolean
\nSpecifies whether to apply weights per device or keep them unweighted. Default is true.
aggregatePolygons
\nboolean
\nSpecifies whether to aggregate geofences or keep them separate. Default is true.
aggregatePolygonName
\nstring
\nSpecifies custom name prior to submitting extracts, applicable when aggregatePolygon is true. Default is empty.
appendSegmentation
\nstring
\nSpecifies which segmentation system to append. Segmentation license required. Can be prizm, prizmda, prizmqc, or prizmqcda.
dailyTimeFilter
\narray
\nList of dayPart objects. Specifies the days and dayparts to collect pings. Each dayPart object must have at least daysOfWeek, startTime, or endTime defined.
pingFilter
\nstring
\nSpecifies whether to return all pings, first and last ping per device per day or first ping per device per day. Valid External Values: first. Valid Internal Values: first, firstlast, none.
reportType
\nstring
\nSpecifies expected report type. Valid External Values: celcdl, geofencepings. Valid Internal Values: celcdl, cl, geofencepings.
geofenceIds
\narray (Required)
\nList of EA geofence ids. Used to define area(s) of interest.
\n\nwktList
\narray (Required)
\nList of wktObject objects. Used to define area(s) of interest.
geoJson
\nobject (Required)
\ngeoJson object (RFC 7946). Each geoJson Feature object must have id property to uniquely identify each area of interest. Used to define area(s) of interest. Supports Polygon or MultiPolygon Feature type.
Each request must have at least one of the following properties defined: geofenceIds, wktList, or geoJson. Note that each area of interest must have a uniquely defined id among all areas of interest submitted in the request.
dayPart object
\ndaysOfWeek
\narray
\nSpecifies which days of the week should be included in the extract. Contains standard 3-digit capitalized names of week days, e.g. Mon, Tue, etc.
startTime
\nstring
\nLocal time in 24-hour hh:mm format.
\n\nendTime
\nstring
\nLocal time in 24-hour hh:mm format.
\n\nwktObject object
\nid
\nstring (Required)
\nUnique id of a geofence. id must be unique across all polygon types (wkt, geoJson, geofenceIds) per request.
wkt
\nstring (Required)
\nWKTrepresentation of area of interest. Can be POLYGON or MULTIPOLYGON.
2-digit country code (e.g. \"ca\" for Canada).
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"country"}]}},"response":[{"id":"956160ba-3a56-4780-a2a8-92c5ea485a5d","name":"EA Geofence extract request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"startDateTime\": \"2020-06-01 00:00:00\",\n \"endDateTime\": \"2020-09-30 23:59:00\",\n \"useWeights\": true,\n \"geofenceIds\": [\n 56582,\n 173525,\n 173783\n ],\n \"dailyTimeFilter\": [\n {\n \"startTime\": \"10:00\",\n \"endTime\": \"22:00\"\n }\n ],\n \"appendSegmentation\": \"prizm\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v3/:country/requests","protocol":"https","host":["api","environicsanalytics","com"],"path":["mobilescapes","v3",":country","requests"],"variable":[{"key":"country","value":"ca"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"47dc14efbe454b4884459ed5a61f6909\"\n}"},{"id":"7c84f7b7-6c6e-4f92-8f81-d7fc518cb125","name":"GeoJson extract request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDateTime\": \"2019-06-01 00:00:00\",\r\n \"endDateTime\": \"2019-09-30 23:59:00\",\r\n \"useWeights\": true,\r\n \"geoJson\": {\r\n \"type\": \"FeatureCollection\",\r\n \"features\": [\r\n {\r\n \"id\": \"Two Parks\",\r\n \"type\": \"Feature\",\r\n \"geometry\": {\r\n \"type\": \"MultiPolygon\",\r\n \"coordinates\": [\r\n [\r\n [\r\n [\r\n -79.41020965576172,\r\n 43.63831139435743\r\n ],\r\n [\r\n -79.41012382507324,\r\n 43.63767469606762\r\n ],\r\n [\r\n -79.40769910812378,\r\n 43.63767469606762\r\n ],\r\n [\r\n -79.40246343612671,\r\n 43.638156102713715\r\n ],\r\n [\r\n -79.4007682800293,\r\n 43.63896361487832\r\n ],\r\n [\r\n -79.40117597579956,\r\n 43.63994193238506\r\n ],\r\n [\r\n -79.4035792350769,\r\n 43.63977111619047\r\n ],\r\n [\r\n -79.41020965576172,\r\n 43.63831139435743\r\n ]\r\n ]\r\n ],\r\n [\r\n [\r\n [\r\n -79.40315008163452,\r\n 43.63570244147601\r\n ],\r\n [\r\n -79.40759181976318,\r\n 43.6352365451129\r\n ],\r\n [\r\n -79.41072463989258,\r\n 43.632394499077456\r\n ],\r\n [\r\n -79.41010236740112,\r\n 43.63119862532508\r\n ],\r\n [\r\n -79.40864324569702,\r\n 43.63169561470926\r\n ],\r\n [\r\n -79.4086217880249,\r\n 43.63304678382189\r\n ],\r\n [\r\n -79.40634727478027,\r\n 43.6328914785725\r\n ],\r\n [\r\n -79.40345048904419,\r\n 43.633450575591986\r\n ],\r\n [\r\n -79.40154075622559,\r\n 43.63421156039935\r\n ],\r\n [\r\n -79.40315008163452,\r\n 43.63570244147601\r\n ]\r\n ]\r\n ]\r\n ]\r\n }\r\n },\r\n {\r\n \"id\": \"City Place\",\r\n \"type\": \"Feature\",\r\n \"geometry\": { \r\n \"type\": \"Polygon\",\r\n \"coordinates\": [\r\n [\r\n [\r\n -79.39789295196533,\r\n 43.63929748692908\r\n ],\r\n [\r\n -79.39738869667053,\r\n 43.63810951514234\r\n ],\r\n [\r\n -79.39584374427795,\r\n 43.63832692349973\r\n ],\r\n [\r\n -79.39517855644226,\r\n 43.638606447374805\r\n ],\r\n [\r\n -79.39573645591736,\r\n 43.639825466850525\r\n ],\r\n [\r\n -79.39789295196533,\r\n 43.63929748692908\r\n ]\r\n ]\r\n ]\r\n }\r\n }\r\n ]\r\n },\r\n \"dailyTimeFilter\": [\r\n {\r\n \"daysOfWeek\": [\r\n \"Sat\",\r\n \"Sun\"\r\n ]\r\n }\r\n ],\r\n \"appendSegmentation\": \"prizm\",\r\n \"dataVintage\": \"2019\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests"],"variable":[{"key":"country","value":"ca","description":"2-digit country code (e.g. \"ca\" for Canada)."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"5de72484b797405bbfa62e470bc6c3ae\"\n}"},{"id":"c0717bfc-04d3-4ad1-9332-c19b760b9219","name":"Wkt extract request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDateTime\": \"2020-01-01 09:00:00\",\r\n \"endDateTime\": \"2020-03-31 17:00:00\",\r\n \"useWeights\": false,\r\n \"wktList\": [\r\n {\r\n \"id\": \"City Hall\",\r\n \"wkt\": \"POLYGON ((-79.384809324999935 43.65382683100006, -79.384487459999946 43.652976823000074, -79.383462855999937 43.653015637000067, -79.383146355999941 43.652926366000031, -79.382937143999982 43.652538231000051, -79.382867405999946 43.652542112000049, -79.383489678999979 43.654114045000028, -79.384809324999935 43.65382683100006))\"\r\n },\r\n {\r\n \"id\": \"Downtown Parks\",\r\n \"wkt\": \"MULTIPOLYGON (((-79.390664 43.652408, -79.391479 43.654147, -79.393635 43.653712, -79.39297 43.651965, -79.39297 43.651973, -79.390664 43.652408)), ((-79.383457 43.640797, -79.384294 43.643266, -79.388006 43.642753, -79.386944 43.640036, -79.384144 43.640478, -79.383457 43.640797)))\"\r\n }\r\n ],\r\n \"dailyTimeFilter\": [\r\n {\r\n \"daysOfWeek\": [\r\n \"Mon\",\r\n \"Tue\",\r\n \"Wed\",\r\n \"Thu\",\r\n \"Fri\"\r\n ],\r\n \"startTime\": \"09:00\",\r\n \"endTime\": \"17:00\"\r\n }\r\n ],\r\n \"appendSegmentation\": \"prizm\",\r\n \"dataVintage\": \"2020\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests"],"variable":[{"key":"country","value":"ca","description":"2-digit country code (e.g. \"ca\" for Canada)."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"ff67453eef7d47bf8d7a7523c5a46e48\"\n}"},{"id":"4e38a8ce-7b6a-4933-bb4f-b7c42b0bd951","name":"Ping Report request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDateTime\": \"2020-01-01 09:00:00\",\r\n \"endDateTime\": \"2020-03-31 17:00:00\",\r\n \"pingFilter\": \"none\",\r\n \"reportType\": \"geofencepings\",\r\n \"useWeights\": false,\r\n \"wktList\": [\r\n {\r\n \"id\": \"City Hall\",\r\n \"wkt\": \"POLYGON ((-79.384809324999935 43.65382683100006, -79.384487459999946 43.652976823000074, -79.383462855999937 43.653015637000067, -79.383146355999941 43.652926366000031, -79.382937143999982 43.652538231000051, -79.382867405999946 43.652542112000049, -79.383489678999979 43.654114045000028, -79.384809324999935 43.65382683100006))\"\r\n },\r\n {\r\n \"id\": \"Downtown Parks\",\r\n \"wkt\": \"MULTIPOLYGON (((-79.390664 43.652408, -79.391479 43.654147, -79.393635 43.653712, -79.39297 43.651965, -79.39297 43.651973, -79.390664 43.652408)), ((-79.383457 43.640797, -79.384294 43.643266, -79.388006 43.642753, -79.386944 43.640036, -79.384144 43.640478, -79.383457 43.640797)))\"\r\n }\r\n ],\r\n \"dailyTimeFilter\": [\r\n {\r\n \"daysOfWeek\": [\r\n \"Mon\",\r\n \"Tue\",\r\n \"Wed\",\r\n \"Thu\",\r\n \"Fri\"\r\n ],\r\n \"startTime\": \"09:00\",\r\n \"endTime\": \"17:00\"\r\n }\r\n ],\r\n \"appendSegmentation\": \"prizm\",\r\n \"dataVintage\": \"2020\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests","host":["https://api.environicsanalytics.com/mobilescapes/v4"],"path":[":country","requests"],"variable":[{"key":"country","value":"ca","description":"2-digit country code (e.g. \"ca\" for Canada)."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"ff67453eef7d47bf8d7a7523c5a46e48\"\n}"}],"_postman_id":"887f57c0-2b16-48e4-a83d-cb6449a28e56"},{"name":"Get Status Check","id":"b11f34dc-11b3-4755-a452-b4e0e64b01c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests/:id/status","description":"An endpoint for checking the status of a request.
\nA successful response is a JSON object that contains requestStatus property which can take one of the following six states
SUBMITTED
ENQUEUED
PROCESSING
COMPLETE
FAILED
EXPIRED
Status ENQUEUED is an optional state, indicating when system is under heavier traffic, request is queued for processing.
If status is COMPLETE and request contains multiple geofences then response will also detail how many of the submitted geofences succeeded geofencesSucceeded vs failed geofencesFailed.
Status will return FAILED only if all submitted geofences within the request failed.
2-digit country code (e.g. \"ca\" for Canada).
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"country"},{"description":{"content":"Id of the request
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"id"}]}},"response":[{"id":"cf294466-2f73-4b17-963a-325bd6483037","name":"Status check","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v3/:country/requests/:id/status","protocol":"https","host":["api","environicsanalytics","com"],"path":["mobilescapes","v3",":country","requests",":id","status"],"variable":[{"key":"country","value":"ca"},{"key":"id","value":"d20ceb312f4a4b15b743d636c6bc69ba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestStatus\": \"COMPLETE\",\n \"geofencesSucceded\": 3,\n \"geofencesFailed\": 0\n}"}],"_postman_id":"b11f34dc-11b3-4755-a452-b4e0e64b01c5"},{"name":"Get Result Info","id":"feba209e-3ede-4baf-b899-56fe791caca8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.environicsanalytics.com/mobilescapes/v4/:country/requests/:id/resultInfo","description":"An endpoint that directs to the extract files.
\nA successful response is a JSON object that contains a blobList object, Azure storage url, a storage container name and a SAS token that grants user access to their extract file. To download the extract files, these four pieces of information will be combined using the following template {storageUrl}/{containerName}/{fileName}?{sasToken}. Alternatively, Azure Storage client library may be used.
A url that returns an enumeration of files, including fileName, inside of the result container in the cloud-based storage account.
\nA shared access signature (SAS) that provides secure delegated access to resources in the cloud-based storage account.
\nUrl of the cloud-based storage account where output files are stored.
\nName of the container that contains output files.
\nNote that SAS tokens expire within an hour. If expired, a new token will need to be generated by sending another request to this endpoint.
\nExtract files are made available in several, separate files that are zipped together.
\n","urlObject":{"path":[":country","requests",":id","resultInfo"],"host":["https://api.environicsanalytics.com/mobilescapes/v4"],"query":[],"variable":[{"description":{"content":"2-digit country code (e.g. \"ca\" for Canada).
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"country"},{"description":{"content":"Id of request
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"id"}]}},"response":[{"id":"0c0f0571-8919-43f6-add3-a3313cc6cf55","name":"Result Info","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v3/:country/requests/:id/resultInfo","protocol":"https","host":["api","environicsanalytics","com"],"path":["mobilescapes","v3",":country","requests",":id","resultInfo"],"variable":[{"key":"country","value":"ca"},{"key":"id","value":"d20ceb312f4a4b15b743d636c6bc69ba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"blobList\": \"https://ue2mobilesdoutputstor.blob.core.windows.net/e380120d798843c68c9f338cc29cb8cb?restype=container&comp=list&sv=2020-02-10&st=2021-01-11T21%3A34%3A54Z&se=2021-01-11T22%3A39%3A54Z&sr=c&sp=rl&sig=qW24%2B3SP4zmWl%2FoXa%2BKjy6vt0ERkieKCJ%2BRRf1tho5Y%3D\",\n \"sasToken\": \"sv=2020-02-10&st=2021-01-11T21%3A34%3A54Z&se=2021-01-11T22%3A39%3A54Z&sr=c&sp=rl&sig=qW24%2B3SP4zmWl%2FoXa%2BKjy6vt0ERkieKCJ%2BRRf1tho5Y%3D\",\n \"storageUrl\": \"https://ue2mobilesdoutputstor.blob.core.windows.net\",\n \"containerName\": \"e380120d798843c68c9f338cc29cb8cb\"\n}"}],"_postman_id":"feba209e-3ede-4baf-b899-56fe791caca8"}],"id":"a6b1cdbd-a7af-467c-ba2b-96f3a8da66f5","description":"Environics Analytics MobileScapes API provides access to the most accurate, comprehensive and up-to-date mobile movement database available for marketing and business applications. Use MobileScapes to identify who is visiting your locations, how often, and where they live and work to make informed decisions around products, program development, marketing, messaging, recovery planning and staffing levels.
\nMobileScapes API allows users to programmatically submit MobileScapes extract requests and download extract files from cloud-based storage. Users can also take advantage of EA’s segmentation systems and have segment codes assigned to extract records.
\nExtract files are stored in cloud-based storage for 8 days. Access to cloud-based storage is provided via a short-lived SAS token that is created by the user’s request.
\nAll request details and extract files are available only to the user who submitted the extract request.
\nEnvironics Analytics MobileScapes API implements two types of quotas for new MobileScapes extract requests. Each quota is replenished at 05:00 AM UTC daily.
\nEach user can submit up to 1,000 requests per day given that the daily geofences quota is not exceeded.
\nEach user can submit up to 20,000 geofences per day across multiple requests. Each request can include up to 300 geofences.
\nIt’s recommended to apply best practice to consume daily geofences quota evenly through out the day. Sending large amount of geofences in bursts will trigger programmatically calculated delay. Daily geofence quota is guaranteed even when delay is introduced.
\nValid for Canadian requests only. Not valid for US.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"520bbc2d-4583-47e0-b5e2-8f3942d9ee4c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d197a393-14a2-469b-bda5-5fda357372be"}}],"_postman_id":"a6b1cdbd-a7af-467c-ba2b-96f3a8da66f5"},{"name":"EA Geofences API","item":[{"name":"Get EA geofences","id":"2e8096a4-6ca2-4dda-9853-226a82cdd919","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.environicsanalytics.com/mobilescapes/v4/:country/geofences?$filter=string","description":"An endpoint to lookup EA geofence IDs from EA geofence library. Several attributes can be defined in order to filter the EA geofence library in order to return a subset of EA geofence IDs.
\nReturns a list of EA geofence IDs and names that satisfy the filter expression. If no entities satisfy the specified filter an empty list is returned.
\nPaging functionality is handled using Azure tables' built-in query pagination. A request that returns more than the 1,000 result limit returns a continuation token for performing pagination.
\n","urlObject":{"path":[":country","geofences"],"host":["https://api.environicsanalytics.com/mobilescapes/v4"],"query":[{"description":{"content":"Filter query option which conforms to the OData Protocol Specification. Returns only entities that satisfy the specified filter. If no entities satisfy the specified filter an empty list is returned.\nNote that no more than 15 discrete comparisons are permitted within a $filter string.
\n","type":"text/plain"},"key":"$filter","value":"string"},{"disabled":true,"key":"","value":""}],"variable":[{"description":{"content":"2-digit country code (e.g. \"ca\" for Canada).
\n","type":"text/plain"},"type":"any","value":"string (Required)","key":"country"}]}},"response":[{"id":"d27098a7-751e-40d5-a967-39620e896dea","name":"Get EA geofences","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_AUTH_TOKEN","type":"text"}],"url":{"raw":"https://api.environicsanalytics.com/mobilescapes/v3/:country/geofences?$filter=city%20eq%20'Toronto'%20and%20banner%20eq%20'Costco Wholesale","protocol":"https","host":["api","environicsanalytics","com"],"path":["mobilescapes","v3",":country","geofences"],"query":[{"key":"","value":"","disabled":true},{"key":"$filter","value":"city%20eq%20'Toronto'%20and%20banner%20eq%20'Costco Wholesale"}],"variable":[{"key":"country","value":"ca","description":"2-digit country code"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"value\": [\r\n {\r\n \"id\": 56884,\r\n \"name\": \"Costco Wholesale at RioCan Scarborough Centre (50 Thermos Rd)\"\r\n },\r\n {\r\n \"id\": 57772,\r\n \"name\": \"Costco Wholesale (50 Queen Elizabeth Blvd)\"\r\n },\r\n {\r\n \"id\": 57857,\r\n \"name\": \"Costco Wholesale (42 Overlea Blvd)\"\r\n },\r\n {\r\n \"id\": 58026,\r\n \"name\": \"Costco Wholesale (1411 Warden Ave)\"\r\n },\r\n {\r\n \"id\": 59435,\r\n \"name\": \"Costco Wholesale at SmartCentres Toronto (Downsview) (100 Billy Bishop Way)\"\r\n }\r\n ]\r\n}"}],"_postman_id":"2e8096a4-6ca2-4dda-9853-226a82cdd919"}],"id":"4e771551-84bd-424c-8207-fadc7aaa0af5","description":"Environics Analytics has undertaken a large-scale effort to build a continually expanding library of custom built, proprietary geofences for Canadian commercial, institutional and recreational locations. Geofences can be used for destination-based mobile movement extracts for faster analysis.
\nThis API supports $filter query options, which conform to the OData Protocol Specification. Within a $filter clause, you can use comparison operators to specify the criteria against which to filter the query results.
For all property types, the following comparison operators are supported:
\nAdditionally, the following operators are supported for Boolean properties:
\nFor more information about filter syntax, see the OData Protocol Specification.
\n","_postman_id":"4e771551-84bd-424c-8207-fadc7aaa0af5"}],"id":"7be9f0c6-cac6-4fc9-99e0-ce06c642c194","description":"In this version of the MobileScapes API we have updated our MobileScapes data and methodology. Our new MobileScapes data represents a substantial improvement from the previous version. For the first time anywhere, EA data scientists have successfully combined high-precision consent-based SDK data with geo-location data from phones on the cellular network, also consent-based. By combining the two sources we expand by over 20 times the number of observations underlying the estimation process, thus improving the accuracy of our foot traffic estimates through:
\nBetter coverage and representativity
\nLess volatility
\nEnhanced reflection of seasonal trends
\nThis version of MobileScapes includes data going back to January 2021 and due to the application of more stringent Privacy by Design restrictions, the Workers' and Residents' visit estimates have been removed.
\n","_postman_id":"7be9f0c6-cac6-4fc9-99e0-ce06c642c194"}],"event":[{"listen":"prerequest","script":{"id":"8ac8e3b8-d839-44a0-9783-e183365123e9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b093a71b-cc84-401a-8047-e48f8b7e5082","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.environicsanalytics.com/mobilescapes/v4"},{"key":"baseUrlv1","value":"https://api.environicsanalytics.com/mobilescapes/v1"},{"key":"baseUrlv2","value":"https://api.environicsanalytics.com/mobilescapes/v2","type":"string"},{"key":"baseUrlv3","value":"https://api.environicsanalytics.com/mobilescapes/v3","type":"string"},{"key":"baseUrlv4","value":"https://api.environicsanalytics.com/mobilescapes/v4","type":"string"}]}