Get a Saved Location
Get an existing Saved Location.
Request
HTTP Request
Path Parameters
location_id
An existing Saved Location ID.
Response
Response Fields
location_id
string
The autogenerated identifier for the saved location.
E.g. 8gZ2rn8BRcTjM_3SWdjP
location_code
string
The user-supplied identifier for the location.
E.g. 4t855453234t5623
name
string
The user defined name of the Saved Location set in the create location call.
E.g. My Parking Building
labels
array
A list of user defined labels for the location.
E.g.: ["test", "retail"]
create_dt
string
E.g. 2022-04-26T11:46:24+00:00
update_dt
string
E.g. 2022-04-26T11:46:24+00:00
enrich_dt
string
E.g. 2022-04-26T11:46:25+00:00
insights_dt
string
E.g. 2022-04-26T11:46:25+00:00
user_id
string
The ID of the user who created the saved location. This is present for location created in the WebApp. For locations created via the API this field will not be populated.
E.g. hjqkKozgS8mm
geojson
object
This will be present for locations that use a centerpoint and radius. For locations that cover an area (for example city, state or country) they will not have the geojson value defined instead they use place_ids.
Point type locations are defined by latitude and longitude. The radius field defines which events are included in the location. Events that are within the radius or that overlap the radius are included Geometry - Possible types:
PointPolygon- this is reserved for future use
place_ids
array
E.g. [2750405]
formatted_address
string
The address of the location. This can be supplied when created a location. If it's not supplied it will be populated by a reverse geocode.
E.g.
places
string
summary_insights
array
The date range field includes the start and end datetime for the period that the stats have been calculated for.
subscription_valid_types
array
The value is a list of different (subscription) types that this location is valid for. The possible values are events, broadcasts, notifications, features_api.
It is possible to create locations outside of what your subscription has access to. In this case this field will be empty and you will not be able to view events for the location
E.g. ["events"]
status
string
Reflects if a location has been updated by the enrichment process. When a location is initially created its status will be pending.
After the enrichment process has updated the location populating summary_insights and other fields the status will be active.
Typically locations only have the pending status for a short time.
E.g. active
Examples
Guides
Below are some guides relevant to this API:
Last updated
Was this helpful?