---
title: "Visit Trends Report"
method: POST
path: "/v1/reports/visit-trends"
tags: ["Visits Reports"]
---

# Visit Trends Report

`POST /v1/reports/visit-trends`

Retrieves visitations for a given list of entities in daily, weekly or monthly granularity.<br/><br/> <strong>&#x21e1; This service supports bulk request</strong><br/><br/> <strong> &#10045; This service supports chain level requests</strong><br/><br/> &#x23F1; <strong>Average measured processing time: 3.58 seconds </strong><br><br> <strong>&#128205; This service doesn't support custom POI. To pull visits trend for custom POI please use <a href="https://docs.placer.ai/reference/post_v1-reports-visit-trends-single">Visit Trends Report for a Single Property </a> endpoint. </strong><br/><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

## Request body

- VisitTrendsRequest — Calculating ft trends for given dates
  - `startDate` string, date, required — Queried data start date. Format YYYY-MM-DD
  - `endDate` string, date, required — Queried data end date. Format YYYY-MM-DD
  - `apiIds` ApiId[], required
  - `granularity` 'day' | 'week' | 'month', required
  - `filters` BaseVmFilterObject — Filtering options for the report results.
    - `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
  - `visitDurationSegmentation` 'under10Min' | '10MinOrLonger' | 'allVisits' | 'default', nullable — This parameter allows for the generation of reports based on either short visits (< 10 minutes), long visits (>= 10 minutes), or all visit data. <br/> By setting the parameter with a “default” value the report may be limited to certain visit durations (length of stay in minutes), to best reflect the typical behavior of visitors.<br> <strong>Available values:</strong><br> ‘under10Min’ - Only visits with a duration of less than 10 minutes are included in the report.<br> ‘10MinOrLonger’ - only visits with a duration of 10 minutes or more are included in the report.<br> ‘allVisits’ - all the visits are included in the report.<br> ‘default’ - The default segment (as explained above)

## Response `200`

200 response

- VisitTrendsResponse
  - `requestId` string, required — Request ID that can be used for tracing
  - `items` VisitTrendsSuccess[]
    - `apiId` string — Placer API Entity Id
    - `data` object
      - `dates` string[] — Date bins for the corresponding data points
      - `granularity` 'day' | 'week' | 'month' — Aggregation Period
      - `visits` integer[] — Extrapolated Visits per datetime bin
      - `panelVisits` integer[] — The number of visits observed by Placer and are used for statistical extrapolation (per datetime bin) <strong>NOTE:</strong> When using the <strong>distance</strong> filter, panelVisits attribute will not be impacted by the filter and will keep presenting the full panel for the time frame.
      - `visitDurationSegmentation` 'under10Min' | '10MinOrLonger' | 'allVisits' | 'mixedSegments', nullable — If the default visit duration segmentation is requested, the visitDurationSegmentation will display the actual segment.<r>. In cases where the default segment was requested for a chain, in which the list of entities used different default segments for the report calculation, the visitDurationSegmentation will be set to ‘mixedSegments’.

## Other responses

- `202` — 202 Accepted
- `207` — 207 MultiStatus
- `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)