Trade Area Report

post

https://papi.placer.ai/v1/reports/true-trade-area

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.

⏱ Average measured processing time: 2.24 seconds
For more information on request retries best practices and processing measurements you may visit this page

📍 This service supports the Nearby Activity report. Once setting a value to the nearbyRadius parameter, the report will be generated based on the nearby activity logic.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

True trade areas are calculated by 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.

startDate

date

required

Queried data start date. Format YYYY-MM-DD

endDate

date

required

Queried data end date. Format YYYY-MM-DD

apiId

string

required

Placer API Entity Id

reportType

string

enum

required

Defaults to trueTradeArea

Queried report type

Allowed:

fileFormat

string

enum

Defaults to polygonGeoJson

Result format

Allowed:

trafficVolPct

integer

30 to 100

Defaults to 70

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

string

enum

Defaults to weightedCentroid

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

Allowed:

withinDistance

float

1 to 100

Defaults to 50

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

filter

object

Filtering options for the report results.

nearbyRadius

integer

enum

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

Allowed:

Responses

200200 response

202202 Accepted

400400 Bad Request

403403 Permission Denied

500500 Internal Server Error