Footfall properties are location sets where visits are counted as conversions.

Creating A Footfall Property

To create a Footfall Property in the Mira Console,

• Navigate to the Conversion Property List Page
• Click the + Create Property button and select Footfall.
• Provide a name and an optional description, to help you identify this Property.
• Optional: Select an advertiser this Property is associated with.
• Upload a Footfall Source file

Specifying Footfall Source Information

Users communicate a set of footfall locations by uploading a footfall file, or selecting a previous Geocoding Job. There are 3 file types that each have their own strict schema requirements (detailed below)

New Files

To onboard a new Footfall Source file:

• Click the Upload files link
• Select one or more files to include. Files must have a .csv, .geojson, or .line.geojson extension.
• For each file, associate it with the appropriate type
• For address and lat/lon files, choose a radius to draw around the location in meters
• Choose whether to mark any created Geocoding Jobs as complete if they succeed

Address Files

When an address file is uploaded, a new Geocoding Job is created for that file. Note that it is possible for Geocoding Jobs to fail partially (i.e. if some rows do not find a match). For additional information, please consult the Geocoding Job document

• Required format: .csv, at least 1 column
• Fields:
  • address - required - this is a string that is passed to Google's Geocoding API in order to find lat/lons of addresses or POIs
  • additional columns are treated as metadata and can be used in cuts
    • e.g. store_id or region

Coordinates

Also known as lat/lon files, these specify a point on the map

• Required format: .csv, at least 2 columns
• Fields:
  • latitude - required - decimal representation of latitude coordinate, e.g. 40.712776
  • longitude- required - decimal representation of longitude coordinate, e.g. -74.005974
  • additional columns are treated as metadata and can be used in cuts
    • e.g. store_id or region

GeoJSON

GeoJSON files, both normal and line-delimited (.line.geojson) are useful for specifying precise polygon shapes in the case a radial geofence is not sufficient.

• Required format: .geojson or .line.geojson
  • .geojson is treated as a standard GeoJSON file
  • .line.geojson is treated as a line-delimited GeoJSON
• Fields
  • geometry - required by geojson spec
  • properties - optional dictionary to specify metdata about each GeoJSON Feature
    • Each key-value pair in here will be treated as an additional metadata column, e.g. {"properties": {"store_id": 123}}

Reusing Previous Geocoding Jobs

In lieu of onboarding a new file, if you have already uploaded a set of addresses that has been geocoded, you can simply select that Geocoding Job from the dropdown.

Managing Footfall Properties

Footfall Properties are Resources and can have their names and descriptions edited like other resources.

Footfall Data Lifecycle

When a file is uploaded to a Footfall Property, a Footfall Source Job is created in our system. This represents a pending unit of work that our system needs to pop off the queue and process. You can see the Footfall Source Jobs associated with a particular Property on the view page.

Currently, our system polls for new work every fifteen minutes, on the :00, :15, :30, and :45 minutes. Once a file is picked up by the system, the EMR Cluster Id field will be populated.

Recall Footfall data can be uploaded as files, or by pointing to a Geocoding Job . In this later case, the system will not begin work on the Footfall Source Job until the Geocoding Job has been marked complete.

Footfall Jobs

A Footfall Source Job solely represents source data (e.g. a latitude/longitude file or a GeoJSON) being ingested and stored in our common format. In order to be useful, however, these locations must be joined to our mobile location dataset. This process is represented by Footfall Jobs

When a Footfall Property is associated with a Campaign that has a measurement Study, the system will automatically compute the data needed to track conversions for that Study based on the Campaign or Study dates. For example, if Study A has a date range of May 1 to May 31, and Study B has a date range of May 15 to June 31, our system will compute all the Footfall data necessary to fulfill these obligations (May 1 - June 31)

Adding Additional Locations

After a Footfall Property is created, additional locations can be added to the whitelist by visiting the Property View Page. To add additional locations,

• Navigate to the specific Conversion Property's page.
• Scroll to the whitelist section, and click the + Add Footfall Source Jobs button.
• Additional locations to be tracked can be added by uploading new Footfall Files or selecting a previous Geocoding Job. The requirements are the same as during creation.
• Click the Add Footfall Source Jobs button to add the new locations.

If locations are added to a Footfall Property that is associated with a Campaign, the new Footfall data will automatically be computed.

🚧

Footfall Files Cannot Be Removed

Currently, Footfall Files (and therefore Footfall Source Jobs) cannot be removed from a given Footfall Property