Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Trade Area Reports

Trade Area Report

True Trade Areas are calculated by the volume of traffic reaching the venue or complex . For example, setting 'traffic vol' to 70% draws a polygon that represents 70% of the visitors’ home location.<br/> <br/> ⏱ <strong>Average measured processing time: 2.24 seconds </strong><br/> For more information on request retries best practices and processing measurements you may visit <a href="https://docs.placer.ai/reference/measurements"> this</a> page<br/><br/> 📍 This service supports the <<glossary:Nearby Activity report>>. Once setting a value to the nearbyRadius parameter, the report will be generated based on the nearby activity logic.

post/v1/reports/true-trade-area

Request body

startDatestring date required

Queried data start date. Format YYYY-MM-DD

endDatestring date required

Queried data end date. Format YYYY-MM-DD

apiIdstring required

Placer API Entity Id

reportType'trueTradeArea' required

Queried report type

fileFormat'polygonGeoJson'

Result format

trafficVolPctinteger

The threshold for the volume of traffic coming to the property. For example - setting a 'traffic vol' of 70% will draw a polygon that includes at least 70% of the visitors’ home location

allocationType'weightedCentroid' | 'centroid'

The method for including the block group in the TA <br/> Weighted centroid - the centroid is adjusted per the block’s group population. if it falls within the polygon the BG is included <br/> Centroid - A block group’s data is included when the center of the block group falls within the trade area boundaries

withinDistancenumber float

The max ‘home distance’ threshold for trade area calculation in miles; i.e. will exclude any visitor beyond this value.

nearbyRadius100 | 250 | 500 | 750 | 1000

The radius requested for nearby activity report generation.</br> <strong>Note</strong>: When a value is populated for this attribute - the report will be calculated as per the <<glossary:Nearby Activity report>> logic.

Example request

{
  "startDate": "2020-12-01",
  "endDate": "2021-05-31",
  "apiId": "venue:7d55054520e387813d764b03",
  "reportType": "trueTradeArea",
  "fileFormat": "polygonGeoJson",
  "allocationType": "weightedCentroid",
  "filter": {
    "audienceType": [
      "visitors"
    ],
    "dwellTime": {
      "operator": "<",
      "value": 150
    },
    "hoursRange": {
      "fromHour": "03:00 am",
      "toHour": "11:59 pm"
    },
    "daysOfWeek": [
      6,
      7
    ],
    "distance": {
      "from": "home",
      "values": {
        "lt": 250,
        "gt": 10
      }
    }
  }
}

Response

200 response

requestIdstring required

Request ID that can be used for tracing

Example response

{
  "requestId": "cfe57f50-fb64-11eb-8760-acde48001122:cfe56fce-fb64-11eb-8760-acde48001122"
}