Location Info
Basic abstract model for location info. Can by either Chain, Venue, Complex, Billboard or ZipCode.
Placer distinguishes between 5 types of Locations:
| Type | Description | Example | Structure |
|---|---|---|---|
| chain | A group of entities (Venues/Complexes/Billboards), usually with a business and geographic context. | "Starbucks" is a chain that includes all of Starbucks venues in the USA "Starbuck Los Angeles" is another chain with a more specific geographic area. | Chain Info |
| venue | A singe business location, usually part of Chain. | "Starbucks at 405 Broadway, New York, NY 10013, USA" is a Venue that is part of the Starbucks Chain | Venue Info |
| complex | Similar to Venue, but much larger in Physical size. Complexes usually have other Venues physically located inside of them, even though they are not part of the Complex's chain. Malls, casinos, universities, stadiums and airports will always be Complexes and not Venues. | "Westfield Valley Fair" is a Complex that is part of the "Westfield" chain of malls. Other examples: 'Disneyland' (Theme park), 'Caesars Palace' (Casino), 'JFK' (Airport) | Complex Info |
| billboard | A large outdoor board for displaying advertisements. | Billboard Info | |
| zipcode (future) | An official USA Zip-Code | 90210 | Zipcode Info |
Each Location entity will always have the following attributes:
| Field | Description | Type |
|---|---|---|
| id | Entity Id | string |
| type | Can be either 'venue', 'chain', 'complex', 'zipcode' or 'billboard'. | string |
| category | Changes based on the entity. | string |
| default_filters | Array of all the default filters that the requested venue is pre-built with | JSON array of string |
| data_type_source | Determine the type of sources used to generate this report. | JSON array of ##Foott Taffic Source Structure |
| alias | An alias name for the location - an account specific field, contains an alternate/non-placer name for the location. Empty by default | string |
Location Info extensions and examples:
Foott Taffic Source Structure
| Field | description | type |
|---|---|---|
| type | The visits source type, current supported types: visits impressions | string |
| valid_from | The date from which onward visits data were collected by this source. Empty when all historical data is available for the POI | string |
| region | The location's region | Region Structure |
Updated 5 months ago