---
title: "Trade Area Report"
method: POST
path: "/v1/reports/true-trade-area"
tags: ["Trade Area Reports"]
---

# Trade Area Report

`POST /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.<br/> <br/> &#x23F1; <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/>
&#128205; 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.

## Request body

- TrueTradeAreaRequest — 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` string, date, required — Queried data start date. Format YYYY-MM-DD
  - `endDate` string, date, required — Queried data end date. Format YYYY-MM-DD
  - `apiId` string, required — Placer API Entity Id
  - `reportType` 'trueTradeArea', required — Queried report type
  - `fileFormat` 'polygonGeoJson' — Result format
  - `trafficVolPct` integer — 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
  - `withinDistance` number, float — The max ‘home distance’ threshold for trade area calculation in miles; i.e. will exclude any visitor beyond this value.
  - `filter` VmFilterObject — Filtering options for the report results.
    - `audienceType` string[] — If provided - metrics will be calculated based only on the specified types of audience.
    - `dwellTime` object — Metrics will be calculated considering the requested dwell time range.
      - `operator` '<' | '>=' — Less than (<) to Greater Equal (>=)
      - `value` integer — The wanted dwell time
    - `hoursRange` object — Filter the report’s results based on visits hours range. The filter is defined by 2 strings:<br/> 1. The starting hour to filter the reports results from (Format HH:MM XM, for example: 08:00 am).<br/> 2. The end hour to filter the reports results(Format HH:MM XM, for example: 11:59 pm) .
      - `fromHour` string, required
      - `toHour` string, required
    - `daysOfWeek` unknown[] — Filter visit calculation based on days of the week. Results will contain only requested days. Days are represented by using numbers where Monday=1 and Sunday=7. For example: in order to retrieve weekend days use the following [ 6, 7 ].
      - unknown
    - `distance` object — Filter visits by distance in miles from home <strong>or</strong> work<br/> where only visits in a given radius will be used in metrics calculation.
      - `from` 'home' | 'work' — The origin from where the distance will be measured.
      - `values` object — Object representation of the distance range<br/>lt - less than<br/>le - less than or equal to<br/>eq - equal to<br/>ge - greater than or equal to<br/>gt - greater than.
        - `le` number
        - `ge` number
        - `lt` number
        - `gt` number
        - `eq` number
  - `nearbyRadius` 100 | 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.

## Response `200`

200 response

- PolygonResponse
  - `requestId` string, required — Request ID that can be used for tracing

## Other responses

- `202` — 202 Accepted
- `400` — 400 Bad Request
- `403` — 403 Permission Denied
- `500` — 500 Internal Server Error

---

[API](https://skmtc.net/placer/apis/papi.md) · [All operations](https://skmtc.net/placer/apis/papi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/placer/papi/versions/e317a0bbbd11/schema)