---
title: "Trade Area by Drive Time Report"
method: POST
path: "/v1/reports/trade-area/drive-time"
tags: ["Trade Area Reports"]
---

# Trade Area by Drive Time Report

`POST /v1/reports/trade-area/drive-time`

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

- TradeAreaByDriveTimeRequest — This service enables to pull the trade area polygon calculated based on a specified drive time.
  - `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
  - `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
  - `driveTime` integer — The max drive time duration threshold for trade area calculation in minutes; 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

- TradeAreaByDriveTimeResponse
  - `requestId` string, required — Request ID that can be used for tracing
  - `data` object
    - `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
    - `filters` ResponseFilters
      - `audienceType` string[] — The list of audiences that is specified in the request filter.
      - `dwellTime` object — The dwell time filter specified in the request, in case it was utilized.<br/> For example: “< 100” or “>= 10”
        - `operator` '<' | '>=' — Represents the operator used for defining the dwell time range for filtering the report data
        - `value` integer — Represents the number of minutes referred to when defining the dwell time range for filtering the report data
      - `hoursRange` object — The hours range that is specified in the request filter.
        - `fromHour` string — Start visits hour (Format HH:MM XM, for example: 08:00 am)
        - `toHour` string — End visitation hour (Format HH:MM XM, for example: 08:00 am)
      - `daysOfWeek` unknown[] — A list of days represented by integers (Monday=1, Sunday=7) as specified in the request filter, which was used in the report calculation.
        - unknown
      - `distance` object — The visits considered for the report calculation by distance in miles from home <strong>or</strong> work as specified in the request filter.
        - `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
    - `visitDurationSegmentation` 'under10Min' | '10MinOrLonger' | 'allVisits' | 'mixedSegments', nullable — The default visit duration segmentation is returned when the report calculation uses the default segmentation duration.
    - `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
    - `driveTime` integer — The max drive time duration threshold for trade area calculation in minutes; i.e. will exclude any visitor beyond this value.
    - `type` 'MultiPolygon' — The Polygon Data Structure (https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7)
    - `coordinates` array[] — Coordinate Object (Latitude, Longitude)
      - array[]
        - union[]
          - union
            - number, float — Longitude of query location
            - number, float — Latitude of query location
    - `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.

## 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/revisions/e317a0bbbd11/schema)