Skip to main content

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 nameTypeDescriptionExample
location_idstringThe geographical identification of a value in the data set.ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8
observation_start_datestring (yyyy-mm-dd)The start date for the period this observation took place.2023-02-05
observation_end_datestring (yyyy-mm-dd)The end date for the period this observation took place.2023-02-11
person_countintEstimated sum of visitors to the location during the observation period.2,772
person_count_p50intEstimated 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 nameTypeDescriptionExample
location_idstringThe geographical identification of a value in the data set.ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8
trade_area_location_idstringID of US Census block groups320030027072
trade_area_typestringName of dimension describing if the trade area describes the HOME or WORK locationHOME
observation_start_datestring (yyyy-mm-dd)The start date for the period this observation took place.2023-01-01
observation_end_datestring (yyyy-mm-dd)The end date for the period this observation took place.2023-03-31
people_fractionfloatEstimated fraction of location visitors with their home / work in the given CBG.0.28

Demographics

Field nameTypeDescriptionExample
location_idstringThe geographical identification of a value in the data set.ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8
observation_start_datestring (yyyy-mm-dd)The start date for the period this observation took place.2023-02-05
observation_end_datestring (yyyy-mm-dd)The end date for the period this observation took place.2023-02-11
people_fraction_age_18_29floatEstimated fraction of visitors within this age group.0.182
people_fraction_age_30_39floatEstimated fraction of visitors within this age group.0.182
people_fraction_age_40_49floatEstimated fraction of visitors within this age group.0.182
people_fraction_age_50_59floatEstimated fraction of visitors within this age group.0.182
people_fraction_age_60_69floatEstimated fraction of visitors within this age group.0.182
people_fraction_age_70_79floatEstimated fraction of visitors within this age group.0.182
people_fraction_age_80_and_abovefloatEstimated fraction of visitors within this age group.0.182
people_fraction_education_high_schoolfloatEstimated fraction of visitors with this education level.0.182
people_fraction_education_college_without_degreefloatEstimated fraction of visitors with this education level.0.182
people_fraction_education_associatefloatEstimated fraction of visitors with this education level.0.182
people_fraction_education_bachelorfloatEstimated fraction of visitors with this education level.0.182
people_fraction_education_master_and_abovefloatEstimated fraction of visitors with this education level.0.182
people_fraction_gender_femalefloatEstimated fraction of visitors with this gender.0.182
people_fraction_gender_malefloatEstimated fraction of visitors with this gender.0.182
people_fraction_income_25k_and_lessfloatEstimated fraction of visitors within this income range.0.182
people_fraction_income_25k_50kfloatEstimated fraction of visitors within this income range.0.182
people_fraction_income_50k_75kfloatEstimated fraction of visitors within this income range.0.182
people_fraction_income_75k_100kfloatEstimated fraction of visitors within this income range.0.182
people_fraction_income_100k_125kfloatEstimated fraction of visitors within this income range.0.182
people_fraction_income_125k_and_abovefloatEstimated fraction of visitors within this income range.0.182
people_fraction_race_amerindianfloatEstimated fraction of visitors with this race.0.182
people_fraction_race_asianfloatEstimated fraction of visitors with this race.0.182
people_fraction_race_blackfloatEstimated fraction of visitors with this race.0.182
people_fraction_race_whitefloatEstimated fraction of visitors with this race.0.182
people_fraction_race_otherfloatEstimated fraction of visitors with this race.0.182
people_fraction_race_two_or_morefloatEstimated 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 nameTypeDescriptionExample
location_idstringThe geographical identification of a value in the data set.ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8
day_of_week_idstringDay of the week id (1 - 7 where 1 is the Sunday)3
day_of_weekstringDay of the week (Monday - Sunday)Tuesday
hour_idstringHour of the day id (0 - 23)0
hourstringName of our of day12AM
observation_start_datestring (yyyy-mm-dd)The start date for the period this observation took place.2023-01-01
observation_end_datestring (yyyy-mm-dd)The end date for the period this observation took place.2023-03-31
people_fraction_venuefloatFraction of location visitors for a specific hour and day of week0.164
people_fraction_areafloatFraction of location visitors within 150m from the center of the venue for a specific hour and day of week0.264

Visit Length

Field nameTypeDescriptionExample
location_idstringThe geographical identification of a value in the data set.ed5ca2fd-69d9-4e6a-ae59-abeb39b13fb8
observation_start_datestring (yyyy-mm-dd)The start date for the period this observation took place.2023-02-05
observation_end_datestring (yyyy-mm-dd)The end date for the period this observation took place.2023-02-11
visit_length_p50intEstimated average length (median) of time spent visiting the venue per person in minutes.24
visit_length_p25int25th percentile of estimated time spent visiting the venue per person in minutes.14
visit_length_p75int75th 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 nameTypeDescriptionExample
location_idSTRINGThe geographical identification of a value in the data set.uc_87c5_1520-8a96797f598b5e70ea6dfc91cb0fac2d-d41d8cd98f00b204e9800998ecf8427e_810c
brand_idSTRINGID of branducb_87c5_9d3a6cf7-1f0c-4a40-be4b-c7ed7421b659_22d5
brandSTRINGName of brandDunkin' Donuts
naics_idSTRINGID of North American Industrial Classification System722513
naicsSTRINGName of North American Industrial Classification SystemLimited-Service Restaurants
us_state_idSTRINGUS State FIPS Code (2 digits)02
us_stateSTRINGName of US StateAlaska
us_county_idSTRINGUS County FIPS code (5 digits)02013
us_countySTRINGName of US CountyAleutians East Borough, AK
us_census_tract_idSTRINGUS Census Tract FIPS code (11 digits)02013000100
us_census_block_group_idSTRINGID of US Census Block Group FIPS code020130001001
us_metro_area_idSTRINGUS Core-Based Statistical Area code (5 digits)
us_metro_areaSTRINGName of US Core-Based Statistical Area
street_addressSTRINGUS Street Addresses1800 Umiak Dr
zipSTRING
h3STRINGID for Hexagonal hierarchical geospatial indexing system8a0cda932b0ffff
citySTRINGFalse Pass
is_obfuscatedSTRINGFalse
last_change_dateDATELast time the location was updated"2022-01-01"
opened_onDATEOpening date"2018-10-01"
closed_onDATEClosing date"2021-12-31

CBG locations

Field nameTypeDescriptionExample
census_block_group_idstringThe geographical identification of a value in the data set.021580001002
areaint12,721,633,137
us_state_idstringUS State FIPS Code (2 digits)02
us_statestringName of US StateAlaska
us_county_idstringUS County FIPS code (5 digits)02158
us_countystringName of US CountyKusilvak Census Area, AK
us_tract_idstringUS Census Tract FIPS code (11 digits)02158000100
us_tractstringName of US Census Tract02158000100
us_cbsa_idstringUS Core-Based Statistical Area code (5 digits)
us_cbsastringName of US Core-Based Statistical Area
us_census_block_group_idstringID of US Census Block Group FIPS code.021580001002
us_census_block_groupstringName 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.