Schema
Schemas
Each dataset consists of the relevant metrics tied to the primary keys describing location and time. Those metrics are described in more detail here.
Location details are delivered as a file/table on the side or optionally embedded on any dataset. For bulk deliveries we recommend receiving this on the side, while for smaller extracts it can be handy to receive further locations details inline. See the different Location schemas here.
Foot-traffic
Foot-traffic describes the median estimated daily visitors to the location aggregated on a weekly or monthly basis.
Field name | Type | Description | Example |
---|---|---|---|
location_id | string | The geographical identification of a value in the data set. | ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8 |
observation_start_date | string (yyyy-mm-dd) | The start date for the period this observation took place. | 2023-02-05 |
observation_end_date | string (yyyy-mm-dd) | The end date for the period this observation took place. | 2023-02-11 |
person_count | int | Estimated sum of visitors to the location during the observation period. | 2,772 |
person_count_p50 | int | Estimated median of daily visitors to the location in the observation period. | 409 |
Trade Area
Trade Area describes the origin of visitors from their Home or Work location to the location on a quarterly basis.
Field name | Type | Description | Example |
---|---|---|---|
location_id | string | The geographical identification of a value in the data set. | ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8 |
trade_area_location_id | string | ID of US Census block groups | 320030027072 |
trade_area_type | string | Name of dimension describing if the trade area describes the HOME or WORK location | HOME |
observation_start_date | string (yyyy-mm-dd) | The start date for the period this observation took place. | 2023-01-01 |
observation_end_date | string (yyyy-mm-dd) | The end date for the period this observation took place. | 2023-03-31 |
people_fraction | float | Estimated fraction of location visitors with their home / work in the given CBG. | 0.28 |
Demographics
Field name | Type | Description | Example |
---|---|---|---|
location_id | string | The geographical identification of a value in the data set. | ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8 |
observation_start_date | string (yyyy-mm-dd) | The start date for the period this observation took place. | 2023-02-05 |
observation_end_date | string (yyyy-mm-dd) | The end date for the period this observation took place. | 2023-02-11 |
people_fraction_age_18_29 | float | Estimated fraction of visitors within this age group. | 0.182 |
people_fraction_age_30_39 | float | Estimated fraction of visitors within this age group. | 0.182 |
people_fraction_age_40_49 | float | Estimated fraction of visitors within this age group. | 0.182 |
people_fraction_age_50_59 | float | Estimated fraction of visitors within this age group. | 0.182 |
people_fraction_age_60_69 | float | Estimated fraction of visitors within this age group. | 0.182 |
people_fraction_age_70_79 | float | Estimated fraction of visitors within this age group. | 0.182 |
people_fraction_age_80_and_above | float | Estimated fraction of visitors within this age group. | 0.182 |
people_fraction_education_high_school | float | Estimated fraction of visitors with this education level. | 0.182 |
people_fraction_education_college_without_degree | float | Estimated fraction of visitors with this education level. | 0.182 |
people_fraction_education_associate | float | Estimated fraction of visitors with this education level. | 0.182 |
people_fraction_education_bachelor | float | Estimated fraction of visitors with this education level. | 0.182 |
people_fraction_education_master_and_above | float | Estimated fraction of visitors with this education level. | 0.182 |
people_fraction_gender_female | float | Estimated fraction of visitors with this gender. | 0.182 |
people_fraction_gender_male | float | Estimated fraction of visitors with this gender. | 0.182 |
people_fraction_income_25k_and_less | float | Estimated fraction of visitors within this income range. | 0.182 |
people_fraction_income_25k_50k | float | Estimated fraction of visitors within this income range. | 0.182 |
people_fraction_income_50k_75k | float | Estimated fraction of visitors within this income range. | 0.182 |
people_fraction_income_75k_100k | float | Estimated fraction of visitors within this income range. | 0.182 |
people_fraction_income_100k_125k | float | Estimated fraction of visitors within this income range. | 0.182 |
people_fraction_income_125k_and_above | float | Estimated fraction of visitors within this income range. | 0.182 |
people_fraction_race_amerindian | float | Estimated fraction of visitors with this race. | 0.182 |
people_fraction_race_asian | float | Estimated fraction of visitors with this race. | 0.182 |
people_fraction_race_black | float | Estimated fraction of visitors with this race. | 0.182 |
people_fraction_race_white | float | Estimated fraction of visitors with this race. | 0.182 |
people_fraction_race_other | float | Estimated fraction of visitors with this race. | 0.182 |
people_fraction_race_two_or_more | float | Estimated fraction of visitors with this race. | 0.182 |
Visitation Pattern
Visitation Pattern describes the time popularity of a location by weekday and hour on a quarterly basis.
Field name | Type | Description | Example |
---|---|---|---|
location_id | string | The geographical identification of a value in the data set. | ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8 |
day_of_week_id | string | Day of the week id (1 - 7 where 1 is the Sunday) | 3 |
day_of_week | string | Day of the week (Monday - Sunday) | Tuesday |
hour_id | string | Hour of the day id (0 - 23) | 0 |
hour | string | Name of our of day | 12AM |
observation_start_date | string (yyyy-mm-dd) | The start date for the period this observation took place. | 2023-01-01 |
observation_end_date | string (yyyy-mm-dd) | The end date for the period this observation took place. | 2023-03-31 |
people_fraction_venue | float | Fraction of location visitors for a specific hour and day of week | 0.164 |
people_fraction_area | float | Fraction of location visitors within 150m from the center of the venue for a specific hour and day of week | 0.264 |
Visit Length
Field name | Type | Description | Example |
---|---|---|---|
location_id | string | The geographical identification of a value in the data set. | ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8 |
observation_start_date | string (yyyy-mm-dd) | The start date for the period this observation took place. | 2023-02-05 |
observation_end_date | string (yyyy-mm-dd) | The end date for the period this observation took place. | 2023-02-11 |
visit_length_p50 | int | Estimated average length (median) of time spent visiting the venue per person in minutes. | 24 |
visit_length_p25 | int | 25th percentile of estimated time spent visiting the venue per person in minutes. | 14 |
visit_length_p75 | int | 75th percentile of estimated time spent visiting the venue per person in minutes. | 51 |
Locations Schemas
In addition to the schemas above describing the metrics, we provide optional schemas supporting contextual information of locations. This context is depending on weather the locations are POIs, CBGs, or custom boundaries.
POI locations
Field name | Type | Description | Example |
---|---|---|---|
location_id | STRING | The geographical identification of a value in the data set. | uc_87c5_1520-8a96797f598b5e70ea6dfc91cb0fac2d-d41d8cd98f00b204e9800998ecf8427e_810c |
brand_id | STRING | ID of brand | ucb_87c5_9d3a6cf7-1f0c-4a40-be4b-c7ed7421b659_22d5 |
brand | STRING | Name of brand | Dunkin' Donuts |
naics_id | STRING | ID of North American Industrial Classification System | 722513 |
naics | STRING | Name of North American Industrial Classification System | Limited-Service Restaurants |
us_state_id | STRING | US State FIPS Code (2 digits) | 02 |
us_state | STRING | Name of US State | Alaska |
us_county_id | STRING | US County FIPS code (5 digits) | 02013 |
us_county | STRING | Name of US County | Aleutians East Borough, AK |
us_census_tract_id | STRING | US Census Tract FIPS code (11 digits) | 02013000100 |
us_census_block_group_id | STRING | ID of US Census Block Group FIPS code | 020130001001 |
us_metro_area_id | STRING | US Core-Based Statistical Area code (5 digits) | |
us_metro_area | STRING | Name of US Core-Based Statistical Area | |
street_address | STRING | US Street Addresses | 1800 Umiak Dr |
zip | STRING | ||
h3 | STRING | ID for Hexagonal hierarchical geospatial indexing system | 8a0cda932b0ffff |
city | STRING | False Pass | |
is_obfuscated | STRING | False | |
last_change_date | DATE | Last time the location was updated | "2022-01-01" |
opened_on | DATE | Opening date | "2018-10-01" |
closed_on | DATE | Closing date | "2021-12-31 |
CBG locations
Field name | Type | Description | Example |
---|---|---|---|
census_block_group_id | string | The geographical identification of a value in the data set. | 021580001002 |
area | int | 12,721,633,137 | |
us_state_id | string | US State FIPS Code (2 digits) | 02 |
us_state | string | Name of US State | Alaska |
us_county_id | string | US County FIPS code (5 digits) | 02158 |
us_county | string | Name of US County | Kusilvak Census Area, AK |
us_tract_id | string | US Census Tract FIPS code (11 digits) | 02158000100 |
us_tract | string | Name of US Census Tract | 02158000100 |
us_cbsa_id | string | US Core-Based Statistical Area code (5 digits) | |
us_cbsa | string | Name of US Core-Based Statistical Area | |
us_census_block_group_id | string | ID of US Census Block Group FIPS code. | 021580001002 |
us_census_block_group | string | Name of US Census Block Group FIPS code. | 021580001002 |
Custom Boundaries context
Since custom boundaries are provided by the user, we do not have additional context to provide for custom boundaries.