Overview

A Place Result contains data from any one dataset for a single POI for a single time period (time period is applicable to Patterns datasets)

  • A Place Result from Core Places contains 1 or more fields from the Places object type.
  • A Place Result from Geometry 1 or more fields from the Geometry object type.
  • A Place Result from Weekly Patterns 1 or more fields from the WeeklyPatterns object type.
    • Each week of foot traffic attributes requested in that time period counts as a Place Result (e.g. a request for 4 weeks of weekly patterns for a POI would return 4 Place Results).
  • A Place Result from Monthly Patterns i1 or more fields from the MonthlyPatterns object type.
    • Each month of foot traffic attributes requested in that time period counts as a Place Result(e.g. a request for 6 months of monthly patterns for a POI would be 6 Place Results).

Using Place Results

A requested Place Result is required to query the API. You may choose any fields from the Response Datasets to request in your query.

Lookup Queries

Single Lookup and Batch Lookup queries can directly request Place Results, as shown below. The requested information is returned for each POI that is looked up.

query {
  lookup(placekey: "[email protected]") {
    safegraph_core {
      location_name
      street_address
    }
    safegraph_geometry  {
      polygon_class
    }  
  }
}

Search Queries

Search queries can respond with n places. In this case, data is returned as an array of information, or edges. Each POI I is a node within edges, and the requested Place Result data is returned for each node.

You can compare the example below to the previous Lookup example to understand how information is requested for Search queries.

query {
  search (
    filter: {
      brand: "Dunkin'"
    }
  ) {
    places {
      results {
        edges {
          node {
            safegraph_core {
                     location_name
                     street_address
                  }
            safegraph_geometry  {
              polygon_class
            }  
          }
        }
      }
    }
  }
}