Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Trade Area Reports

Trade Area by Drive Time Report

This service lets you retrieve the trade area polygon calculated for a specified drive time.<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/trade-area/drive-time

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

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

driveTimeinteger

The max drive time duration threshold for trade area calculation in minutes; 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",
  "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",
  "data": {
    "startDate": "2020-12-01",
    "endDate": "2021-05-31",
    "apiId": "venue:7d55054520e387813d764b03",
    "filters": {
      "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
        }
      }
    },
    "visitDurationSegmentation": "10MinOrLonger",
    "allocationType": "weightedCentroid",
    "type": "MultiPolygon",
    "coordinates": [
      [
        [
          -121.98
        ]
      ]
    ]
  }
}